Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.portal

Class HelperServices

java.lang.Object

com.esri.arcgisruntime.portal.HelperServices

All Implemented Interfaces:

JsonSerializable

public final class HelperServices
extends Object
implements JsonSerializable

Container for helper services that are provided by the portal. Objects of this class are provided by PortalInfo.getHelperServices().

For detailed information about these services, see the "Services from Esri" topic within the ArcGIS REST API documentation.

Since:

100.0.0

Method Summary

Modifier and Type	Method	Description
static HelperServices	fromJson(String json)	Creates a HelperServices instance from a JSON string.
String	getAnalysisService()	Gets the URL of hosted GP services that perform analyses.
String	getAsyncClosestFacilityService()	Gets the URL of the asynchronous closest facility service.
String	getAsyncElevationService()	Gets the URL of the asynchronous elevation analysis services.
String	getAsyncLocationAllocationService()	Gets the URL of the asynchronous location-allocation service.
String	getAsyncODCostMatrixService()	Gets the URL of the ArcGIS geoprocessing service for generating origin-destination cost matrices asynchronously.
String	getAsyncRouteService()	Gets the URL of the asynchronous route service.
String	getAsyncServiceAreaService()	Gets the URL of the asynchronous service-area service.
String	getAsyncVrpService()	Gets the URL of the asynchronous vehicle routing problem service.
List<ElevationServiceInfo>	getDefaultElevationServices()	Gets information about Limited Error Raster Compression (LERC) elevation services used by ArcGIS Pro and the Web Scene Viewer.
List<GeocodeServiceInfo>	getGeocodeServices()	Gets the geocode services.
String	getGeoenrichmentService()	Gets the URL of the geoenrichment service.
String	getGeometryService()	Gets the URL of the geometry service.
String	getHydrologyService()	Gets the URL of the hydrologic analysis services.
String	getLocationTrackingService()	Gets the URL of the location tracking service.
String	getPrintService()	Gets the URL of the print service.
String	getSyncClosestFacilityService()	Gets the URL of the synchronous closest facility service.
String	getSyncElevationService()	Gets the URL of the synchronous elevation analysis services.
String	getSyncRouteService()	Gets the URL of the synchronous route service.
String	getSyncServiceAreaService()	Gets the URL of the synchronous service-area service.
String	getSyncVrpService()	Gets the URL of the synchronous vehicle routing problem service.
String	getTrafficService()	Gets the URL of the traffic service.
Map<String,Object>	getUnknownJson()	Gets unknown data from the source JSON.
Map<String,Object>	getUnsupportedJson()	Gets unsupported data from the source JSON.
String	toJson()	Serializes this object to a JSON string.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

fromJson

public static HelperServices fromJson(String json)

Creates a HelperServices instance from a JSON string.

Parameters:

json - a JSON string that represents a HelperServices

Returns:

a HelperServices instance

Throws:

IllegalArgumentException - if json is null or empty

Since:

100.8.0

toJson

public String toJson()

Description copied from interface: JsonSerializable

Serializes this object to a JSON string. Note that unknown JSON is omitted from the serialized string.

Specified by:

toJson in interface JsonSerializable

Returns:

a JSON string

getUnknownJson

public Map<String,Object> getUnknownJson()

Description copied from interface: JsonSerializable

Gets unknown data from the source JSON.

Unknown JSON is a Map of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.

Specified by:

getUnknownJson in interface JsonSerializable

Returns:

an unmodifiable Map containing unknown data from the source JSON

getUnsupportedJson

public Map<String,Object> getUnsupportedJson()

Description copied from interface: JsonSerializable

Gets unsupported data from the source JSON.

Unsupported JSON is a Map of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.

Specified by:

getUnsupportedJson in interface JsonSerializable

Returns:

an unmodifiable Map containing unsupported data from the source JSON

getDefaultElevationServices

public List<ElevationServiceInfo> getDefaultElevationServices()

Gets information about Limited Error Raster Compression (LERC) elevation services used by ArcGIS Pro and the Web Scene Viewer.

Returns:

an unmodifiable list of ElevationServiceInfo objects. This will throw an UnsupportedOperationException if an attempt is made to modify it.

Since:

100.5.0

See Also:

• ElevationServiceInfo

getGeocodeServices

public List<GeocodeServiceInfo> getGeocodeServices()

Gets the geocode services.

Returns:

an unmodifiable list of the geocode services. This will throw an UnsupportedOperationException if an attempt is made to modify it.

Since:

100.0.0

See Also:

• GeocodeServiceInfo

getGeometryService

public String getGeometryService()

Gets the URL of the geometry service.

Returns:

the URL of the geometry service, or null if none

Since:

100.0.0

getPrintService

public String getPrintService()

Gets the URL of the print service.

Returns:

the URL of the print service, or null if none

Since:

100.0.0

getSyncRouteService

public String getSyncRouteService()

Gets the URL of the synchronous route service.

Returns:

the URL of the synchronous route service, or null if none

Since:

100.0.0

getAsyncRouteService

public String getAsyncRouteService()

Gets the URL of the asynchronous route service.

Returns:

the URL of the asynchronous route service, or null if none

Since:

100.0.0

getSyncClosestFacilityService

public String getSyncClosestFacilityService()

Gets the URL of the synchronous closest facility service.

Returns:

the URL of the synchronous closest facility service, or null if none

Since:

100.0.0

getAsyncClosestFacilityService

public String getAsyncClosestFacilityService()

Gets the URL of the asynchronous closest facility service.

Returns:

the URL of the asynchronous closest facility service, or null if none

Since:

100.0.0

getTrafficService

public String getTrafficService()

Gets the URL of the traffic service.

Returns:

the URL of the traffic service, or null if none

Since:

100.0.0

getSyncServiceAreaService

public String getSyncServiceAreaService()

Gets the URL of the synchronous service-area service.

Returns:

the URL of the synchronous service-area service, or null if none

Since:

100.0.0

getAsyncServiceAreaService

public String getAsyncServiceAreaService()

Gets the URL of the asynchronous service-area service.

Returns:

the URL of the asynchronous service-area service, or null if none

Since:

100.0.0

getSyncVrpService

public String getSyncVrpService()

Gets the URL of the synchronous vehicle routing problem service.

Returns:

the URL of the synchronous vehicle routing problem service, or null if none

Since:

100.0.0

getAsyncVrpService

public String getAsyncVrpService()

Gets the URL of the asynchronous vehicle routing problem service.

Returns:

the URL of the asynchronous vehicle routing problem service, or null if none

Since:

100.0.0

getAsyncLocationAllocationService

public String getAsyncLocationAllocationService()

Gets the URL of the asynchronous location-allocation service.

Returns:

the URL of the asynchronous location-allocation service, or null if none

Since:

100.0.0

getAnalysisService

public String getAnalysisService()

Gets the URL of hosted GP services that perform analyses.

Returns:

the URL of hosted GP services that perform analyses, or null if none

Since:

100.0.0

getGeoenrichmentService

public String getGeoenrichmentService()

Gets the URL of the geoenrichment service.

Returns:

the URL of the geoenrichment service, or null if none

Since:

100.0.0

getSyncElevationService

public String getSyncElevationService()

Gets the URL of the synchronous elevation analysis services.

Returns:

the URL of the synchronous elevation analysis services, or null if none

Since:

100.0.0

getAsyncElevationService

public String getAsyncElevationService()

Gets the URL of the asynchronous elevation analysis services.

Returns:

the URL of the asynchronous elevation analysis services, or null if none

Since:

100.0.0

getHydrologyService

public String getHydrologyService()

Gets the URL of the hydrologic analysis services.

Returns:

the URL of the hydrologic analysis services, or null if none

Since:

100.0.0

getAsyncODCostMatrixService

public String getAsyncODCostMatrixService()

Gets the URL of the ArcGIS geoprocessing service for generating origin-destination cost matrices asynchronously.

Returns:

the URL of the asynchronous origin-destination cost matrix generation service, or null if none

Since:

100.3.0

getLocationTrackingService

public String getLocationTrackingService()

Gets the URL of the location tracking service.

Returns:

the URL of the location tracking service, or null if none

Since:

100.5.0