GPMessage

AMD: require(["esri/rest/support/GPMessage"], (GPMessage) => { /* code goes here */ });
ESM: import GPMessage from "@arcgis/core/rest/support/GPMessage";
Class: esri/rest/support/GPMessage
Inheritance: GPMessage Accessor
Since: ArcGIS API for JavaScript 4.20

Represents a message generated during the execution of a esri/rest/Geoprocessor method. It includes information such as when the processing started, what parameter values are being used, the task progress, and warnings of potential problems and errors. It is composed of a message type and description.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The geoprocessing message.

more detailsGPMessage
Stringmore details

The geoprocessing message type.

more detailsGPMessage

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

description String

The geoprocessing message.

type String

The geoprocessing message type.

Possible Values:"informative"|"process-definition"|"process-start"|"process-stop"|"warning"|"error"|"empty"|"abort"

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsGPMessage
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsGPMessage

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.