com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch

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<GoogleCloudDiscoveryengineV1WidgetConfig>

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs

public class DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

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	Patch(String name, GoogleCloudDiscoveryengineV1WidgetConfig content) Update a WidgetConfig.

Method Summary

Modifier and Type	Method and Description
String	getName() Immutable.
String	getUpdateMask() Indicates which fields in the provided WidgetConfig to update.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setName(String name) Immutable.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setUpdateMask(String updateMask) Indicates which fields in the provided WidgetConfig to update.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch	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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Patch

protected Patch(String name,
                GoogleCloudDiscoveryengineV1WidgetConfig content)

Update a WidgetConfig. Create a request for the method "widgetConfigs.patch". 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.

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

Parameters:

name - Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{locat ion}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_i d}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

content - the GoogleCloudDiscoveryengineV1WidgetConfig

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setAccessToken

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setAlt

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setCallback

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setFields

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setKey

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch 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<GoogleCloudDiscoveryengineV1WidgetConfig>

setOauthToken

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setQuotaUser

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch 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<GoogleCloudDiscoveryengineV1WidgetConfig>

setUploadType

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>

getName

public String getName()

Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{loca tion}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

setName

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setName(String name)

Immutable. The full resource name of the widget config. Format: `projects/{project}/l ocations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConf igs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

getUpdateMask

public String getUpdateMask()

Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.

setUpdateMask

public DiscoveryEngine.Projects.Locations.DataStores.WidgetConfigs.Patch setUpdateMask(String updateMask)

Indicates which fields in the provided WidgetConfig to update. The following are the only supported fields: * WidgetConfig.enable_autocomplete If not set, all supported fields are updated.

set

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

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1WidgetConfig>