Class SearchRequest.ContentSearchSpec.SnippetSpec (0.48.0) 

public static final class SearchRequest.ContentSearchSpec.SnippetSpec extends GeneratedMessageV3 implements SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

A specification for configuring snippets in a search response.

Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec

Inheritance

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

Static Fields

MAX_SNIPPET_COUNT_FIELD_NUMBER

public static final int MAX_SNIPPET_COUNT_FIELD_NUMBER
Field Value
Type Description
int

REFERENCE_ONLY_FIELD_NUMBER

public static final int REFERENCE_ONLY_FIELD_NUMBER
Field Value
Type Description
int

RETURN_SNIPPET_FIELD_NUMBER

public static final int RETURN_SNIPPET_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(SearchRequest.ContentSearchSpec.SnippetSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getMaxSnippetCount() (deprecated)

public int getMaxSnippetCount()

Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=406

[DEPRECATED] This field is deprecated. To control snippet return, use return_snippet field. For backwards compatibility, we will return snippet if max_snippet_count > 0.

int32 max_snippet_count = 1 [deprecated = true];

Returns
Type Description
int

The maxSnippetCount.

getParserForType()

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

getReferenceOnly() (deprecated)

public boolean getReferenceOnly()

Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=410

[DEPRECATED] This field is deprecated and will have no affect on the snippet.

bool reference_only = 2 [deprecated = true];

Returns
Type Description
boolean

The referenceOnly.

getReturnSnippet()

public boolean getReturnSnippet()

If true, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A snippet_status with SUCCESS or NO_SNIPPET_AVAILABLE will also be returned.

bool return_snippet = 3;

Returns
Type Description
boolean

The returnSnippet.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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