Package com.google.cloud.discoveryengine.v1

Class SearchRequest.ContentSearchSpec.SnippetSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec

All Implemented Interfaces:

SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchRequest.ContentSearchSpec

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

 A specification for configuring snippets in a search response.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchRequest.ContentSearchSpec.SnippetSpec.Builder	A specification for configuring snippets in a search response.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	MAX_SNIPPET_COUNT_FIELD_NUMBER
static int	REFERENCE_ONLY_FIELD_NUMBER
static int	RETURN_SNIPPET_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static SearchRequest.ContentSearchSpec.SnippetSpec	getDefaultInstance()
SearchRequest.ContentSearchSpec.SnippetSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
int	getMaxSnippetCount()	Deprecated. google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated.
com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SnippetSpec>	getParserForType()
boolean	getReferenceOnly()	Deprecated. google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated.
boolean	getReturnSnippet()	If `true`, then return snippet.
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static SearchRequest.ContentSearchSpec.SnippetSpec.Builder	newBuilder()
static SearchRequest.ContentSearchSpec.SnippetSpec.Builder	newBuilder(SearchRequest.ContentSearchSpec.SnippetSpec prototype)
SearchRequest.ContentSearchSpec.SnippetSpec.Builder	newBuilderForType()
protected SearchRequest.ContentSearchSpec.SnippetSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseDelimitedFrom(InputStream input)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(byte[] data)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(com.google.protobuf.ByteString data)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(InputStream input)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(ByteBuffer data)
static SearchRequest.ContentSearchSpec.SnippetSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SnippetSpec>	parser()
SearchRequest.ContentSearchSpec.SnippetSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Detail

MAX_SNIPPET_COUNT_FIELD_NUMBER

public static final int MAX_SNIPPET_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

REFERENCE_ONLY_FIELD_NUMBER

public static final int REFERENCE_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

RETURN_SNIPPET_FIELD_NUMBER

public static final int RETURN_SNIPPET_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getMaxSnippetCount

@Deprecated
public int getMaxSnippetCount()

Deprecated.

google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count is deprecated. See google/cloud/discoveryengine/v1/search_service.proto;l=304

 [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];

Specified by:

getMaxSnippetCount in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

Returns:

The maxSnippetCount.

getReferenceOnly

@Deprecated
public boolean getReferenceOnly()

Deprecated.

google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only is deprecated. See google/cloud/discoveryengine/v1/search_service.proto;l=308

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

bool reference_only = 2 [deprecated = true];

Specified by:

getReferenceOnly in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

Returns:

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;

Specified by:

getReturnSnippet in interface SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder

Returns:

The returnSnippet.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(ByteBuffer data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(ByteBuffer data,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(com.google.protobuf.ByteString data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(com.google.protobuf.ByteString data,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(byte[] data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(byte[] data,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(InputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(InputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseDelimitedFrom(InputStream input)
                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseDelimitedFrom(InputStream input,
                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                      throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                                             throws IOException

Throws:

IOException

parseFrom

public static SearchRequest.ContentSearchSpec.SnippetSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                             throws IOException

Throws:

IOException

newBuilderForType

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchRequest.ContentSearchSpec.SnippetSpec.Builder newBuilder()

newBuilder

public static SearchRequest.ContentSearchSpec.SnippetSpec.Builder newBuilder(SearchRequest.ContentSearchSpec.SnippetSpec prototype)

toBuilder

public SearchRequest.ContentSearchSpec.SnippetSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchRequest.ContentSearchSpec.SnippetSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static SearchRequest.ContentSearchSpec.SnippetSpec getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SnippetSpec> parser()

getParserForType

public com.google.protobuf.Parser<SearchRequest.ContentSearchSpec.SnippetSpec> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public SearchRequest.ContentSearchSpec.SnippetSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder