com.google.api.services.drive

Class Drive.Files.Insert

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

com.google.api.services.drive.Drive.Files.Insert

All Implemented Interfaces:

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

Enclosing class:

Drive.Files

public class Drive.Files.Insert
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

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	Insert(File content) Insert a new file.
protected	Insert(File content, com.google.api.client.http.AbstractInputStreamContent mediaContent) Insert a new file.

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getConvert() Whether to convert this file to the corresponding Google Docs format.
java.lang.Boolean	getEnforceSingleParent() Set to true to opt in to API behavior that aims for all items to have exactly one parent.
java.lang.Boolean	getOcr() Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
java.lang.String	getOcrLanguage() If ocr is true, hints at the language to use.
java.lang.Boolean	getPinned() Whether to pin the head revision of the uploaded file.
java.lang.Boolean	getSupportsAllDrives() Deprecated - Whether the requesting application supports both My Drives and shared drives.
java.lang.Boolean	getSupportsTeamDrives() Deprecated use supportsAllDrives instead.
java.lang.String	getTimedTextLanguage() The language of the timed text.
java.lang.String	getTimedTextTrackName() The timed text track name.
java.lang.Boolean	getUseContentAsIndexableText() Whether to use the content as indexable text.
java.lang.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.
boolean	isUseContentAsIndexableText() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Drive.Files.Insert	set(java.lang.String parameterName, java.lang.Object value)
Drive.Files.Insert	setAlt(java.lang.String alt) Data format for the response.
Drive.Files.Insert	setConvert(java.lang.Boolean convert) Whether to convert this file to the corresponding Google Docs format.
Drive.Files.Insert	setEnforceSingleParent(java.lang.Boolean enforceSingleParent) Set to true to opt in to API behavior that aims for all items to have exactly one parent.
Drive.Files.Insert	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Drive.Files.Insert	setKey(java.lang.String key) API key.
Drive.Files.Insert	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Drive.Files.Insert	setOcr(java.lang.Boolean ocr) Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.
Drive.Files.Insert	setOcrLanguage(java.lang.String ocrLanguage) If ocr is true, hints at the language to use.
Drive.Files.Insert	setPinned(java.lang.Boolean pinned) Whether to pin the head revision of the uploaded file.
Drive.Files.Insert	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Drive.Files.Insert	setQuotaUser(java.lang.String quotaUser) An opaque string that represents a user for quota purposes.
Drive.Files.Insert	setSupportsAllDrives(java.lang.Boolean supportsAllDrives) Deprecated - Whether the requesting application supports both My Drives and shared drives.
Drive.Files.Insert	setSupportsTeamDrives(java.lang.Boolean supportsTeamDrives) Deprecated use supportsAllDrives instead.
Drive.Files.Insert	setTimedTextLanguage(java.lang.String timedTextLanguage) The language of the timed text.
Drive.Files.Insert	setTimedTextTrackName(java.lang.String timedTextTrackName) The timed text track name.
Drive.Files.Insert	setUseContentAsIndexableText(java.lang.Boolean useContentAsIndexableText) Whether to use the content as indexable text.
Drive.Files.Insert	setUserIp(java.lang.String userIp) Deprecated.
Drive.Files.Insert	setVisibility(java.lang.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, 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

Insert

protected Insert(File content)

Insert a new file. Create a request for the method "files.insert". 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:

content - the File

Since:

1.13

Insert

protected Insert(File content,
                 com.google.api.client.http.AbstractInputStreamContent mediaContent)

Insert a new file. Create a request for the method "files.insert". 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.

This constructor should be used for uploading media content.

Parameters:

content - the File media metadata or null if none

mediaContent - The media HTTP content or null if none.

Since:

1.13

Method Detail

setAlt

public Drive.Files.Insert setAlt(java.lang.String alt)

Description copied from class: DriveRequest

Data format for the response.

Overrides:

setAlt in class DriveRequest<File>

setFields

public Drive.Files.Insert setFields(java.lang.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.Insert setKey(java.lang.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.Insert setOauthToken(java.lang.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.Insert setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: DriveRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DriveRequest<File>

setQuotaUser

public Drive.Files.Insert setQuotaUser(java.lang.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.Insert setUserIp(java.lang.String userIp)

Description copied from class: DriveRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DriveRequest<File>

getConvert

public java.lang.Boolean getConvert()

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

setConvert

public Drive.Files.Insert setConvert(java.lang.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.

getEnforceSingleParent

public java.lang.Boolean getEnforceSingleParent()

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail. [default: false]

setEnforceSingleParent

public Drive.Files.Insert setEnforceSingleParent(java.lang.Boolean enforceSingleParent)

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail.

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.

Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter will only take effect if the item is not in a shared drive. Requests that specify more than one parent will fail.

getOcr

public java.lang.Boolean getOcr()

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

setOcr

public Drive.Files.Insert setOcr(java.lang.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 java.lang.String getOcrLanguage()

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

setOcrLanguage

public Drive.Files.Insert setOcrLanguage(java.lang.String ocrLanguage)

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

getPinned

public java.lang.Boolean getPinned()

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

setPinned

public Drive.Files.Insert setPinned(java.lang.Boolean pinned)

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

getSupportsAllDrives

public java.lang.Boolean getSupportsAllDrives()

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. [default: false]

setSupportsAllDrives

public Drive.Files.Insert setSupportsAllDrives(java.lang.Boolean supportsAllDrives)

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support 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.

Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.

getSupportsTeamDrives

public java.lang.Boolean getSupportsTeamDrives()

Deprecated use supportsAllDrives instead. [default: false]

setSupportsTeamDrives

public Drive.Files.Insert setSupportsTeamDrives(java.lang.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 java.lang.String getTimedTextLanguage()

The language of the timed text.

setTimedTextLanguage

public Drive.Files.Insert setTimedTextLanguage(java.lang.String timedTextLanguage)

The language of the timed text.

getTimedTextTrackName

public java.lang.String getTimedTextTrackName()

The timed text track name.

setTimedTextTrackName

public Drive.Files.Insert setTimedTextTrackName(java.lang.String timedTextTrackName)

The timed text track name.

getUseContentAsIndexableText

public java.lang.Boolean getUseContentAsIndexableText()

Whether to use the content as indexable text. [default: false]

setUseContentAsIndexableText

public Drive.Files.Insert setUseContentAsIndexableText(java.lang.Boolean useContentAsIndexableText)

Whether to use the content as indexable text.

isUseContentAsIndexableText

public boolean isUseContentAsIndexableText()

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 use the content as indexable text.

getVisibility

public java.lang.String getVisibility()

The visibility of the new file. This parameter is only relevant when convert=false. [default: DEFAULT]

setVisibility

public Drive.Files.Insert setVisibility(java.lang.String visibility)

The visibility of the new file. This parameter is only relevant when convert=false.

set

public Drive.Files.Insert set(java.lang.String parameterName,
                              java.lang.Object value)

Overrides:

set in class DriveRequest<File>