com.google.api.services.script

Class Script.Processes.List

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.script.ScriptRequest<ListUserProcessesResponse>

com.google.api.services.script.Script.Processes.List

All Implemented Interfaces:

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

Enclosing class:

Script.Processes

public class Script.Processes.List
extends ScriptRequest<ListUserProcessesResponse>

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	Script.Processes.List() List information about processes made by or on behalf of a user, such as process type and current status.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.Integer	getPageSize() The maximum number of returned processes per page of results.
java.lang.String	getPageToken() The token for continuing a previous list request on the next page.
java.lang.String	getUserProcessFilterDeploymentId() Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
java.lang.String	getUserProcessFilterEndTime() Optional field used to limit returned processes to those that completed on or before the given timestamp.
java.lang.String	getUserProcessFilterFunctionName() Optional field used to limit returned processes to those originating from a script function with the given function name.
java.lang.String	getUserProcessFilterProjectName() Optional field used to limit returned processes to those originating from projects with a specific project name.
java.lang.String	getUserProcessFilterScriptId() Optional field used to limit returned processes to those originating from projects with a specific script ID.
java.lang.String	getUserProcessFilterStartTime() Optional field used to limit returned processes to those that were started on or after the given timestamp.
java.util.List<java.lang.String>	getUserProcessFilterStatuses() Optional field used to limit returned processes to those having one of the specified process statuses.
java.util.List<java.lang.String>	getUserProcessFilterTypes() Optional field used to limit returned processes to those having one of the specified process types.
java.util.List<java.lang.String>	getUserProcessFilterUserAccessLevels() Optional field used to limit returned processes to those having one of the specified user access levels.
Script.Processes.List	set(java.lang.String parameterName, java.lang.Object value)
Script.Processes.List	set$Xgafv(java.lang.String $Xgafv) V1 error format.
Script.Processes.List	setAccessToken(java.lang.String accessToken) OAuth access token.
Script.Processes.List	setAlt(java.lang.String alt) Data format for response.
Script.Processes.List	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
Script.Processes.List	setCallback(java.lang.String callback) JSONP
Script.Processes.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Script.Processes.List	setKey(java.lang.String key) API key.
Script.Processes.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Script.Processes.List	setPageSize(java.lang.Integer pageSize) The maximum number of returned processes per page of results.
Script.Processes.List	setPageToken(java.lang.String pageToken) The token for continuing a previous list request on the next page.
Script.Processes.List	setPp(java.lang.Boolean pp) Pretty-print response.
Script.Processes.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Script.Processes.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Script.Processes.List	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
Script.Processes.List	setUploadType(java.lang.String uploadType) Legacy upload protocol for media (e.g.
Script.Processes.List	setUserProcessFilterDeploymentId(java.lang.String userProcessFilterDeploymentId) Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
Script.Processes.List	setUserProcessFilterEndTime(java.lang.String userProcessFilterEndTime) Optional field used to limit returned processes to those that completed on or before the given timestamp.
Script.Processes.List	setUserProcessFilterFunctionName(java.lang.String userProcessFilterFunctionName) Optional field used to limit returned processes to those originating from a script function with the given function name.
Script.Processes.List	setUserProcessFilterProjectName(java.lang.String userProcessFilterProjectName) Optional field used to limit returned processes to those originating from projects with a specific project name.
Script.Processes.List	setUserProcessFilterScriptId(java.lang.String userProcessFilterScriptId) Optional field used to limit returned processes to those originating from projects with a specific script ID.
Script.Processes.List	setUserProcessFilterStartTime(java.lang.String userProcessFilterStartTime) Optional field used to limit returned processes to those that were started on or after the given timestamp.
Script.Processes.List	setUserProcessFilterStatuses(java.util.List<java.lang.String> userProcessFilterStatuses) Optional field used to limit returned processes to those having one of the specified process statuses.
Script.Processes.List	setUserProcessFilterTypes(java.util.List<java.lang.String> userProcessFilterTypes) Optional field used to limit returned processes to those having one of the specified process types.
Script.Processes.List	setUserProcessFilterUserAccessLevels(java.util.List<java.lang.String> userProcessFilterUserAccessLevels) Optional field used to limit returned processes to those having one of the specified user access levels.

Methods inherited from class com.google.api.services.script.ScriptRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getBearerToken, getCallback, getFields, getKey, getOauthToken, getPp, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

Constructor Detail

Script.Processes.List

protected Script.Processes.List()

List information about processes made by or on behalf of a user, such as process type and current status. Create a request for the method "processes.list". This request holds the parameters needed by the the script server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListUserProcessesResponse>

Throws:

java.io.IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListUserProcessesResponse>

Throws:

java.io.IOException

set$Xgafv

public Script.Processes.List set$Xgafv(java.lang.String $Xgafv)

Description copied from class: ScriptRequest

V1 error format.

Overrides:

set$Xgafv in class ScriptRequest<ListUserProcessesResponse>

setAccessToken

public Script.Processes.List setAccessToken(java.lang.String accessToken)

Description copied from class: ScriptRequest

OAuth access token.

Overrides:

setAccessToken in class ScriptRequest<ListUserProcessesResponse>

setAlt

public Script.Processes.List setAlt(java.lang.String alt)

Description copied from class: ScriptRequest

Data format for response.

Overrides:

setAlt in class ScriptRequest<ListUserProcessesResponse>

setBearerToken

public Script.Processes.List setBearerToken(java.lang.String bearerToken)

Description copied from class: ScriptRequest

OAuth bearer token.

Overrides:

setBearerToken in class ScriptRequest<ListUserProcessesResponse>

setCallback

public Script.Processes.List setCallback(java.lang.String callback)

Description copied from class: ScriptRequest

JSONP

Overrides:

setCallback in class ScriptRequest<ListUserProcessesResponse>

setFields

public Script.Processes.List setFields(java.lang.String fields)

Description copied from class: ScriptRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ScriptRequest<ListUserProcessesResponse>

setKey

public Script.Processes.List setKey(java.lang.String key)

Description copied from class: ScriptRequest

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 ScriptRequest<ListUserProcessesResponse>

setOauthToken

public Script.Processes.List setOauthToken(java.lang.String oauthToken)

Description copied from class: ScriptRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ScriptRequest<ListUserProcessesResponse>

setPp

public Script.Processes.List setPp(java.lang.Boolean pp)

Description copied from class: ScriptRequest

Pretty-print response.

Overrides:

setPp in class ScriptRequest<ListUserProcessesResponse>

setPrettyPrint

public Script.Processes.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: ScriptRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ScriptRequest<ListUserProcessesResponse>

setQuotaUser

public Script.Processes.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: ScriptRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class ScriptRequest<ListUserProcessesResponse>

setUploadType

public Script.Processes.List setUploadType(java.lang.String uploadType)

Description copied from class: ScriptRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class ScriptRequest<ListUserProcessesResponse>

setUploadProtocol

public Script.Processes.List setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: ScriptRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class ScriptRequest<ListUserProcessesResponse>

getUserProcessFilterFunctionName

public java.lang.String getUserProcessFilterFunctionName()

Optional field used to limit returned processes to those originating from a script function with the given function name.

setUserProcessFilterFunctionName

public Script.Processes.List setUserProcessFilterFunctionName(java.lang.String userProcessFilterFunctionName)

Optional field used to limit returned processes to those originating from a script function with the given function name.

getUserProcessFilterScriptId

public java.lang.String getUserProcessFilterScriptId()

Optional field used to limit returned processes to those originating from projects with a specific script ID.

setUserProcessFilterScriptId

public Script.Processes.List setUserProcessFilterScriptId(java.lang.String userProcessFilterScriptId)

Optional field used to limit returned processes to those originating from projects with a specific script ID.

getUserProcessFilterStatuses

public java.util.List<java.lang.String> getUserProcessFilterStatuses()

Optional field used to limit returned processes to those having one of the specified process statuses.

setUserProcessFilterStatuses

public Script.Processes.List setUserProcessFilterStatuses(java.util.List<java.lang.String> userProcessFilterStatuses)

Optional field used to limit returned processes to those having one of the specified process statuses.

getUserProcessFilterTypes

public java.util.List<java.lang.String> getUserProcessFilterTypes()

Optional field used to limit returned processes to those having one of the specified process types.

setUserProcessFilterTypes

public Script.Processes.List setUserProcessFilterTypes(java.util.List<java.lang.String> userProcessFilterTypes)

Optional field used to limit returned processes to those having one of the specified process types.

getUserProcessFilterDeploymentId

public java.lang.String getUserProcessFilterDeploymentId()

Optional field used to limit returned processes to those originating from projects with a specific deployment ID.

setUserProcessFilterDeploymentId

public Script.Processes.List setUserProcessFilterDeploymentId(java.lang.String userProcessFilterDeploymentId)

Optional field used to limit returned processes to those originating from projects with a specific deployment ID.

getUserProcessFilterEndTime

public java.lang.String getUserProcessFilterEndTime()

Optional field used to limit returned processes to those that completed on or before the given timestamp.

setUserProcessFilterEndTime

public Script.Processes.List setUserProcessFilterEndTime(java.lang.String userProcessFilterEndTime)

Optional field used to limit returned processes to those that completed on or before the given timestamp.

getPageToken

public java.lang.String getPageToken()

The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.

setPageToken

public Script.Processes.List setPageToken(java.lang.String pageToken)

The token for continuing a previous list request on the next page. This should be set to the value of `nextPageToken` from a previous response.

getPageSize

public java.lang.Integer getPageSize()

The maximum number of returned processes per page of results. Defaults to 50.

setPageSize

public Script.Processes.List setPageSize(java.lang.Integer pageSize)

The maximum number of returned processes per page of results. Defaults to 50.

getUserProcessFilterStartTime

public java.lang.String getUserProcessFilterStartTime()

Optional field used to limit returned processes to those that were started on or after the given timestamp.

setUserProcessFilterStartTime

public Script.Processes.List setUserProcessFilterStartTime(java.lang.String userProcessFilterStartTime)

Optional field used to limit returned processes to those that were started on or after the given timestamp.

getUserProcessFilterProjectName

public java.lang.String getUserProcessFilterProjectName()

Optional field used to limit returned processes to those originating from projects with a specific project name.

setUserProcessFilterProjectName

public Script.Processes.List setUserProcessFilterProjectName(java.lang.String userProcessFilterProjectName)

Optional field used to limit returned processes to those originating from projects with a specific project name.

getUserProcessFilterUserAccessLevels

public java.util.List<java.lang.String> getUserProcessFilterUserAccessLevels()

Optional field used to limit returned processes to those having one of the specified user access levels.

setUserProcessFilterUserAccessLevels

public Script.Processes.List setUserProcessFilterUserAccessLevels(java.util.List<java.lang.String> userProcessFilterUserAccessLevels)

Optional field used to limit returned processes to those having one of the specified user access levels.

set

public Script.Processes.List set(java.lang.String parameterName,
                        java.lang.Object value)

Overrides:

set in class ScriptRequest<ListUserProcessesResponse>