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 byPortalInfo.getHelperServices().For detailed information about these services, see the "Services from Esri" topic within the ArcGIS REST API documentation. - Since:
- 100.0.0
 
- 
- 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HelperServicesfromJson(String json)Creates a HelperServices instance from a JSON string.StringgetAnalysisService()Gets the URL of hosted GP services that perform analyses.StringgetAsyncClosestFacilityService()Gets the URL of the asynchronous closest facility service.StringgetAsyncElevationService()Gets the URL of the asynchronous elevation analysis services.StringgetAsyncLocationAllocationService()Gets the URL of the asynchronous location-allocation service.StringgetAsyncODCostMatrixService()Gets the URL of the ArcGIS geoprocessing service for generating origin-destination cost matrices asynchronously.StringgetAsyncRouteService()Gets the URL of the asynchronous route service.StringgetAsyncServiceAreaService()Gets the URL of the asynchronous service-area service.StringgetAsyncVrpService()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.StringgetGeoenrichmentService()Gets the URL of the geoenrichment service.StringgetGeometryService()Gets the URL of the geometry service.StringgetHydrologyService()Gets the URL of the hydrologic analysis services.StringgetLocationTrackingService()Gets the URL of the location tracking service.StringgetPrintService()Gets the URL of the print service.StringgetSyncClosestFacilityService()Gets the URL of the synchronous closest facility service.StringgetSyncElevationService()Gets the URL of the synchronous elevation analysis services.StringgetSyncRouteService()Gets the URL of the synchronous route service.StringgetSyncServiceAreaService()Gets the URL of the synchronous service-area service.StringgetSyncVrpService()Gets the URL of the synchronous vehicle routing problem service.StringgetTrafficService()Gets the URL of the traffic service.Map<String,Object>getUnknownJson()If this object was created from JSON, this method gets unknown data from the source JSON.Map<String,Object>getUnsupportedJson()If this object was created from JSON, this method gets unsupported data from the source JSON.StringtoJson()Serializes this object to a JSON string.
 
- 
- 
- 
Method Detail- 
fromJsonpublic 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
 
 - 
toJsonpublic String toJson() Description copied from interface:JsonSerializableSerializes this object to a JSON string. Note that unknown JSON is omitted from the serialized string.- Specified by:
- toJsonin interface- JsonSerializable
- Returns:
- a JSON string
 
 - 
getUnknownJsonpublic Map<String,Object> getUnknownJson() Description copied from interface:JsonSerializableIf this object was created from JSON, this method gets unknown data from the source JSON. Unknown JSON is a Map of values that were in the source JSON but are not known by the Runtime and therefore not exposed in the API.- Specified by:
- getUnknownJsonin interface- JsonSerializable
- Returns:
- an unmodifiable Map containing unknown JSON data. The keys are Strings containing names. The types of 
 the values depend on the types of tokens within the JSON as follows:
 - a Map<String, Object>represents an object in the JSON
- a List<Object>represents an array in the JSON
- a Stringrepresents a string in the JSON
- a Doublerepresents a number in the JSON
- a Booleanrepresents true or false in the JSON
- nullrepresents null in the JSON
 
- a 
 
 - 
getUnsupportedJsonpublic Map<String,Object> getUnsupportedJson() Description copied from interface:JsonSerializableIf this object was created from JSON, this method gets unsupported data from the source JSON. Unsupported JSON is a Map of values that are supported by webmaps and known to the version of the webmap specification the API supports (see system requirements), but are not explicitly exposed through the Runtime API.- Specified by:
- getUnsupportedJsonin interface- JsonSerializable
- Returns:
- an unmodifiable Map containing unsupported JSON data. The keys are Strings containing names. The types of
 the values depend on the types of tokens within the JSON as follows:
 - a Map<String, Object>represents an object in the JSON
- a List<Object>represents an array in the JSON
- a Stringrepresents a string in the JSON
- a Doublerepresents a number in the JSON
- a Booleanrepresents true or false in the JSON
- nullrepresents null in the JSON
 
- a 
 
 - 
getDefaultElevationServicespublic 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
 
 - 
getGeocodeServicespublic 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
 
 - 
getGeometryServicepublic String getGeometryService() Gets the URL of the geometry service.- Returns:
- the URL of the geometry service, or null if none
- Since:
- 100.0.0
 
 - 
getPrintServicepublic String getPrintService() Gets the URL of the print service.- Returns:
- the URL of the print service, or null if none
- Since:
- 100.0.0
 
 - 
getSyncRouteServicepublic 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
 
 - 
getAsyncRouteServicepublic 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
 
 - 
getSyncClosestFacilityServicepublic 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
 
 - 
getAsyncClosestFacilityServicepublic 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
 
 - 
getTrafficServicepublic String getTrafficService() Gets the URL of the traffic service.- Returns:
- the URL of the traffic service, or null if none
- Since:
- 100.0.0
 
 - 
getSyncServiceAreaServicepublic 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
 
 - 
getAsyncServiceAreaServicepublic 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
 
 - 
getSyncVrpServicepublic 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
 
 - 
getAsyncVrpServicepublic 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
 
 - 
getAsyncLocationAllocationServicepublic 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
 
 - 
getAnalysisServicepublic 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
 
 - 
getGeoenrichmentServicepublic String getGeoenrichmentService() Gets the URL of the geoenrichment service.- Returns:
- the URL of the geoenrichment service, or null if none
- Since:
- 100.0.0
 
 - 
getSyncElevationServicepublic 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
 
 - 
getAsyncElevationServicepublic 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
 
 - 
getHydrologyServicepublic 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
 
 - 
getAsyncODCostMatrixServicepublic 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
 
 - 
getLocationTrackingServicepublic 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
 
 
- 
 
-