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

Class GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec

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.GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

A specification for configuring snippets in a search response.

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
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec	clone()
Integer	getMaxSnippetCount() [DEPRECATED] This field is deprecated.
Boolean	getReferenceOnly() [DEPRECATED] This field is deprecated and will have no affect on the snippet.
Boolean	getReturnSnippet() If `true`, then return snippet.
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec	setMaxSnippetCount(Integer maxSnippetCount) [DEPRECATED] This field is deprecated.
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec	setReferenceOnly(Boolean referenceOnly) [DEPRECATED] This field is deprecated and will have no affect on the snippet.
GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec	setReturnSnippet(Boolean returnSnippet) If `true`, then return snippet.

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

GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec

public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec()

Method Detail

getMaxSnippetCount

public Integer getMaxSnippetCount()

[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.

Returns:

value or null for none

setMaxSnippetCount

public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec setMaxSnippetCount(Integer maxSnippetCount)

[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.

Parameters:

maxSnippetCount - maxSnippetCount or null for none

getReferenceOnly

public Boolean getReferenceOnly()

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

Returns:

value or null for none

setReferenceOnly

public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec setReferenceOnly(Boolean referenceOnly)

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

Parameters:

referenceOnly - referenceOnly or null for none

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.

Returns:

value or null for none

setReturnSnippet

public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec setReturnSnippet(Boolean returnSnippet)

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.

Parameters:

returnSnippet - returnSnippet or null for none

set

public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec set(String fieldName,
                                                                                 Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSnippetSpec clone()

Overrides:

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