public static final class SearchRequest.ContentSearchSpec.SnippetSpec.Builder extends GeneratedMessageV3.Builder<SearchRequest.ContentSearchSpec.SnippetSpec.Builder> implements SearchRequest.ContentSearchSpec.SnippetSpecOrBuilder
A specification for configuring snippets in a search response.
Protobuf type
google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public SearchRequest.ContentSearchSpec.SnippetSpec build()
buildPartial()
public SearchRequest.ContentSearchSpec.SnippetSpec buildPartial()
clear()
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearMaxSnippetCount() (deprecated)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearMaxSnippetCount()
Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count
is deprecated. See google/cloud/discoveryengine/v1beta/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];
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearReferenceOnly() (deprecated)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReferenceOnly()
Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only
is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=308
[DEPRECATED] This field is deprecated and will have no affect on the
snippet.
bool reference_only = 2 [deprecated = true];
clearReturnSnippet()
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clearReturnSnippet()
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;
clone()
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder clone()
Overrides
getDefaultInstanceForType()
public SearchRequest.ContentSearchSpec.SnippetSpec getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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=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];
| Returns |
|---|
| Type | Description |
int | The maxSnippetCount.
|
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=308
[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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(SearchRequest.ContentSearchSpec.SnippetSpec other)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(SearchRequest.ContentSearchSpec.SnippetSpec other)
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.ContentSearchSpec.SnippetSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setMaxSnippetCount(int value) (deprecated)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setMaxSnippetCount(int value)
Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.max_snippet_count
is deprecated. See google/cloud/discoveryengine/v1beta/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];
| Parameter |
|---|
| Name | Description |
value | int
The maxSnippetCount to set.
|
setReferenceOnly(boolean value) (deprecated)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReferenceOnly(boolean value)
Deprecated. google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SnippetSpec.reference_only
is deprecated. See google/cloud/discoveryengine/v1beta/search_service.proto;l=308
[DEPRECATED] This field is deprecated and will have no affect on the
snippet.
bool reference_only = 2 [deprecated = true];
| Parameter |
|---|
| Name | Description |
value | boolean
The referenceOnly to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setReturnSnippet(boolean value)
public SearchRequest.ContentSearchSpec.SnippetSpec.Builder setReturnSnippet(boolean value)
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;
| Parameter |
|---|
| Name | Description |
value | boolean
The returnSnippet to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchRequest.ContentSearchSpec.SnippetSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
