Package com.esri.arcgisruntime.portal
Class HelperServices
- java.lang.Object
-
- com.esri.arcgisruntime.portal.HelperServices
-
- All Implemented Interfaces:
JsonSerializable
public final class HelperServices extends java.lang.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 Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HelperServices
fromJson(java.lang.String json)
Creates a HelperServices instance from a JSON string.java.lang.String
getAnalysisService()
Gets the URL of hosted GP services that perform analyses.java.lang.String
getAsyncClosestFacilityService()
Gets the URL of the asynchronous closest facility service.java.lang.String
getAsyncElevationService()
Gets the URL of the asynchronous elevation analysis services.java.lang.String
getAsyncLocationAllocationService()
Gets the URL of the asynchronous location-allocation service.java.lang.String
getAsyncODCostMatrixService()
Gets the URL of the ArcGIS geoprocessing service for generating origin-destination cost matrices asynchronously.java.lang.String
getAsyncRouteService()
Gets the URL of the asynchronous route service.java.lang.String
getAsyncServiceAreaService()
Gets the URL of the asynchronous service-area service.java.lang.String
getAsyncVrpService()
Gets the URL of the asynchronous vehicle routing problem service.java.util.List<ElevationServiceInfo>
getDefaultElevationServices()
Gets information about Limited Error Raster Compression (LERC) elevation services used by ArcGIS Pro and the Web Scene Viewer.java.util.List<GeocodeServiceInfo>
getGeocodeServices()
Gets the geocode services.java.lang.String
getGeoenrichmentService()
Gets the URL of the geoenrichment service.java.lang.String
getGeometryService()
Gets the URL of the geometry service.java.lang.String
getHydrologyService()
Gets the URL of the hydrologic analysis services.java.lang.String
getLocationTrackingService()
Gets the URL of the location tracking service.java.lang.String
getPrintService()
Gets the URL of the print service.java.lang.String
getSyncClosestFacilityService()
Gets the URL of the synchronous closest facility service.java.lang.String
getSyncElevationService()
Gets the URL of the synchronous elevation analysis services.java.lang.String
getSyncRouteService()
Gets the URL of the synchronous route service.java.lang.String
getSyncServiceAreaService()
Gets the URL of the synchronous service-area service.java.lang.String
getSyncVrpService()
Gets the URL of the synchronous vehicle routing problem service.java.lang.String
getTrafficService()
Gets the URL of the traffic service.java.util.Map<java.lang.String,java.lang.Object>
getUnknownJson()
If this object was created from JSON, this method gets unknown data from the source JSON.java.util.Map<java.lang.String,java.lang.Object>
getUnsupportedJson()
If this object was created from JSON, this method gets unsupported data from the source JSON.java.lang.String
toJson()
Serializes this object to a JSON string.
-
-
-
Method Detail
-
fromJson
public static HelperServices fromJson(java.lang.String json)
Creates a HelperServices instance from a JSON string.- Parameters:
json
- a JSON string that represents a HelperServices- Returns:
- a HelperServices instance
- Throws:
java.lang.IllegalArgumentException
- if json is null or empty- Since:
- 100.8.0
-
toJson
public java.lang.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 interfaceJsonSerializable
- Returns:
- a JSON string
-
getUnknownJson
public java.util.Map<java.lang.String,java.lang.Object> getUnknownJson()
Description copied from interface:JsonSerializable
If 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:
getUnknownJson
in interfaceJsonSerializable
- 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
String
represents a string in the JSON - a
Double
represents a number in the JSON - a
Boolean
represents true or false in the JSON null
represents null in the JSON
- a
-
getUnsupportedJson
public java.util.Map<java.lang.String,java.lang.Object> getUnsupportedJson()
Description copied from interface:JsonSerializable
If 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:
getUnsupportedJson
in interfaceJsonSerializable
- 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
String
represents a string in the JSON - a
Double
represents a number in the JSON - a
Boolean
represents true or false in the JSON null
represents null in the JSON
- a
-
getDefaultElevationServices
public java.util.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 java.util.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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
-
-