com.google.api.services.script.model

Class Status

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.script.model.Status

All Implemented Interfaces:

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

public final class Status
extends com.google.api.client.json.GenericJson

If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.

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 Apps Script API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
Status()

Method Summary

Methods

Modifier and Type	Method and Description
Status	clone()
java.lang.Integer	getCode() The status code.
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getDetails() An array that contains a single ExecutionError object that provides information about the nature of the error.
java.lang.String	getMessage() A developer-facing error message, which is in English.
Status	set(java.lang.String fieldName, java.lang.Object value)
Status	setCode(java.lang.Integer code) The status code.
Status	setDetails(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> details) An array that contains a single ExecutionError object that provides information about the nature of the error.
Status	setMessage(java.lang.String message) A developer-facing error message, which is in English.

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

Status

public Status()

Method Detail

getCode

public java.lang.Integer getCode()

The status code. For this API, this value either: 10, indicating a `SCRIPT_TIMEOUT` error, 3, indicating an `INVALID_ARGUMENT` error, or 1, indicating a `CANCELLED` execution.

Returns:

value or null for none

setCode

public Status setCode(java.lang.Integer code)

The status code. For this API, this value either: 10, indicating a `SCRIPT_TIMEOUT` error, 3, indicating an `INVALID_ARGUMENT` error, or 1, indicating a `CANCELLED` execution.

Parameters:

code - code or null for none

getDetails

public java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getDetails()

An array that contains a single ExecutionError object that provides information about the nature of the error.

Returns:

value or null for none

setDetails

public Status setDetails(java.util.List<java.util.Map<java.lang.String,java.lang.Object>> details)

An array that contains a single ExecutionError object that provides information about the nature of the error.

Parameters:

details - details or null for none

getMessage

public java.lang.String getMessage()

A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [google.rpc.Status.details](google.rpc.Status.details) field, or localized by the client.

Returns:

value or null for none

setMessage

public Status setMessage(java.lang.String message)

A developer-facing error message, which is in English. Any user-facing error message is localized and sent in the [google.rpc.Status.details](google.rpc.Status.details) field, or localized by the client.

Parameters:

message - message or null for none

set

public Status set(java.lang.String fieldName,
         java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Status clone()

Overrides:

clone in class com.google.api.client.json.GenericJson