Send feedback
Class SearchRequest.ContentSearchSpec.SnippetSpec (0.26.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 0.26.0 keyboard_arrow_down
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.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
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 ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchRequest . ContentSearchSpec . SnippetSpec . Builder newBuilder ()
newBuilder(SearchRequest.ContentSearchSpec.SnippetSpec prototype)
public static SearchRequest . ContentSearchSpec . SnippetSpec . Builder newBuilder ( SearchRequest . ContentSearchSpec . SnippetSpec prototype )
parseDelimitedFrom(InputStream input)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchRequest . ContentSearchSpec . SnippetSpec parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchRequest . ContentSearchSpec . SnippetSpec > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides
getDefaultInstanceForType()
public SearchRequest . ContentSearchSpec . SnippetSpec getDefaultInstanceForType ()
getMaxSnippetCount() (deprecated)
public int getMaxSnippetCount ()
Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count
is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=308
[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 ()
Overrides
getReferenceOnly() (deprecated)
public boolean getReferenceOnly ()
Deprecated. google.cloud.discoveryengine.v1alpha.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only
is deprecated. See google/cloud/discoveryengine/v1alpha/search_service.proto;l=312
[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()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchRequest . ContentSearchSpec . SnippetSpec . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchRequest . ContentSearchSpec . SnippetSpec . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public SearchRequest . ContentSearchSpec . SnippetSpec . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]