com.google.api.services.script.model

Class File

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.script.model.File

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class File
extends GenericJson

An individual file within a script project. A file is a third-party source code created by one or more developers. It can be a server-side JS code, HTML, or a configuration file. Each script project can contain multiple files.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Apps Script API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
File()

Method Summary

Methods

Modifier and Type	Method and Description
File	clone()
String	getCreateTime() Creation date timestamp.
GoogleAppsScriptTypeFunctionSet	getFunctionSet() The defined set of functions in the script file, if any.
GoogleAppsScriptTypeUser	getLastModifyUser() The user who modified the file most recently.
String	getName() The name of the file.
String	getSource() The file content.
String	getType() The type of the file.
String	getUpdateTime() Last modified date timestamp.
File	set(String fieldName, Object value)
File	setCreateTime(String createTime) Creation date timestamp.
File	setFunctionSet(GoogleAppsScriptTypeFunctionSet functionSet) The defined set of functions in the script file, if any.
File	setLastModifyUser(GoogleAppsScriptTypeUser lastModifyUser) The user who modified the file most recently.
File	setName(String name) The name of the file.
File	setSource(String source) The file content.
File	setType(String type) The type of the file.
File	setUpdateTime(String updateTime) Last modified date timestamp.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

File

public File()

Method Detail

getCreateTime

public String getCreateTime()

Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

Returns:

value or null for none

setCreateTime

public File setCreateTime(String createTime)

Creation date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

Parameters:

createTime - createTime or null for none

getFunctionSet

public GoogleAppsScriptTypeFunctionSet getFunctionSet()

The defined set of functions in the script file, if any.

Returns:

value or null for none

setFunctionSet

public File setFunctionSet(GoogleAppsScriptTypeFunctionSet functionSet)

The defined set of functions in the script file, if any.

Parameters:

functionSet - functionSet or null for none

getLastModifyUser

public GoogleAppsScriptTypeUser getLastModifyUser()

The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project.

Returns:

value or null for none

setLastModifyUser

public File setLastModifyUser(GoogleAppsScriptTypeUser lastModifyUser)

The user who modified the file most recently. This read-only field is only visible to users who have WRITER permission for the script project.

Parameters:

lastModifyUser - lastModifyUser or null for none

getName

public String getName()

The name of the file. The file extension is not part of the file name, which can be identified from the type field.

Returns:

value or null for none

setName

public File setName(String name)

The name of the file. The file extension is not part of the file name, which can be identified from the type field.

Parameters:

name - name or null for none

getSource

public String getSource()

The file content.

Returns:

value or null for none

setSource

public File setSource(String source)

The file content.

Parameters:

source - source or null for none

getType

public String getType()

The type of the file.

Returns:

value or null for none

setType

public File setType(String type)

The type of the file.

Parameters:

type - type or null for none

getUpdateTime

public String getUpdateTime()

Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

Returns:

value or null for none

setUpdateTime

public File setUpdateTime(String updateTime)

Last modified date timestamp. This read-only field is only visible to users who have WRITER permission for the script project.

Parameters:

updateTime - updateTime or null for none

set

public File set(String fieldName,
       Object value)

Overrides:

set in class GenericJson

clone

public File clone()

Overrides:

clone in class GenericJson