Class SearchRequest.DisplaySpec (0.58.0)

public static final class SearchRequest.DisplaySpec extends GeneratedMessageV3 implements SearchRequest.DisplaySpecOrBuilder

Specifies features for display, like match highlighting.

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec

Static Fields

MATCH_HIGHLIGHTING_CONDITION_FIELD_NUMBER

public static final int MATCH_HIGHLIGHTING_CONDITION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.DisplaySpec getDefaultInstance()
Returns
Type Description
SearchRequest.DisplaySpec

getDescriptor()

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

newBuilder()

public static SearchRequest.DisplaySpec.Builder newBuilder()
Returns
Type Description
SearchRequest.DisplaySpec.Builder

newBuilder(SearchRequest.DisplaySpec prototype)

public static SearchRequest.DisplaySpec.Builder newBuilder(SearchRequest.DisplaySpec prototype)
Parameter
Name Description
prototype SearchRequest.DisplaySpec
Returns
Type Description
SearchRequest.DisplaySpec.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest.DisplaySpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.DisplaySpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest.DisplaySpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchRequest.DisplaySpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.DisplaySpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest.DisplaySpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.DisplaySpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest.DisplaySpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.DisplaySpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest.DisplaySpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest.DisplaySpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest.DisplaySpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest.DisplaySpec> parser()
Returns
Type Description
Parser<DisplaySpec>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchRequest.DisplaySpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.DisplaySpec

getMatchHighlightingCondition()

public SearchRequest.DisplaySpec.MatchHighlightingCondition getMatchHighlightingCondition()

The condition under which match highlighting should occur.

.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition match_highlighting_condition = 1;

Returns
Type Description
SearchRequest.DisplaySpec.MatchHighlightingCondition

The matchHighlightingCondition.

getMatchHighlightingConditionValue()

public int getMatchHighlightingConditionValue()

The condition under which match highlighting should occur.

.google.cloud.discoveryengine.v1.SearchRequest.DisplaySpec.MatchHighlightingCondition match_highlighting_condition = 1;

Returns
Type Description
int

The enum numeric value on the wire for matchHighlightingCondition.

getParserForType()

public Parser<SearchRequest.DisplaySpec> getParserForType()
Returns
Type Description
Parser<DisplaySpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 SearchRequest.DisplaySpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.DisplaySpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.DisplaySpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.DisplaySpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchRequest.DisplaySpec.Builder toBuilder()
Returns
Type Description
SearchRequest.DisplaySpec.Builder

writeTo(CodedOutputStream output)

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