com.google.api.services.script

Class Script.Projects.GetMetrics

java.lang.Object

java.util.AbstractMap<String,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<Metrics>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Script.Projects

public class Script.Projects.GetMetrics
extends ScriptRequest<Metrics>

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

Modifier	Constructor and Description
protected	Script.Projects.GetMetrics(String scriptId) Get metrics data for scripts, such as number of executions and active users.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getMetricsFilterDeploymentId() Optional field indicating a specific deployment to retrieve metrics from.
String	getMetricsGranularity() Required field indicating what granularity of metrics are returned.
String	getScriptId() Required field indicating the script to get metrics for.
Script.Projects.GetMetrics	set(String parameterName, Object value)
Script.Projects.GetMetrics	set$Xgafv(String $Xgafv) V1 error format.
Script.Projects.GetMetrics	setAccessToken(String accessToken) OAuth access token.
Script.Projects.GetMetrics	setAlt(String alt) Data format for response.
Script.Projects.GetMetrics	setBearerToken(String bearerToken) OAuth bearer token.
Script.Projects.GetMetrics	setCallback(String callback) JSONP
Script.Projects.GetMetrics	setFields(String fields) Selector specifying which fields to include in a partial response.
Script.Projects.GetMetrics	setKey(String key) API key.
Script.Projects.GetMetrics	setMetricsFilterDeploymentId(String metricsFilterDeploymentId) Optional field indicating a specific deployment to retrieve metrics from.
Script.Projects.GetMetrics	setMetricsGranularity(String metricsGranularity) Required field indicating what granularity of metrics are returned.
Script.Projects.GetMetrics	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Script.Projects.GetMetrics	setPp(Boolean pp) Pretty-print response.
Script.Projects.GetMetrics	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Script.Projects.GetMetrics	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Script.Projects.GetMetrics	setScriptId(String scriptId) Required field indicating the script to get metrics for.
Script.Projects.GetMetrics	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Script.Projects.GetMetrics	setUploadType(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.Projects.GetMetrics

protected Script.Projects.GetMetrics(String scriptId)

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

Parameters:

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

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<Metrics>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Metrics>

Throws:

IOException

set$Xgafv

public Script.Projects.GetMetrics set$Xgafv(String $Xgafv)

Description copied from class: ScriptRequest

V1 error format.

Overrides:

set$Xgafv in class ScriptRequest<Metrics>

setAccessToken

public Script.Projects.GetMetrics setAccessToken(String accessToken)

Description copied from class: ScriptRequest

OAuth access token.

Overrides:

setAccessToken in class ScriptRequest<Metrics>

setAlt

public Script.Projects.GetMetrics setAlt(String alt)

Description copied from class: ScriptRequest

Data format for response.

Overrides:

setAlt in class ScriptRequest<Metrics>

setBearerToken

public Script.Projects.GetMetrics setBearerToken(String bearerToken)

Description copied from class: ScriptRequest

OAuth bearer token.

Overrides:

setBearerToken in class ScriptRequest<Metrics>

setCallback

public Script.Projects.GetMetrics setCallback(String callback)

Description copied from class: ScriptRequest

JSONP

Overrides:

setCallback in class ScriptRequest<Metrics>

setFields

public Script.Projects.GetMetrics setFields(String fields)

Description copied from class: ScriptRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class ScriptRequest<Metrics>

setKey

public Script.Projects.GetMetrics setKey(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<Metrics>

setOauthToken

public Script.Projects.GetMetrics setOauthToken(String oauthToken)

Description copied from class: ScriptRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class ScriptRequest<Metrics>

setPp

public Script.Projects.GetMetrics setPp(Boolean pp)

Description copied from class: ScriptRequest

Pretty-print response.

Overrides:

setPp in class ScriptRequest<Metrics>

setPrettyPrint

public Script.Projects.GetMetrics setPrettyPrint(Boolean prettyPrint)

Description copied from class: ScriptRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class ScriptRequest<Metrics>

setQuotaUser

public Script.Projects.GetMetrics setQuotaUser(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<Metrics>

setUploadType

public Script.Projects.GetMetrics setUploadType(String uploadType)

Description copied from class: ScriptRequest

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

Overrides:

setUploadType in class ScriptRequest<Metrics>

setUploadProtocol

public Script.Projects.GetMetrics setUploadProtocol(String uploadProtocol)

Description copied from class: ScriptRequest

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

Overrides:

setUploadProtocol in class ScriptRequest<Metrics>

getScriptId

public String getScriptId()

Required field indicating the script to get metrics for.

setScriptId

public Script.Projects.GetMetrics setScriptId(String scriptId)

Required field indicating the script to get metrics for.

getMetricsFilterDeploymentId

public String getMetricsFilterDeploymentId()

Optional field indicating a specific deployment to retrieve metrics from.

setMetricsFilterDeploymentId

public Script.Projects.GetMetrics setMetricsFilterDeploymentId(String metricsFilterDeploymentId)

Optional field indicating a specific deployment to retrieve metrics from.

getMetricsGranularity

public String getMetricsGranularity()

Required field indicating what granularity of metrics are returned.

setMetricsGranularity

public Script.Projects.GetMetrics setMetricsGranularity(String metricsGranularity)

Required field indicating what granularity of metrics are returned.

set

public Script.Projects.GetMetrics set(String parameterName,
                             Object value)

Overrides:

set in class ScriptRequest<Metrics>