com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

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	BatchGetDocumentsMetadata(String parent) Gets index freshness metadata for Documents.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
List<String>	getMatcherFhirMatcherFhirResources() Required.
List<String>	getMatcherUrisMatcherUris() The exact URIs to match by.
String	getParent() Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setMatcherFhirMatcherFhirResources(List<String> matcherFhirMatcherFhirResources) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setMatcherUrisMatcherUris(List<String> matcherUrisMatcherUris) The exact URIs to match by.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setParent(String parent) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata	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

BatchGetDocumentsMetadata

protected BatchGetDocumentsMetadata(String parent)

Gets index freshness metadata for Documents. Supported for website search only. Create a request for the method "branches.batchGetDocumentsMetadata". 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.

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

Parameters:

parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collecti ons/{collection}/dataStores/{data_store}/branches/{branch}`.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

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

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setAccessToken

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

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setAlt

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

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setCallback

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

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setFields

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

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setKey

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata 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<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setOauthToken

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

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setPrettyPrint

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

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata 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<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setUploadType

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

setUploadProtocol

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>

getParent

public String getParent()

Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collect ions/{collection}/dataStores/{data_store}/branches/{branch}`.

setParent

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata setParent(String parent)

Required. The parent branch resource name, such as `projects/{project}/locations/{l ocation}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.

getMatcherFhirMatcherFhirResources

public List<String> getMatcherFhirMatcherFhirResources()

Required. The FHIR resources to match by. Format: projects/{project}/locations/{location}/datasets/ {dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}

setMatcherFhirMatcherFhirResources

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata setMatcherFhirMatcherFhirResources(List<String> matcherFhirMatcherFhirResources)

Required. The FHIR resources to match by. Format: projects/{project}/locations/{loc ation}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resour ce_id}

getMatcherUrisMatcherUris

public List<String> getMatcherUrisMatcherUris()

The exact URIs to match by.

setMatcherUrisMatcherUris

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.BatchGetDocumentsMetadata setMatcherUrisMatcherUris(List<String> matcherUrisMatcherUris)

The exact URIs to match by.

set

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

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1BatchGetDocumentsMetadataResponse>