Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.tasks.geoprocessing

Class GeoprocessingParameters

java.lang.Object
com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingParameters
public final class GeoprocessingParameters extends Object

Geoprocessing parameters contains input parameters that are sent to the target geoprocessing task.

GeoprocessingParameters contains both input parameters and environment variables that are used in the target geoprocessing task. At a minimum all parameters that are set as required on the published task must to be provided to run the task successfully. Parameters that have default values can be overridden by providing a new value in the inputs map. Optional parameters can be provided the same way.

Since:
100.0.0

  • Constructor Details

  • Method Details

    • getInputs

      public Map<String,GeoprocessingParameter> getInputs()
      Returns a map of name to value of inputs. Use this collection to modify the parameters that are sent to a geoprocessing task when it is run.
      Returns:
      the inputs map
      Since:
      100.0.0

    • setOutputSpatialReference

      public void setOutputSpatialReference(SpatialReference spatialReference)
      Sets the output spatial reference.
      Parameters:
      spatialReference - the spatial reference to set
      Throws:
      IllegalArgumentException - if spatial reference is null
      Since:
      100.0.0

    • getOutputSpatialReference

      public SpatialReference getOutputSpatialReference()
      Returns the output spatial reference.
      Returns:
      the spatial reference
      Since:
      100.0.0

    • setProcessSpatialReference

      public void setProcessSpatialReference(SpatialReference spatialReference)
      Sets the process spatial reference.
      Parameters:
      spatialReference - the spatial reference to set
      Throws:
      IllegalArgumentException - if spatial reference is null
      Since:
      100.0.0

    • getProcessSpatialReference

      public SpatialReference getProcessSpatialReference()
      Returns the process spatial reference.
      Returns:
      the spatial reference
      Since:
      100.0.0

    • setReturnM

      public void setReturnM(boolean returnM)
      Sets if M values are to be returned.
      Parameters:
      returnM - true, to enable
      Since:
      100.0.0

    • getReturnM

      public boolean getReturnM()
      Returns true if M value are to be returned.
      Returns:
      true, if M values are enabled
      Since:
      100.0.0

    • setReturnZ

      public void setReturnZ(boolean returnZ)
      Sets if z values are to be returned.
      Parameters:
      returnZ - true, to enable
      Since:
      100.0.0

    • getReturnZ

      public boolean getReturnZ()
      Returns true if z value are to be returned.
      Returns:
      true, if z values are enabled
      Since:
      100.0.0

    • getExecutionType

      public GeoprocessingParameters.ExecutionType getExecutionType()
      Returns the execution type for this parameters object.
      Returns:
      the execution type