com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents

public class DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List
extends DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

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	List(String parent) Gets a list of Documents.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
Integer	getPageSize() Maximum number of Documents to return.
String	getPageToken() A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call.
String	getParent() Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	set(String parameterName, Object value)
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	set$Xgafv(String $Xgafv) V1 error format.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setAccessToken(String accessToken) OAuth access token.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setAlt(String alt) Data format for response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setCallback(String callback) JSONP
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setFields(String fields) Selector specifying which fields to include in a partial response.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setKey(String key) API key.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setPageSize(Integer pageSize) Maximum number of Documents to return.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setPageToken(String pageToken) A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setParent(String parent) Required.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List	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

List

protected List(String parent)

Gets a list of Documents. Create a request for the method "documents.list". 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:

parent - Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collecti ons/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch 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<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

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

Description copied from class: DiscoveryEngineRequest

V1 error format.

Overrides:

set$Xgafv in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setAccessToken

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

Description copied from class: DiscoveryEngineRequest

OAuth access token.

Overrides:

setAccessToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setAlt

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

Description copied from class: DiscoveryEngineRequest

Data format for response.

Overrides:

setAlt in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setCallback

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

Description copied from class: DiscoveryEngineRequest

JSONP

Overrides:

setCallback in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setFields

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

Description copied from class: DiscoveryEngineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setKey

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List 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<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setOauthToken

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

Description copied from class: DiscoveryEngineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setPrettyPrint

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

Description copied from class: DiscoveryEngineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setQuotaUser

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List 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<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setUploadType

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadType in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

setUploadProtocol

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

Description copied from class: DiscoveryEngineRequest

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

Overrides:

setUploadProtocol in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>

getParent

public String getParent()

Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collect ions/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.

setParent

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

Required. The parent branch resource name, such as `projects/{project}/locations/ {location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned.

getPageSize

public Integer getPageSize()

Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.

setPageSize

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List setPageSize(Integer pageSize)

Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.

getPageToken

public String getPageToken()

A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.

setPageToken

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches.Documents.List setPageToken(String pageToken)

A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.

set

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

Overrides:

set in class DiscoveryEngineRequest<GoogleCloudDiscoveryengineV1ListDocumentsResponse>