com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations

public class DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2
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	SetUpDataConnectorV2(String parent, GoogleCloudDiscoveryengineV1DataConnector content) Creates a Collection and sets up the DataConnector for it.

Method Summary

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

SetUpDataConnectorV2

protected SetUpDataConnectorV2(String parent,
                               GoogleCloudDiscoveryengineV1DataConnector content)

Creates a Collection and sets up the DataConnector for it. To stop a DataConnector after setup, use the CollectionService.DeleteCollection method. Create a request for the method "locations.setUpDataConnectorV2". 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.

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

Parameters:

parent - Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.

content - the GoogleCloudDiscoveryengineV1DataConnector

Since:

1.13

Method Detail

set$Xgafv

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 set$Xgafv(String $Xgafv)

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setAccessToken

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setAccessToken(String accessToken)

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setAlt

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setAlt(String alt)

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setCallback

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setCallback(String callback)

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleLongrunningOperation>

setFields

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 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.SetUpDataConnectorV2 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.SetUpDataConnectorV2 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.SetUpDataConnectorV2 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.SetUpDataConnectorV2 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.SetUpDataConnectorV2 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.SetUpDataConnectorV2 setUploadProtocol(String uploadProtocol)

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleLongrunningOperation>

getParent

public String getParent()

Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.

setParent

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setParent(String parent)

Required. The parent of Collection, in the format of `projects/{project}/locations/{location}`.

getCollectionDisplayName

public String getCollectionDisplayName()

Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

setCollectionDisplayName

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setCollectionDisplayName(String collectionDisplayName)

Required. The display name of the Collection. Should be human readable, used to display collections in the Console Dashboard. UTF-8 encoded string with limit of 1024 characters.

getCollectionId

public String getCollectionId()

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

setCollectionId

public DiscoveryEngine.Projects.Locations.SetUpDataConnectorV2 setCollectionId(String collectionId)

Required. The ID to use for the Collection, which will become the final component of the Collection's resource name. A new Collection is created as part of the DataConnector setup. DataConnector is a singleton resource under Collection, managing all DataStores of the Collection. Should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

set

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

Overrides:

set in class DiscoveryEngineRequest<GoogleLongrunningOperation>