Class CatalogAttribute.FacetConfig.IgnoredFacetValues (2.55.0)

public static final class CatalogAttribute.FacetConfig.IgnoredFacetValues extends GeneratedMessageV3 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.v2beta.CatalogAttribute.FacetConfig.IgnoredFacetValues

Inheritance

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

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CatalogAttribute.FacetConfig.IgnoredFacetValues getDefaultInstance()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues

getDescriptor()

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

newBuilder()

public static CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder newBuilder()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

newBuilder(CatalogAttribute.FacetConfig.IgnoredFacetValues prototype)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder newBuilder(CatalogAttribute.FacetConfig.IgnoredFacetValues prototype)
Parameter
Name Description
prototype CatalogAttribute.FacetConfig.IgnoredFacetValues
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

parseDelimitedFrom(InputStream input)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CatalogAttribute.FacetConfig.IgnoredFacetValues parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CatalogAttribute.FacetConfig.IgnoredFacetValues> parser()
Returns
Type Description
Parser<IgnoredFacetValues>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

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.

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

getParserForType()

public Parser<CatalogAttribute.FacetConfig.IgnoredFacetValues> getParserForType()
Returns
Type Description
Parser<IgnoredFacetValues>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder newBuilderForType()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder toBuilder()
Returns
Type Description
CatalogAttribute.FacetConfig.IgnoredFacetValues.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException