com.google.api.services.script

Class Script.Projects

java.lang.Object

com.google.api.services.script.Script.Projects

Enclosing class:

Script

public class Script.Projects
extends Object

The "projects" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Script.Projects.Create
class	Script.Projects.Deployments The "deployments" collection of methods.
class	Script.Projects.Get
class	Script.Projects.GetContent
class	Script.Projects.GetMetrics
class	Script.Projects.UpdateContent
class	Script.Projects.Versions The "versions" collection of methods.

Constructor Summary

Constructors

Constructor and Description
Projects()

Method Summary

Modifier and Type	Method and Description
Script.Projects.Create	create(CreateProjectRequest content) Creates a new, empty script project with no script files and a base manifest file.
Script.Projects.Deployments	deployments() An accessor for creating requests from the Deployments collection.
Script.Projects.Get	get(String scriptId) Gets a script project's metadata.
Script.Projects.GetContent	getContent(String scriptId) Gets the content of the script project, including the code source and metadata for each script file.
Script.Projects.GetMetrics	getMetrics(String scriptId) Get metrics data for scripts, such as number of executions and active users.
Script.Projects.UpdateContent	updateContent(String scriptId, Content content) Updates the content of the specified script project.
Script.Projects.Versions	versions() An accessor for creating requests from the Versions collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Projects

public Projects()

Method Detail

create

public Script.Projects.Create create(CreateProjectRequest content)
                              throws IOException

Creates a new, empty script project with no script files and a base manifest file. Create a request for the method "projects.create". This request holds the parameters needed by the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

content - the CreateProjectRequest

Returns:

the request

Throws:

IOException

get

public Script.Projects.Get get(String scriptId)
                        throws IOException

Gets a script project's metadata. Create a request for the method "projects.get". This request holds the parameters needed by the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

scriptId - The script project's Drive ID.

Returns:

the request

Throws:

IOException

getContent

public Script.Projects.GetContent getContent(String scriptId)
                                      throws IOException

Gets the content of the script project, including the code source and metadata for each script file. Create a request for the method "projects.getContent". This request holds the parameters needed by the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

scriptId - The script project's Drive ID.

Returns:

the request

Throws:

IOException

getMetrics

public Script.Projects.GetMetrics getMetrics(String scriptId)
                                      throws IOException

Get metrics data for scripts, such as number of executions and active users. Create a request for the method "projects.getMetrics". This request holds the parameters needed by the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

scriptId - Required field indicating the script to get metrics for.

Returns:

the request

Throws:

IOException

updateContent

public Script.Projects.UpdateContent updateContent(String scriptId,
                                                   Content content)
                                            throws IOException

Updates the content of the specified script project. This content is stored as the HEAD version, and is used when the script is executed as a trigger, in the script editor, in add-on preview mode, or as a web app or Apps Script API in development mode. This clears all the existing files in the project. Create a request for the method "projects.updateContent". This request holds the parameters needed by the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

scriptId - The script project's Drive ID.

content - the Content

Returns:

the request

Throws:

IOException

deployments

public Script.Projects.Deployments deployments()

An accessor for creating requests from the Deployments collection.

The typical use is:

    Script script = new Script(...);
    Script.Deployments.List request = script.deployments().list(parameters ...)
 

Returns:

the resource collection

versions

public Script.Projects.Versions versions()

An accessor for creating requests from the Versions collection.

The typical use is:

    Script script = new Script(...);
    Script.Versions.List request = script.versions().list(parameters ...)
 

Returns:

the resource collection