com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel

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

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel
extends DiscoveryEngineRequest<GoogleLongrunningOperation>

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	TrainCustomModel(String dataStore, GoogleCloudDiscoveryengineV1TrainCustomModelRequest content) Trains a custom model.

Method Summary

Modifier and Type	Method and Description
String	getDataStore() Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setDataStore(String dataStore) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	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

TrainCustomModel

protected TrainCustomModel(String dataStore,
                           GoogleCloudDiscoveryengineV1TrainCustomModelRequest content)

Trains a custom model. Create a request for the method "dataStores.trainCustomModel". 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.

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

Parameters:

dataStore - Required. The resource name of the Data Store, such as `projects/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.

content - the GoogleCloudDiscoveryengineV1TrainCustomModelRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setAccessToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setAlt

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setCallback

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setFields

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setFields(String fields)

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setKey

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel 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<GoogleLongrunningOperation>

setOauthToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setOauthToken(String oauthToken)

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setPrettyPrint

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel 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<GoogleLongrunningOperation>

setUploadType

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setUploadType(String uploadType)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setUploadProtocol

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleLongrunningOperation>

getDataStore

public String getDataStore()

Required. The resource name of the Data Store, such as `projects/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.

setDataStore

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel setDataStore(String dataStore)

Required. The resource name of the Data Store, such as `projects/locations/global/col lections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.

set

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

Overrides:

set in class DiscoveryEngineRequest<GoogleLongrunningOperation>