Firestore.Projects.Databases.ExportDocuments (Cloud Firestore API v1 (Rev. 25) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.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.firestore.v1.FirestoreRequest<GoogleLongrunningOperation>
        
        com.google.api.services.firestore.v1.Firestore.Projects.Databases.ExportDocuments

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Firestore.Projects.Databases
```
public class Firestore.Projects.Databases.ExportDocuments
extends FirestoreRequest<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
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ExportDocuments(java.lang.String name, GoogleFirestoreAdminV1ExportDocumentsRequest content)` Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getName()` Required.
`Firestore.Projects.Databases.ExportDocuments`	`set(java.lang.String parameterName, java.lang.Object value)`
`Firestore.Projects.Databases.ExportDocuments`	`set$Xgafv(java.lang.String $Xgafv)` V1 error format.
`Firestore.Projects.Databases.ExportDocuments`	`setAccessToken(java.lang.String accessToken)` OAuth access token.
`Firestore.Projects.Databases.ExportDocuments`	`setAlt(java.lang.String alt)` Data format for response.
`Firestore.Projects.Databases.ExportDocuments`	`setCallback(java.lang.String callback)` JSONP
`Firestore.Projects.Databases.ExportDocuments`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Firestore.Projects.Databases.ExportDocuments`	`setKey(java.lang.String key)` API key.
`Firestore.Projects.Databases.ExportDocuments`	`setName(java.lang.String name)` Required.
`Firestore.Projects.Databases.ExportDocuments`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Firestore.Projects.Databases.ExportDocuments`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Firestore.Projects.Databases.ExportDocuments`	`setQuotaUser(java.lang.String quotaUser)` Available to use for quota purposes for server-side applications.
`Firestore.Projects.Databases.ExportDocuments`	`setUploadProtocol(java.lang.String uploadProtocol)` Upload protocol for media (e.g.
`Firestore.Projects.Databases.ExportDocuments`	`setUploadType(java.lang.String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.firestore.v1.FirestoreRequest
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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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
  - ExportDocuments
```
protected ExportDocuments(java.lang.String name,
                          GoogleFirestoreAdminV1ExportDocumentsRequest content)
```
    Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage. Create a request for the method "databases.exportDocuments". This request holds the parameters needed by the the firestore server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    ExportDocuments#initialize(com.google.api.client.googleapis.services.Abst ractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
    
    content - the GoogleFirestoreAdminV1ExportDocumentsRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public Firestore.Projects.Databases.ExportDocuments set$Xgafv(java.lang.String $Xgafv)
```
    Description copied from class: FirestoreRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class FirestoreRequest<GoogleLongrunningOperation>
  - setAccessToken
```
public Firestore.Projects.Databases.ExportDocuments setAccessToken(java.lang.String accessToken)
```
    Description copied from class: FirestoreRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class FirestoreRequest<GoogleLongrunningOperation>
  - setAlt
```
public Firestore.Projects.Databases.ExportDocuments setAlt(java.lang.String alt)
```
    Description copied from class: FirestoreRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class FirestoreRequest<GoogleLongrunningOperation>
  - setCallback
```
public Firestore.Projects.Databases.ExportDocuments setCallback(java.lang.String callback)
```
    Description copied from class: FirestoreRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class FirestoreRequest<GoogleLongrunningOperation>
  - setFields
```
public Firestore.Projects.Databases.ExportDocuments setFields(java.lang.String fields)
```
    Description copied from class: FirestoreRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class FirestoreRequest<GoogleLongrunningOperation>
  - setKey
```
public Firestore.Projects.Databases.ExportDocuments setKey(java.lang.String key)
```
    Description copied from class: FirestoreRequest
    
    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 FirestoreRequest<GoogleLongrunningOperation>
  - setOauthToken
```
public Firestore.Projects.Databases.ExportDocuments setOauthToken(java.lang.String oauthToken)
```
    Description copied from class: FirestoreRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class FirestoreRequest<GoogleLongrunningOperation>
  - setPrettyPrint
```
public Firestore.Projects.Databases.ExportDocuments setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: FirestoreRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class FirestoreRequest<GoogleLongrunningOperation>
  - setQuotaUser
```
public Firestore.Projects.Databases.ExportDocuments setQuotaUser(java.lang.String quotaUser)
```
    Description copied from class: FirestoreRequest
    
    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 FirestoreRequest<GoogleLongrunningOperation>
  - setUploadType
```
public Firestore.Projects.Databases.ExportDocuments setUploadType(java.lang.String uploadType)
```
    Description copied from class: FirestoreRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class FirestoreRequest<GoogleLongrunningOperation>
  - setUploadProtocol
```
public Firestore.Projects.Databases.ExportDocuments setUploadProtocol(java.lang.String uploadProtocol)
```
    Description copied from class: FirestoreRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class FirestoreRequest<GoogleLongrunningOperation>
  - getName
```
public java.lang.String getName()
```
    Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
  - setName
```
public Firestore.Projects.Databases.ExportDocuments setName(java.lang.String name)
```
    Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
  - set
```
public Firestore.Projects.Databases.ExportDocuments set(java.lang.String parameterName,
                                                        java.lang.Object value)
```
    Overrides:
    
    set in class FirestoreRequest<GoogleLongrunningOperation>

Cloud Firestore API v1 (revision 25)

Class Firestore.Projects.Databases.ExportDocuments

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.firestore.v1.FirestoreRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

ExportDocuments

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

set