Class GuidedSearchSpec (0.35.0)

public final class GuidedSearchSpec extends GeneratedMessageV3 implements GuidedSearchSpecOrBuilder

Defines guided search spec.

Protobuf type google.cloud.discoveryengine.v1alpha.GuidedSearchSpec

Static Fields

ENABLE_REFINEMENT_ATTRIBUTES_FIELD_NUMBER

public static final int ENABLE_REFINEMENT_ATTRIBUTES_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int ENABLE_RELATED_QUESTIONS_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int MAX_RELATED_QUESTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GuidedSearchSpec getDefaultInstance()
Returns
TypeDescription
GuidedSearchSpec

getDescriptor()

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

newBuilder()

public static GuidedSearchSpec.Builder newBuilder()
Returns
TypeDescription
GuidedSearchSpec.Builder

newBuilder(GuidedSearchSpec prototype)

public static GuidedSearchSpec.Builder newBuilder(GuidedSearchSpec prototype)
Parameter
NameDescription
prototypeGuidedSearchSpec
Returns
TypeDescription
GuidedSearchSpec.Builder

parseDelimitedFrom(InputStream input)

public static GuidedSearchSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuidedSearchSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GuidedSearchSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GuidedSearchSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GuidedSearchSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GuidedSearchSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GuidedSearchSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GuidedSearchSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GuidedSearchSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GuidedSearchSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GuidedSearchSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GuidedSearchSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GuidedSearchSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GuidedSearchSpec> parser()
Returns
TypeDescription
Parser<GuidedSearchSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public GuidedSearchSpec getDefaultInstanceForType()
Returns
TypeDescription
GuidedSearchSpec

getEnableRefinementAttributes()

public boolean getEnableRefinementAttributes()

Whether or not to enable and include refinement attributes in gudied search result.

bool enable_refinement_attributes = 1;

Returns
TypeDescription
boolean

The enableRefinementAttributes.

getEnableRelatedQuestions()

public boolean getEnableRelatedQuestions()

Whether or not to enable and include related questions in search response.

bool enable_related_questions = 2;

Returns
TypeDescription
boolean

The enableRelatedQuestions.

getMaxRelatedQuestions()

public int getMaxRelatedQuestions()

Max number of related questions to be returned. The valid range is [1, 5]. If enable_related_questions is true, the default value is 3.

int32 max_related_questions = 3;

Returns
TypeDescription
int

The maxRelatedQuestions.

getParserForType()

public Parser<GuidedSearchSpec> getParserForType()
Returns
TypeDescription
Parser<GuidedSearchSpec>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GuidedSearchSpec.Builder newBuilderForType()
Returns
TypeDescription
GuidedSearchSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GuidedSearchSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GuidedSearchSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GuidedSearchSpec.Builder toBuilder()
Returns
TypeDescription
GuidedSearchSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException