Class CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder (2.48.0)

public static final class CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder extends GeneratedMessageV3.Builder<CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder> implements CatalogAttribute.FacetConfig.IgnoredFacetValuesOrBuilder

Facet values to ignore on facets during the specified time range for the given SearchResponse.Facet.key attribute.

Protobuf type google.cloud.retail.v2.CatalogAttribute.FacetConfig.IgnoredFacetValues

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllValues(Iterable<String> values)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder addAllValues(Iterable<String> values)

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Parameter
Name Description
values Iterable<String>

The values to add.

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

addValues(String value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder addValues(String value)

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Parameter
Name Description
value String

The values to add.

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

This builder for chaining.

addValuesBytes(ByteString value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder addValuesBytes(ByteString value)

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Parameter
Name Description
value ByteString

The bytes of the values to add.

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

This builder for chaining.

build()

public CatalogAttribute.FacetConfig.IgnoredFacetValues build()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues

buildPartial()

public CatalogAttribute.FacetConfig.IgnoredFacetValues buildPartial()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues

clear()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clear()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

clearEndTime()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clearEndTime()

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

clearField(Descriptors.FieldDescriptor field)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

clearStartTime()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clearStartTime()

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

clearValues()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clearValues()

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

This builder for chaining.

clone()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder clone()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

getDefaultInstanceForType()

public CatalogAttribute.FacetConfig.IgnoredFacetValues getDefaultInstanceForType()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues

getDescriptorForType()

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

getEndTime()

public Timestamp getEndTime()

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
Timestamp

The endTime.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
Builder

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
TimestampOrBuilder

getStartTime()

public Timestamp getStartTime()

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Returns
Type Description
Timestamp

The startTime.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Returns
Type Description
Builder

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Returns
Type Description
TimestampOrBuilder

getValues(int index)

public String getValues(int index)

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The values at the given index.

getValuesBytes(int index)

public ByteString getValuesBytes(int index)

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the values at the given index.

getValuesCount()

public int getValuesCount()

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Returns
Type Description
int

The count of values.

getValuesList()

public ProtocolStringList getValuesList()

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Returns
Type Description
ProtocolStringList

A list containing the values.

hasEndTime()

public boolean hasEndTime()

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Returns
Type Description
boolean

Whether the startTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder mergeEndTime(Timestamp value)

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

mergeFrom(CatalogAttribute.FacetConfig.IgnoredFacetValues other)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder mergeFrom(CatalogAttribute.FacetConfig.IgnoredFacetValues other)
Parameter
Name Description
other CatalogAttribute.FacetConfig.IgnoredFacetValues
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

mergeStartTime(Timestamp value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder mergeStartTime(Timestamp value)

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

setEndTime(Timestamp value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setEndTime(Timestamp value)

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

setEndTime(Timestamp.Builder builderForValue)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setEndTime(Timestamp.Builder builderForValue)

If start time is empty and end time is not empty, then ignore these facet values before end time.

.google.protobuf.Timestamp end_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

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

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

setStartTime(Timestamp value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setStartTime(Timestamp value)

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

setStartTime(Timestamp.Builder builderForValue)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setStartTime(Timestamp.Builder builderForValue)

Time range for the current list of facet values to ignore. If multiple time ranges are specified for an facet value for the current attribute, consider all of them. If both are empty, ignore always. If start time and end time are set, then start time must be before end time. If start time is not empty and end time is empty, then will ignore these facet values after the start time.

.google.protobuf.Timestamp start_time = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

setValues(int index, String value)

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder setValues(int index, String value)

List of facet values to ignore for the following time range. The facet values are the same as the attribute values. There is a limit of 10 values per instance of IgnoredFacetValues. Each value can have at most 128 characters.

repeated string values = 1;

Parameters
Name Description
index int

The index to set the value at.

value String

The values to set.

Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

This builder for chaining.