Class SearchRequest.ContentSearchSpec.ChunkSpec (0.45.0)

public static final class SearchRequest.ContentSearchSpec.ChunkSpec extends GeneratedMessageV3 implements SearchRequest.ContentSearchSpec.ChunkSpecOrBuilder

Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

Protobuf type google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchRequest.ContentSearchSpec.ChunkSpec

Static Fields

NUM_NEXT_CHUNKS_FIELD_NUMBER

public static final int NUM_NEXT_CHUNKS_FIELD_NUMBER
Field Value
Type Description
int

NUM_PREVIOUS_CHUNKS_FIELD_NUMBER

public static final int NUM_PREVIOUS_CHUNKS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest.ContentSearchSpec.ChunkSpec getDefaultInstance()
Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec

getDescriptor()

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

newBuilder()

public static SearchRequest.ContentSearchSpec.ChunkSpec.Builder newBuilder()
Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec.Builder

newBuilder(SearchRequest.ContentSearchSpec.ChunkSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchRequest.ContentSearchSpec.ChunkSpec getDefaultInstanceForType()
Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec

getNumNextChunks()

public int getNumNextChunks()

The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.

int32 num_next_chunks = 2;

Returns
Type Description
int

The numNextChunks.

getNumPreviousChunks()

public int getNumPreviousChunks()

The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.

int32 num_previous_chunks = 1;

Returns
Type Description
int

The numPreviousChunks.

getParserForType()

public Parser<SearchRequest.ContentSearchSpec.ChunkSpec> getParserForType()
Returns
Type Description
Parser<ChunkSpec>
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.ContentSearchSpec.ChunkSpec.Builder newBuilderForType()
Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchRequest.ContentSearchSpec.ChunkSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec.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.ContentSearchSpec.ChunkSpec.Builder toBuilder()
Returns
Type Description
SearchRequest.ContentSearchSpec.ChunkSpec.Builder

writeTo(CodedOutputStream output)

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