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.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.drive.DriveRequest<File>

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

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Copy(String fileId, File content) Creates a copy of the specified file.

Method Summary

Modifier and Type	Method and Description
Boolean	getConvert() Whether to convert this file to the corresponding Docs Editors format.
Boolean	getEnforceSingleParent() Deprecated.
String	getFileId() The ID of the file to copy.
String	getIncludeLabels() A comma-separated list of IDs of labels to include in the labelInfo part of the response.
String	getIncludePermissionsForView() Specifies which additional view's permissions to include in the response.
Boolean	getOcr() Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
String	getOcrLanguage() If ocr is true, hints at the language to use.
Boolean	getPinned() Whether to pin the head revision of the new copy.
Boolean	getSupportsAllDrives() Whether the requesting application supports both My Drives and shared drives.
Boolean	getSupportsTeamDrives() Deprecated use supportsAllDrives instead.
String	getTimedTextLanguage() The language of the timed text.
String	getTimedTextTrackName() The timed text track name.
String	getVisibility() The visibility of the new file.
boolean	isConvert() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isEnforceSingleParent() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isOcr() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isPinned() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsAllDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isSupportsTeamDrives() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Files.Copy	set(String parameterName, Object value)
Drive.Files.Copy	setAlt(String alt) Data format for the response.
Drive.Files.Copy	setConvert(Boolean convert) Whether to convert this file to the corresponding Docs Editors format.
Drive.Files.Copy	setEnforceSingleParent(Boolean enforceSingleParent) Deprecated.
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	setIncludeLabels(String includeLabels) A comma-separated list of IDs of labels to include in the labelInfo part of the response.
Drive.Files.Copy	setIncludePermissionsForView(String includePermissionsForView) Specifies which additional view's permissions to include in the response.
Drive.Files.Copy	setKey(String key) API key.
Drive.Files.Copy	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Copy	setOcr(Boolean ocr) Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Drive.Files.Copy	setOcrLanguage(String ocrLanguage) If ocr is true, hints at the language to use.
Drive.Files.Copy	setPinned(Boolean pinned) Whether to pin the head revision of the new copy.
Drive.Files.Copy	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Copy	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Files.Copy	setSupportsAllDrives(Boolean supportsAllDrives) Whether the requesting application supports both My Drives and shared drives.
Drive.Files.Copy	setSupportsTeamDrives(Boolean supportsTeamDrives) Deprecated use supportsAllDrives instead.
Drive.Files.Copy	setTimedTextLanguage(String timedTextLanguage) The language of the timed text.
Drive.Files.Copy	setTimedTextTrackName(String timedTextTrackName) The timed text track name.
Drive.Files.Copy	setUserIp(String userIp) Deprecated.
Drive.Files.Copy	setVisibility(String visibility) The visibility of the new file.

Methods inherited from class com.google.api.services.drive.DriveRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, 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

Copy

protected Copy(String fileId,
               File content)

Creates a copy of the specified file. Folders cannot be copied. Create a request for the method "files.copy". This request holds the parameters needed by the the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Drive.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

fileId - The ID of the file to copy.

content - the File

Since:

1.13

Method Detail

setAlt

public Drive.Files.Copy setAlt(String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<File>

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

setKey

public Drive.Files.Copy setKey(String key)

Description copied from class: DriveRequest

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 DriveRequest<File>

setOauthToken

public Drive.Files.Copy setOauthToken(String oauthToken)

Description copied from class: DriveRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DriveRequest<File>

setPrettyPrint

public Drive.Files.Copy setPrettyPrint(Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<File>

setQuotaUser

public Drive.Files.Copy setQuotaUser(String quotaUser)

Description copied from class: DriveRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DriveRequest<File>

setUserIp

public Drive.Files.Copy setUserIp(String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<File>

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 Docs Editors format. [default: false]

setConvert

public Drive.Files.Copy setConvert(Boolean convert)

Whether to convert this file to the corresponding Docs Editors 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 Docs Editors format.

getEnforceSingleParent

public Boolean getEnforceSingleParent()

Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead. [default: false]

setEnforceSingleParent

public Drive.Files.Copy setEnforceSingleParent(Boolean enforceSingleParent)

Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.

isEnforceSingleParent

public boolean isEnforceSingleParent()

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.

Deprecated. Copying files into multiple folders is no longer supported. Use shortcuts instead.

getIncludeLabels

public String getIncludeLabels()

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

setIncludeLabels

public Drive.Files.Copy setIncludeLabels(String includeLabels)

A comma-separated list of IDs of labels to include in the labelInfo part of the response.

getIncludePermissionsForView

public String getIncludePermissionsForView()

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

setIncludePermissionsForView

public Drive.Files.Copy setIncludePermissionsForView(String includePermissionsForView)

Specifies which additional view's permissions to include in the response. Only 'published' is supported.

getOcr

public Boolean getOcr()

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

setOcr

public Drive.Files.Copy setOcr(Boolean ocr)

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

isOcr

public boolean isOcr()

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 attempt OCR on .jpg, .png, .gif, or .pdf uploads.

getOcrLanguage

public String getOcrLanguage()

If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

setOcrLanguage

public Drive.Files.Copy setOcrLanguage(String ocrLanguage)

If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

getPinned

public Boolean getPinned()

Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions. [default: false]

setPinned

public Drive.Files.Copy setPinned(Boolean pinned)

Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.

isPinned

public boolean isPinned()

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 pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.

getSupportsAllDrives

public Boolean getSupportsAllDrives()

Whether the requesting application supports both My Drives and shared drives. [default: false]

setSupportsAllDrives

public Drive.Files.Copy setSupportsAllDrives(Boolean supportsAllDrives)

Whether the requesting application supports both My Drives and shared drives.

isSupportsAllDrives

public boolean isSupportsAllDrives()

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 the requesting application supports both My Drives and shared drives.

getSupportsTeamDrives

public Boolean getSupportsTeamDrives()

Deprecated use supportsAllDrives instead. [default: false]

setSupportsTeamDrives

public Drive.Files.Copy setSupportsTeamDrives(Boolean supportsTeamDrives)

Deprecated use supportsAllDrives instead.

isSupportsTeamDrives

public boolean isSupportsTeamDrives()

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.

Deprecated use supportsAllDrives instead.

getTimedTextLanguage

public String getTimedTextLanguage()

The language of the timed text.

setTimedTextLanguage

public Drive.Files.Copy setTimedTextLanguage(String timedTextLanguage)

The language of the timed text.

getTimedTextTrackName

public String getTimedTextTrackName()

The timed text track name.

setTimedTextTrackName

public Drive.Files.Copy setTimedTextTrackName(String timedTextTrackName)

The timed text track name.

getVisibility

public String getVisibility()

The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false. [default: DEFAULT]

setVisibility

public Drive.Files.Copy setVisibility(String visibility)

The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.

set

public Drive.Files.Copy set(String parameterName,
                            Object value)

Overrides:

set in class DriveRequest<File>