Class ArcGISStreamServiceInfo

java.lang.Object
com.esri.arcgisruntime.realtime.ArcGISStreamServiceInfo

public final class ArcGISStreamServiceInfo extends Object
Metadata for an ArcGIS stream service.

An object of this type is provided by the ArcGISStreamService.serviceInfoProperty() property after loading the data source.

To learn about ArcGIS stream services see: ArcGIS Server - Stream Services in the ArcGIS Enterprise documentation.

Since:
200.1.0
  • Property Details

  • Method Details

    • archiveMaximumFeatureAgeProperty

      public ReadOnlyDoubleProperty archiveMaximumFeatureAgeProperty()
      The maximum time (in seconds) until the latest (last known) features are purged from the feature layer.

      The default is 0 which means never expire.

      Since:
      200.1.0
      See Also:
    • getArchiveMaximumFeatureAge

      public double getArchiveMaximumFeatureAge()
      Gets the value of the property archiveMaximumFeatureAge.
      Property description:
      The maximum time (in seconds) until the latest (last known) features are purged from the feature layer.

      The default is 0 which means never expire.

      Since:
      200.1.0
    • archiveServiceUrlProperty

      public ReadOnlyStringProperty archiveServiceUrlProperty()
      The URL of the feature service with the last known observation for each track.
      Since:
      200.1.0
      See Also:
    • getArchiveServiceUrl

      public String getArchiveServiceUrl()
      Gets the value of the property archiveServiceUrl.
      Property description:
      The URL of the feature service with the last known observation for each track.
      Since:
      200.1.0
    • archiveUpdateIntervalProperty

      public ReadOnlyLongProperty archiveUpdateIntervalProperty()
      The frequency (in milliseconds) at which a snapshot of incoming observations is saved to the archive.

      The default is 30.

      Since:
      200.1.0
      See Also:
    • getArchiveUpdateInterval

      public long getArchiveUpdateInterval()
      Gets the value of the property archiveUpdateInterval.
      Property description:
      The frequency (in milliseconds) at which a snapshot of incoming observations is saved to the archive.

      The default is 30.

      Since:
      200.1.0
    • currentVersionProperty

      public ReadOnlyStringProperty currentVersionProperty()
      The current version of the ArcGIS stream service.
      Since:
      200.1.0
      See Also:
    • getCurrentVersion

      public String getCurrentVersion()
      Gets the value of the property currentVersion.
      Property description:
      The current version of the ArcGIS stream service.
      Since:
      200.1.0
    • descriptionProperty

      public ReadOnlyStringProperty descriptionProperty()
      The description of the ArcGIS stream service.
      Since:
      200.1.0
      See Also:
    • getDescription

      public String getDescription()
      Gets the value of the property description.
      Property description:
      The description of the ArcGIS stream service.
      Since:
      200.1.0
    • drawingInfoProperty

      public ReadOnlyObjectProperty<DrawingInfo> drawingInfoProperty()
      The ArcGIS stream service drawing info.
      Since:
      200.1.0
      See Also:
    • getDrawingInfo

      public DrawingInfo getDrawingInfo()
      Gets the value of the property drawingInfo.
      Property description:
      The ArcGIS stream service drawing info.
      Since:
      200.1.0
    • endTimeFieldProperty

      public ReadOnlyStringProperty endTimeFieldProperty()
      The name of the field in the track-aware service that contains end time.
      Since:
      200.1.0
      See Also:
    • getEndTimeField

      public String getEndTimeField()
      Gets the value of the property endTimeField.
      Property description:
      The name of the field in the track-aware service that contains end time.
      Since:
      200.1.0
    • getFields

      public List<Field> getFields()
      Gets the ArcGIS stream service's field definitions.
      Returns:
      the ArcGIS stream service's field definitions
      Since:
      200.1.0
    • geometryFieldProperty

      public ReadOnlyStringProperty geometryFieldProperty()
      The name of the field that stores geometry.
      Since:
      200.1.0
      See Also:
    • getGeometryField

      public String getGeometryField()
      Gets the value of the property geometryField.
      Property description:
      The name of the field that stores geometry.
      Since:
      200.1.0
    • geometryTypeProperty

      public ReadOnlyObjectProperty<GeometryType> geometryTypeProperty()
      The type of geometry.
      Since:
      200.1.0
      See Also:
    • getGeometryType

      public GeometryType getGeometryType()
      Gets the value of the property geometryType.
      Property description:
      The type of geometry.
      Since:
      200.1.0
    • globalIdFieldProperty

      public ReadOnlyStringProperty globalIdFieldProperty()
      The name of the field that stores a unique global identifier.
      Since:
      200.1.0
      See Also:
    • getGlobalIdField

      public String getGlobalIdField()
      Gets the value of the property globalIdField.
      Property description:
      The name of the field that stores a unique global identifier.
      Since:
      200.1.0
    • objectIdFieldProperty

      public ReadOnlyStringProperty objectIdFieldProperty()
      The name of the field that stores a unique object ID.
      Since:
      200.1.0
      See Also:
    • getObjectIdField

      public String getObjectIdField()
      Gets the value of the property objectIdField.
      Property description:
      The name of the field that stores a unique object ID.
      Since:
      200.1.0
    • relatedFeaturesJoinFieldProperty

      public ReadOnlyStringProperty relatedFeaturesJoinFieldProperty()
      The name of a field in the feature service identified by relatedFeaturesUrlProperty() that relates features in that service to features in the stream service.

      Values in the join field must match track ID values in the trackIdFieldProperty() of the stream service.

      Since:
      200.1.0
      See Also:
    • getRelatedFeaturesJoinField

      public String getRelatedFeaturesJoinField()
      Gets the value of the property relatedFeaturesJoinField.
      Property description:
      The name of a field in the feature service identified by relatedFeaturesUrlProperty() that relates features in that service to features in the stream service.

      Values in the join field must match track ID values in the trackIdFieldProperty() of the stream service.

      Since:
      200.1.0
    • relatedFeaturesUrlProperty

      public ReadOnlyStringProperty relatedFeaturesUrlProperty()
      The URL of a feature service that contains features related to the stream service.

      The field name provided for relatedFeaturesJoinFieldProperty() is used to match track ID values in the feature service to trackIdFieldProperty() values in the stream service.

      Since:
      200.1.0
      See Also:
    • getRelatedFeaturesUrl

      public String getRelatedFeaturesUrl()
      Gets the value of the property relatedFeaturesUrl.
      Property description:
      The URL of a feature service that contains features related to the stream service.

      The field name provided for relatedFeaturesJoinFieldProperty() is used to match track ID values in the feature service to trackIdFieldProperty() values in the stream service.

      Since:
      200.1.0
    • spatialReferenceProperty

      public ReadOnlyObjectProperty<SpatialReference> spatialReferenceProperty()
      The SpatialReference of this stream service.

      The default is WGS84 (4326).

      Since:
      200.1.0
      See Also:
    • getSpatialReference

      public SpatialReference getSpatialReference()
      Gets the value of the property spatialReference.
      Property description:
      The SpatialReference of this stream service.

      The default is WGS84 (4326).

      Since:
      200.1.0
    • startTimeFieldProperty

      public ReadOnlyStringProperty startTimeFieldProperty()
      The name of the field in the track-aware service that contains start time.
      Since:
      200.1.0
      See Also:
    • getStartTimeField

      public String getStartTimeField()
      Gets the value of the property startTimeField.
      Property description:
      The name of the field in the track-aware service that contains start time.
      Since:
      200.1.0
    • trackIdFieldProperty

      public ReadOnlyStringProperty trackIdFieldProperty()
      The name of the field in the track-aware service that contains track ID.
      Since:
      200.1.0
      See Also:
    • getTrackIdField

      public String getTrackIdField()
      Gets the value of the property trackIdField.
      Property description:
      The name of the field in the track-aware service that contains track ID.
      Since:
      200.1.0