com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec
extends com.google.api.client.json.GenericJson

A specification for configuring the behavior of content search.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	clone()
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec	getChunkSpec() Specifies the chunk spec to be returned from the search response.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	getExtractiveContentSpec() If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
String	getSearchResultMode() Specifies the search result mode.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec	getSnippetSpec() If `snippetSpec` is not specified, snippets are not included in the search response.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec	getSummarySpec() If `summarySpec` is not specified, summaries are not included in the search response.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	setChunkSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec chunkSpec) Specifies the chunk spec to be returned from the search response.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	setExtractiveContentSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec extractiveContentSpec) If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	setSearchResultMode(String searchResultMode) Specifies the search result mode.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	setSnippetSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec snippetSpec) If `snippetSpec` is not specified, snippets are not included in the search response.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec	setSummarySpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec summarySpec) If `summarySpec` is not specified, summaries are not included in the search response.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec()

Method Detail

getChunkSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec getChunkSpec()

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

Returns:

value or null for none

setChunkSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec setChunkSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec chunkSpec)

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

Parameters:

chunkSpec - chunkSpec or null for none

getExtractiveContentSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec getExtractiveContentSpec()

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

Returns:

value or null for none

setExtractiveContentSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec setExtractiveContentSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec extractiveContentSpec)

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

Parameters:

extractiveContentSpec - extractiveContentSpec or null for none

getSearchResultMode

public String getSearchResultMode()

Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.

Returns:

value or null for none

setSearchResultMode

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec setSearchResultMode(String searchResultMode)

Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.

Parameters:

searchResultMode - searchResultMode or null for none

getSnippetSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec getSnippetSpec()

If `snippetSpec` is not specified, snippets are not included in the search response.

Returns:

value or null for none

setSnippetSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec setSnippetSpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec snippetSpec)

If `snippetSpec` is not specified, snippets are not included in the search response.

Parameters:

snippetSpec - snippetSpec or null for none

getSummarySpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec getSummarySpec()

If `summarySpec` is not specified, summaries are not included in the search response.

Returns:

value or null for none

setSummarySpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec setSummarySpec(GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec summarySpec)

If `summarySpec` is not specified, summaries are not included in the search response.

Parameters:

summarySpec - summarySpec or null for none

set

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec set(String fieldName,
                                                                          Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson