public class

GPMessage

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.ags.geoprocessing.GPMessage

Class Overview

This class represents messages generated during the execution of a geoprocessing task. They include information such as when the task started, what parameter values are being used, the progress of the task, warnings of potential problems, and errors. The messages returned by the server depends on the message level of the geoprocessing service. If the message level is set to None, the server will not return any messages.

Summary

Public Constructors
GPMessage()
Public Methods
static GPMessage fromJson(JsonParser parser)
Static method generating a GPMessage array based on the GPMessage Json representation the Json Parser is pointing to.
String getDescription()
Gets the description.
String getType()
Gets the message type.
void setDescription(String description)
Sets the description.
void setType(String type)
Sets the message type.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GPMessage ()

Public Methods

public static GPMessage fromJson (JsonParser parser)

Static method generating a GPMessage array based on the GPMessage Json representation the Json Parser is pointing to.

Parameters
parser JsonParser: a Json parser pointing to a Json representation of a GPMessage object.
Returns
GPMessage a GPMessage
Throws
Exception when the Json cannot be parsed.

public String getDescription ()

Gets the description. Note that the level of detail in the error response depends on the message level of the geoprocessing service.

Returns
String the description

public String getType ()

Gets the message type. For example, esriJobMessageTypeInformative, esriJobMessageTypeWarning, or esriJobMessageTypeError.

Returns
String the type

public void setDescription (String description)

Sets the description.

Parameters
description String: the description to set

public void setType (String type)

Sets the message type. For example, esriJobMessageTypeInformative, esriJobMessageTypeWarning, or esriJobMessageTypeError.

Parameters
type String: the type to set