Drive API v2 (revision 1)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.google.api.services.drive
Class Drive.Files.Copy

java.lang.Object
  java.util.AbstractMap<String,Object>
      com.google.api.client.util.GenericData
          com.google.api.client.http.json.JsonHttpRequest
              com.google.api.services.drive.DriveRequest
                  com.google.api.services.drive.Drive.Files.Copy

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: Drive.Files

public class Drive.Files.Copy
extends DriveRequest
extends DriveRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
`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>`

Method Summary
`File`	`execute()` Sends the "copy" request to the Drive server.
`Boolean`	`getConvert()` Whether to convert this file to the corresponding Google Docs format.
`String`	`getFileId()` The ID of the file to copy.
`Boolean`	`getOcr()` Whether to attempt OCR on .jpg, .png, or .gif uploads.
`String`	`getOcrLanguage()` If ocr is true, hints at the language to use.
`String`	`getSourceLanguage()` The language of the original file to be translated.
`String`	`getTargetLanguage()` Target language to translate the file to.
`String`	`getTimedTextLanguage()` The language of the timed text.
`String`	`getTimedTextTrackName()` The timed text track name.
`boolean`	`isConvert()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`boolean`	`isOcr()` Convenience method that returns only `Boolean.TRUE` or `Boolean.FALSE`.
`void`	`queue(BatchRequest batch, JsonBatchCallback<File> callback)` Queues the "copy" request to the Drive server into the given batch request.
`Drive.Files.Copy`	`setConvert(Boolean convert)` Whether to convert this file to the corresponding Google Docs format.
`Drive.Files.Copy`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Drive.Files.Copy`	`setFileId(String fileId)` The ID of the file to copy.
`Drive.Files.Copy`	`setOcr(Boolean ocr)` Whether to attempt OCR on .jpg, .png, or .gif uploads.
`Drive.Files.Copy`	`setOcrLanguage(String ocrLanguage)` If ocr is true, hints at the language to use.
`Drive.Files.Copy`	`setSourceLanguage(String sourceLanguage)` The language of the original file to be translated.
`Drive.Files.Copy`	`setTargetLanguage(String targetLanguage)` Target language to translate the file to.
`Drive.Files.Copy`	`setTimedTextLanguage(String timedTextLanguage)` The language of the timed text.
`Drive.Files.Copy`	`setTimedTextTrackName(String timedTextTrackName)` The timed text track name.

Methods inherited from class com.google.api.services.drive.DriveRequest
`getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setAlt, setKey, setOauthToken, setPrettyPrint, setQuotaUser, setUserIp`

Methods inherited from class com.google.api.client.http.json.JsonHttpRequest
`buildHttpRequest, buildHttpRequestUrl, download, executeAsInputStream, executeUnparsed, getClient, getEnableGZipContent, getJsonContent, getLastResponseHeaders, getMethod, getRequestHeaders, getUriTemplate, setEnableGZipContent, setRequestHeaders`

Methods inherited from class com.google.api.client.util.GenericData
`clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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`

Method Detail

execute

public File execute()
             throws IOException

Sends the "copy" request to the Drive server.

Returns:: the File response
Throws:: IOException - if the request fails

queue

public void queue(BatchRequest batch,
                  JsonBatchCallback<File> callback)
           throws IOException

Queues the "copy" request to the Drive server into the given batch request.

Example usage:

         request.queue(batchRequest, new JsonBatchCallback<File>() {

           public void onSuccess(File content, GoogleHeaders responseHeaders) {
             log("Success");
           }

           public void onFailure(GoogleJsonError e, GoogleHeaders responseHeaders) {
             log(e.getMessage());
           }
         });

Parameters:: batch - a single batch of requests; callback - batch callback
Throws:: IOException
Since:: 1.6

setFields

public Drive.Files.Copy setFields(String fields)

Description copied from class: DriveRequest

Selector specifying which fields to include in a partial response.

Overrides:: setFields in class DriveRequest

Since:: 1.7

getFileId

public String getFileId()

The ID of the file to copy.

setFileId

public Drive.Files.Copy setFileId(String fileId)

The ID of the file to copy.

getConvert

public Boolean getConvert()

Whether to convert this file to the corresponding Google Docs format. [default: false]

setConvert

public Drive.Files.Copy setConvert(Boolean convert)

Whether to convert this file to the corresponding Google Docs format.

isConvert

public boolean isConvert()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Whether to convert this file to the corresponding Google Docs format.

getOcr

public Boolean getOcr()

Whether to attempt OCR on .jpg, .png, or .gif uploads. [default: false]

setOcr

public Drive.Files.Copy setOcr(Boolean ocr)

Whether to attempt OCR on .jpg, .png, or .gif uploads.

isOcr

public boolean isOcr()