com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores

public class DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GetSiteSearchEngine(String name) Gets the SiteSearchEngine.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getName() Required.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setName(String name) Required.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.discoveryengine.v1.DiscoveryEngineRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

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

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

GetSiteSearchEngine

protected GetSiteSearchEngine(String name)

Gets the SiteSearchEngine. Create a request for the method "dataStores.getSiteSearchEngine". This request holds the parameters needed by the the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

GetSiteSearchEngine#initialize(com.google.api.client.googleapis.services. AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collec tions/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

Throws:

IOException

set$Xgafv

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setAccessToken

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setAlt

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setCallback

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setFields

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setKey

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setKey(String key)

Description copied from class: DiscoveryEngineRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setOauthToken

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setQuotaUser

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setQuotaUser(String quotaUser)

Description copied from class: DiscoveryEngineRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setUploadType

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>

getName

public String getName()

Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/colle ctions/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

setName

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine setName(String name)

Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{loc ation}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

set

public DiscoveryEngine.Projects.Locations.DataStores.GetSiteSearchEngine set(String parameterName,
                                                                             Object value)

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1SiteSearchEngine>