com.google.api.services.drive

Class Drive.Files

java.lang.Object

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

Enclosing class:

Drive

public class Drive.Files
extends Object

The "files" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Drive.Files.Copy
class	Drive.Files.Create
class	Drive.Files.Delete
class	Drive.Files.EmptyTrash
class	Drive.Files.Export
class	Drive.Files.GenerateIds
class	Drive.Files.Get
class	Drive.Files.List
class	Drive.Files.Update
class	Drive.Files.Watch

Constructor Summary

Constructors

Constructor and Description
Files()

Method Summary

Modifier and Type	Method and Description
Drive.Files.Copy	copy(String fileId, File content) Creates a copy of a file and applies any requested updates with patch semantics.
Drive.Files.Create	create(File content) Creates a new file.
Drive.Files.Create	create(File content, AbstractInputStreamContent mediaContent) Creates a new file.
Drive.Files.Delete	delete(String fileId) Permanently deletes a file owned by the user without moving it to the trash.
Drive.Files.EmptyTrash	emptyTrash() Permanently deletes all of the user's trashed files.
Drive.Files.Export	export(String fileId, String mimeType) Exports a Google Doc to the requested MIME type and returns the exported content.
Drive.Files.GenerateIds	generateIds() Generates a set of file IDs which can be provided in create or copy requests.
Drive.Files.Get	get(String fileId) Gets a file's metadata or content by ID.
Drive.Files.List	list() Lists or searches files.
Drive.Files.Update	update(String fileId, File content) Updates a file's metadata and/or content.
Drive.Files.Update	update(String fileId, File content, AbstractInputStreamContent mediaContent) Updates a file's metadata and/or content.
Drive.Files.Watch	watch(String fileId, Channel content) Subscribes to changes to a file Create a request for the method "files.watch".

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Files

public Files()

Method Detail

copy

public Drive.Files.Copy copy(String fileId,
                             File content)
                      throws IOException

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

Parameters:

fileId - The ID of the file.

content - the File

Returns:

the request

Throws:

IOException

create

public Drive.Files.Create create(File content)
                          throws IOException

Creates a new file. Create a request for the method "files.create". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the File

Returns:

the request

Throws:

IOException

create

public Drive.Files.Create create(File content,
                                 AbstractInputStreamContent mediaContent)
                          throws IOException

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

This method 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.

Returns:

the request

Throws:

IOException - if the initialization of the request fails

delete

public Drive.Files.Delete delete(String fileId)
                          throws IOException

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted. Create a request for the method "files.delete". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - The ID of the file.

Returns:

the request

Throws:

IOException

emptyTrash

public Drive.Files.EmptyTrash emptyTrash()
                                  throws IOException

Permanently deletes all of the user's trashed files. Create a request for the method "files.emptyTrash". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

export

public Drive.Files.Export export(String fileId,
                                 String mimeType)
                          throws IOException

Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. Create a request for the method "files.export". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - The ID of the file.

mimeType - The MIME type of the format requested for this export.

Returns:

the request

Throws:

IOException

generateIds

public Drive.Files.GenerateIds generateIds()
                                    throws IOException

Generates a set of file IDs which can be provided in create or copy requests. Create a request for the method "files.generateIds". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

get

public Drive.Files.Get get(String fileId)
                    throws IOException

Gets a file's metadata or content by ID. Create a request for the method "files.get". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - The ID of the file.

Returns:

the request

Throws:

IOException

list

public Drive.Files.List list()
                      throws IOException

Lists or searches files. Create a request for the method "files.list". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException

update

public Drive.Files.Update update(String fileId,
                                 File content)
                          throws IOException

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics. Create a request for the method "files.update". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - The ID of the file.

content - the File

Returns:

the request

Throws:

IOException

update

public Drive.Files.Update update(String fileId,
                                 File content,
                                 AbstractInputStreamContent mediaContent)
                          throws IOException

Updates a file's metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics. Create a request for the method "files.update". 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.

This method should be used for uploading media content.

Parameters:

fileId - The ID of the file.

content - the File media metadata or null if none

mediaContent - The media HTTP content or null if none.

Returns:

the request

Throws:

IOException - if the initialization of the request fails

watch

public Drive.Files.Watch watch(String fileId,
                               Channel content)
                        throws IOException

Subscribes to changes to a file Create a request for the method "files.watch". This request holds the parameters needed by the drive server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

fileId - The ID of the file.

content - the Channel

Returns:

the request

Throws:

IOException