com.google.api.services.script

Class Script.Processes.ListScriptProcesses

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<ListScriptProcessesResponse>

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

All Implemented Interfaces:

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

Enclosing class:

Script.Processes

public class Script.Processes.ListScriptProcesses
extends ScriptRequest<ListScriptProcessesResponse>

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.ListScriptProcesses() List information about a script's executed processes, 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	getScriptId() The script ID of the project whose processes are listed.
java.lang.String	getScriptProcessFilterDeploymentId() Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
java.lang.String	getScriptProcessFilterEndTime() Optional field used to limit returned processes to those that completed on or before the given timestamp.
java.lang.String	getScriptProcessFilterFunctionName() Optional field used to limit returned processes to those originating from a script function with the given function name.
java.lang.String	getScriptProcessFilterStartTime() Optional field used to limit returned processes to those that were started on or after the given timestamp.
java.util.List<java.lang.String>	getScriptProcessFilterStatuses() Optional field used to limit returned processes to those having one of the specified process statuses.
java.util.List<java.lang.String>	getScriptProcessFilterTypes() Optional field used to limit returned processes to those having one of the specified process types.
java.util.List<java.lang.String>	getScriptProcessFilterUserAccessLevels() Optional field used to limit returned processes to those having one of the specified user access levels.
Script.Processes.ListScriptProcesses	set(java.lang.String parameterName, java.lang.Object value)
Script.Processes.ListScriptProcesses	set$Xgafv(java.lang.String $Xgafv) V1 error format.
Script.Processes.ListScriptProcesses	setAccessToken(java.lang.String accessToken) OAuth access token.
Script.Processes.ListScriptProcesses	setAlt(java.lang.String alt) Data format for response.
Script.Processes.ListScriptProcesses	setBearerToken(java.lang.String bearerToken) OAuth bearer token.
Script.Processes.ListScriptProcesses	setCallback(java.lang.String callback) JSONP
Script.Processes.ListScriptProcesses	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Script.Processes.ListScriptProcesses	setKey(java.lang.String key) API key.
Script.Processes.ListScriptProcesses	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Script.Processes.ListScriptProcesses	setPageSize(java.lang.Integer pageSize) The maximum number of returned processes per page of results.
Script.Processes.ListScriptProcesses	setPageToken(java.lang.String pageToken) The token for continuing a previous list request on the next page.
Script.Processes.ListScriptProcesses	setPp(java.lang.Boolean pp) Pretty-print response.
Script.Processes.ListScriptProcesses	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Script.Processes.ListScriptProcesses	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Script.Processes.ListScriptProcesses	setScriptId(java.lang.String scriptId) The script ID of the project whose processes are listed.
Script.Processes.ListScriptProcesses	setScriptProcessFilterDeploymentId(java.lang.String scriptProcessFilterDeploymentId) Optional field used to limit returned processes to those originating from projects with a specific deployment ID.
Script.Processes.ListScriptProcesses	setScriptProcessFilterEndTime(java.lang.String scriptProcessFilterEndTime) Optional field used to limit returned processes to those that completed on or before the given timestamp.
Script.Processes.ListScriptProcesses	setScriptProcessFilterFunctionName(java.lang.String scriptProcessFilterFunctionName) Optional field used to limit returned processes to those originating from a script function with the given function name.
Script.Processes.ListScriptProcesses	setScriptProcessFilterStartTime(java.lang.String scriptProcessFilterStartTime) Optional field used to limit returned processes to those that were started on or after the given timestamp.
Script.Processes.ListScriptProcesses	setScriptProcessFilterStatuses(java.util.List<java.lang.String> scriptProcessFilterStatuses) Optional field used to limit returned processes to those having one of the specified process statuses.
Script.Processes.ListScriptProcesses	setScriptProcessFilterTypes(java.util.List<java.lang.String> scriptProcessFilterTypes) Optional field used to limit returned processes to those having one of the specified process types.
Script.Processes.ListScriptProcesses	setScriptProcessFilterUserAccessLevels(java.util.List<java.lang.String> scriptProcessFilterUserAccessLevels) Optional field used to limit returned processes to those having one of the specified user access levels.
Script.Processes.ListScriptProcesses	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
Script.Processes.ListScriptProcesses	setUploadType(java.lang.String uploadType) Legacy upload protocol for media (e.g.

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.ListScriptProcesses

protected Script.Processes.ListScriptProcesses()

List information about a script's executed processes, such as process type and current status. Create a request for the method "processes.listScriptProcesses". 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.

ListScriptProcesses#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<ListScriptProcessesResponse>

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<ListScriptProcessesResponse>

Throws:

java.io.IOException

set$Xgafv

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

Description copied from class: ScriptRequest

V1 error format.

Overrides:

set$Xgafv in class ScriptRequest<ListScriptProcessesResponse>

setAccessToken

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

Description copied from class: ScriptRequest

OAuth access token.

Overrides:

setAccessToken in class ScriptRequest<ListScriptProcessesResponse>

setAlt

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

Description copied from class: ScriptRequest

Data format for response.

Overrides:

setAlt in class ScriptRequest<ListScriptProcessesResponse>

setBearerToken

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

Description copied from class: ScriptRequest

OAuth bearer token.

Overrides:

setBearerToken in class ScriptRequest<ListScriptProcessesResponse>

setCallback

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

Description copied from class: ScriptRequest

JSONP

Overrides:

setCallback in class ScriptRequest<ListScriptProcessesResponse>

setFields

public Script.Processes.ListScriptProcesses 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<ListScriptProcessesResponse>

setKey

public Script.Processes.ListScriptProcesses 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<ListScriptProcessesResponse>

setOauthToken

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

Description copied from class: ScriptRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ScriptRequest<ListScriptProcessesResponse>

setPp

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

Description copied from class: ScriptRequest

Pretty-print response.

Overrides:

setPp in class ScriptRequest<ListScriptProcessesResponse>

setPrettyPrint

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

Description copied from class: ScriptRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ScriptRequest<ListScriptProcessesResponse>

setQuotaUser

public Script.Processes.ListScriptProcesses 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<ListScriptProcessesResponse>

setUploadType

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

Description copied from class: ScriptRequest

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

Overrides:

setUploadType in class ScriptRequest<ListScriptProcessesResponse>

setUploadProtocol

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

Description copied from class: ScriptRequest

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

Overrides:

setUploadProtocol in class ScriptRequest<ListScriptProcessesResponse>

getPageSize

public java.lang.Integer getPageSize()

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

setPageSize

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

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

getScriptProcessFilterEndTime

public java.lang.String getScriptProcessFilterEndTime()

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

setScriptProcessFilterEndTime

public Script.Processes.ListScriptProcesses setScriptProcessFilterEndTime(java.lang.String scriptProcessFilterEndTime)

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

getScriptProcessFilterUserAccessLevels

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

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

setScriptProcessFilterUserAccessLevels

public Script.Processes.ListScriptProcesses setScriptProcessFilterUserAccessLevels(java.util.List<java.lang.String> scriptProcessFilterUserAccessLevels)

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

getScriptProcessFilterStatuses

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

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

setScriptProcessFilterStatuses

public Script.Processes.ListScriptProcesses setScriptProcessFilterStatuses(java.util.List<java.lang.String> scriptProcessFilterStatuses)

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

getScriptProcessFilterFunctionName

public java.lang.String getScriptProcessFilterFunctionName()

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

setScriptProcessFilterFunctionName

public Script.Processes.ListScriptProcesses setScriptProcessFilterFunctionName(java.lang.String scriptProcessFilterFunctionName)

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

getScriptProcessFilterStartTime

public java.lang.String getScriptProcessFilterStartTime()

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

setScriptProcessFilterStartTime

public Script.Processes.ListScriptProcesses setScriptProcessFilterStartTime(java.lang.String scriptProcessFilterStartTime)

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

getScriptProcessFilterTypes

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

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

setScriptProcessFilterTypes

public Script.Processes.ListScriptProcesses setScriptProcessFilterTypes(java.util.List<java.lang.String> scriptProcessFilterTypes)

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

getScriptId

public java.lang.String getScriptId()

The script ID of the project whose processes are listed.

setScriptId

public Script.Processes.ListScriptProcesses setScriptId(java.lang.String scriptId)

The script ID of the project whose processes are listed.

getScriptProcessFilterDeploymentId

public java.lang.String getScriptProcessFilterDeploymentId()

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

setScriptProcessFilterDeploymentId

public Script.Processes.ListScriptProcesses setScriptProcessFilterDeploymentId(java.lang.String scriptProcessFilterDeploymentId)

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

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.ListScriptProcesses 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.

set

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

Overrides:

set in class ScriptRequest<ListScriptProcessesResponse>