Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.realtime

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 Summary

Properties

Type	Property	Description
ReadOnlyDoubleProperty	archiveMaximumFeatureAge	The maximum time (in seconds) until the latest (last known) features are purged from the feature layer.
ReadOnlyStringProperty	archiveServiceUrl	The URL of the feature service with the last known observation for each track.
ReadOnlyLongProperty	archiveUpdateInterval	The frequency (in milliseconds) at which a snapshot of incoming observations is saved to the archive.
ReadOnlyStringProperty	currentVersion	The current version of the ArcGIS stream service.
ReadOnlyStringProperty	description	The description of the ArcGIS stream service.
ReadOnlyObjectProperty<DrawingInfo>	drawingInfo	The ArcGIS stream service drawing info.
ReadOnlyStringProperty	endTimeField	The name of the field in the track-aware service that contains end time.
ReadOnlyStringProperty	geometryField	The name of the field that stores geometry.
ReadOnlyObjectProperty<GeometryType>	geometryType	The type of geometry.
ReadOnlyStringProperty	globalIdField	The name of the field that stores a unique global identifier.
ReadOnlyStringProperty	objectIdField	The name of the field that stores a unique object ID.
ReadOnlyStringProperty	relatedFeaturesJoinField	The name of a field in the feature service identified by relatedFeaturesUrlProperty() that relates features in that service to features in the stream service.
ReadOnlyStringProperty	relatedFeaturesUrl	The URL of a feature service that contains features related to the stream service.
ReadOnlyObjectProperty<SpatialReference>	spatialReference	The SpatialReference of this stream service.
ReadOnlyStringProperty	startTimeField	The name of the field in the track-aware service that contains start time.
ReadOnlyStringProperty	trackIdField	The name of the field in the track-aware service that contains track ID.

Method Summary

Modifier and Type	Method	Description
ReadOnlyDoubleProperty	archiveMaximumFeatureAgeProperty()	The maximum time (in seconds) until the latest (last known) features are purged from the feature layer.
ReadOnlyStringProperty	archiveServiceUrlProperty()	The URL of the feature service with the last known observation for each track.
ReadOnlyLongProperty	archiveUpdateIntervalProperty()	The frequency (in milliseconds) at which a snapshot of incoming observations is saved to the archive.
ReadOnlyStringProperty	currentVersionProperty()	The current version of the ArcGIS stream service.
ReadOnlyStringProperty	descriptionProperty()	The description of the ArcGIS stream service.
ReadOnlyObjectProperty<DrawingInfo>	drawingInfoProperty()	The ArcGIS stream service drawing info.
ReadOnlyStringProperty	endTimeFieldProperty()	The name of the field in the track-aware service that contains end time.
ReadOnlyStringProperty	geometryFieldProperty()	The name of the field that stores geometry.
ReadOnlyObjectProperty<GeometryType>	geometryTypeProperty()	The type of geometry.
double	getArchiveMaximumFeatureAge()	Gets the value of the archiveMaximumFeatureAge property.
String	getArchiveServiceUrl()	Gets the value of the archiveServiceUrl property.
long	getArchiveUpdateInterval()	Gets the value of the archiveUpdateInterval property.
String	getCurrentVersion()	Gets the value of the currentVersion property.
String	getDescription()	Gets the value of the description property.
DrawingInfo	getDrawingInfo()	Gets the value of the drawingInfo property.
String	getEndTimeField()	Gets the value of the endTimeField property.
List<Field>	getFields()	Gets the ArcGIS stream service's field definitions.
String	getGeometryField()	Gets the value of the geometryField property.
GeometryType	getGeometryType()	Gets the value of the geometryType property.
String	getGlobalIdField()	Gets the value of the globalIdField property.
String	getObjectIdField()	Gets the value of the objectIdField property.
String	getRelatedFeaturesJoinField()	Gets the value of the relatedFeaturesJoinField property.
String	getRelatedFeaturesUrl()	Gets the value of the relatedFeaturesUrl property.
SpatialReference	getSpatialReference()	Gets the value of the spatialReference property.
String	getStartTimeField()	Gets the value of the startTimeField property.
String	getTrackIdField()	Gets the value of the trackIdField property.
ReadOnlyStringProperty	globalIdFieldProperty()	The name of the field that stores a unique global identifier.
ReadOnlyStringProperty	objectIdFieldProperty()	The name of the field that stores a unique object ID.
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.
ReadOnlyStringProperty	relatedFeaturesUrlProperty()	The URL of a feature service that contains features related to the stream service.
ReadOnlyObjectProperty<SpatialReference>	spatialReferenceProperty()	The SpatialReference of this stream service.
ReadOnlyStringProperty	startTimeFieldProperty()	The name of the field in the track-aware service that contains start time.
ReadOnlyStringProperty	trackIdFieldProperty()	The name of the field in the track-aware service that contains track ID.

Methods inherited from class java.lang.Object

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

Property Details

archiveMaximumFeatureAge

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()
• archiveMaximumFeatureAgeProperty()

archiveServiceUrl

public ReadOnlyStringProperty archiveServiceUrlProperty

The URL of the feature service with the last known observation for each track.

Since:

200.1.0

See Also:

• getArchiveServiceUrl()
• archiveServiceUrlProperty()

archiveUpdateInterval

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()
• archiveUpdateIntervalProperty()

currentVersion

public ReadOnlyStringProperty currentVersionProperty

The current version of the ArcGIS stream service.

Since:

200.1.0

See Also:

• getCurrentVersion()
• currentVersionProperty()

description

public ReadOnlyStringProperty descriptionProperty

The description of the ArcGIS stream service.

Since:

200.1.0

See Also:

• getDescription()
• descriptionProperty()

drawingInfo

public ReadOnlyObjectProperty<DrawingInfo> drawingInfoProperty

The ArcGIS stream service drawing info.

Since:

200.1.0

See Also:

• getDrawingInfo()
• drawingInfoProperty()

endTimeField

public ReadOnlyStringProperty endTimeFieldProperty

The name of the field in the track-aware service that contains end time.

Since:

200.1.0

See Also:

• getEndTimeField()
• endTimeFieldProperty()

geometryField

public ReadOnlyStringProperty geometryFieldProperty

The name of the field that stores geometry.

Since:

200.1.0

See Also:

• getGeometryField()
• geometryFieldProperty()

geometryType

public ReadOnlyObjectProperty<GeometryType> geometryTypeProperty

The type of geometry.

Since:

200.1.0

See Also:

• getGeometryType()
• geometryTypeProperty()

globalIdField

public ReadOnlyStringProperty globalIdFieldProperty

The name of the field that stores a unique global identifier.

Since:

200.1.0

See Also:

• getGlobalIdField()
• globalIdFieldProperty()

objectIdField

public ReadOnlyStringProperty objectIdFieldProperty

The name of the field that stores a unique object ID.

Since:

200.1.0

See Also:

• getObjectIdField()
• objectIdFieldProperty()

relatedFeaturesJoinField

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()
• relatedFeaturesJoinFieldProperty()

relatedFeaturesUrl

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()
• relatedFeaturesUrlProperty()

spatialReference

public ReadOnlyObjectProperty<SpatialReference> spatialReferenceProperty

The SpatialReference of this stream service.

The default is WGS84 (4326).

Since:

200.1.0

See Also:

• getSpatialReference()
• spatialReferenceProperty()

startTimeField

public ReadOnlyStringProperty startTimeFieldProperty

The name of the field in the track-aware service that contains start time.

Since:

200.1.0

See Also:

• getStartTimeField()
• startTimeFieldProperty()

trackIdField

public ReadOnlyStringProperty trackIdFieldProperty

The name of the field in the track-aware service that contains track ID.

Since:

200.1.0

See Also:

• getTrackIdField()
• trackIdFieldProperty()

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.

Returns:

the archiveMaximumFeatureAge property

Since:

200.1.0

See Also:

• getArchiveMaximumFeatureAge()

getArchiveMaximumFeatureAge

public double getArchiveMaximumFeatureAge()

Gets the value of the archiveMaximumFeatureAge property.

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.

Returns:

the value of the archiveMaximumFeatureAge property

Since:

200.1.0

See Also:

• archiveMaximumFeatureAgeProperty()

archiveServiceUrlProperty

public ReadOnlyStringProperty archiveServiceUrlProperty()

The URL of the feature service with the last known observation for each track.

Returns:

the archiveServiceUrl property

Since:

200.1.0

See Also:

• getArchiveServiceUrl()

getArchiveServiceUrl

public String getArchiveServiceUrl()

Gets the value of the archiveServiceUrl property.

Property description:

The URL of the feature service with the last known observation for each track.

Returns:

the value of the archiveServiceUrl property

Since:

200.1.0

See Also:

• archiveServiceUrlProperty()

archiveUpdateIntervalProperty

public ReadOnlyLongProperty archiveUpdateIntervalProperty()

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

The default is 30.

Returns:

the archiveUpdateInterval property

Since:

200.1.0

See Also:

• getArchiveUpdateInterval()

getArchiveUpdateInterval

public long getArchiveUpdateInterval()

Gets the value of the archiveUpdateInterval property.

Property description:

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

The default is 30.

Returns:

the value of the archiveUpdateInterval property

Since:

200.1.0

See Also:

• archiveUpdateIntervalProperty()

currentVersionProperty

public ReadOnlyStringProperty currentVersionProperty()

The current version of the ArcGIS stream service.

Returns:

the currentVersion property

Since:

200.1.0

See Also:

• getCurrentVersion()

getCurrentVersion

public String getCurrentVersion()

Gets the value of the currentVersion property.

Property description:

The current version of the ArcGIS stream service.

Returns:

the value of the currentVersion property

Since:

200.1.0

See Also:

• currentVersionProperty()

descriptionProperty

public ReadOnlyStringProperty descriptionProperty()

The description of the ArcGIS stream service.

Returns:

the description property

Since:

200.1.0

See Also:

• getDescription()

getDescription

public String getDescription()

Gets the value of the description property.

Property description:

The description of the ArcGIS stream service.

Returns:

the value of the description property

Since:

200.1.0

See Also:

• descriptionProperty()

drawingInfoProperty

public ReadOnlyObjectProperty<DrawingInfo> drawingInfoProperty()

The ArcGIS stream service drawing info.

Returns:

the drawingInfo property

Since:

200.1.0

See Also:

• getDrawingInfo()

getDrawingInfo

public DrawingInfo getDrawingInfo()

Gets the value of the drawingInfo property.

Property description:

The ArcGIS stream service drawing info.

Returns:

the value of the drawingInfo property

Since:

200.1.0

See Also:

• drawingInfoProperty()

endTimeFieldProperty

public ReadOnlyStringProperty endTimeFieldProperty()

The name of the field in the track-aware service that contains end time.

Returns:

the endTimeField property

Since:

200.1.0

See Also:

• getEndTimeField()

getEndTimeField

public String getEndTimeField()

Gets the value of the endTimeField property.

Property description:

The name of the field in the track-aware service that contains end time.

Returns:

the value of the endTimeField property

Since:

200.1.0

See Also:

• endTimeFieldProperty()

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.

Returns:

the geometryField property

Since:

200.1.0

See Also:

• getGeometryField()

getGeometryField

public String getGeometryField()

Gets the value of the geometryField property.

Property description:

The name of the field that stores geometry.

Returns:

the value of the geometryField property

Since:

200.1.0

See Also:

• geometryFieldProperty()

geometryTypeProperty

public ReadOnlyObjectProperty<GeometryType> geometryTypeProperty()

The type of geometry.

Returns:

the geometryType property

Since:

200.1.0

See Also:

• getGeometryType()

getGeometryType

public GeometryType getGeometryType()

Gets the value of the geometryType property.

Property description:

The type of geometry.

Returns:

the value of the geometryType property

Since:

200.1.0

See Also:

• geometryTypeProperty()

globalIdFieldProperty

public ReadOnlyStringProperty globalIdFieldProperty()

The name of the field that stores a unique global identifier.

Returns:

the globalIdField property

Since:

200.1.0

See Also:

• getGlobalIdField()

getGlobalIdField

public String getGlobalIdField()

Gets the value of the globalIdField property.

Property description:

The name of the field that stores a unique global identifier.

Returns:

the value of the globalIdField property

Since:

200.1.0

See Also:

• globalIdFieldProperty()

objectIdFieldProperty

public ReadOnlyStringProperty objectIdFieldProperty()

The name of the field that stores a unique object ID.

Returns:

the objectIdField property

Since:

200.1.0

See Also:

• getObjectIdField()

getObjectIdField

public String getObjectIdField()

Gets the value of the objectIdField property.

Property description:

The name of the field that stores a unique object ID.

Returns:

the value of the objectIdField property

Since:

200.1.0

See Also:

• objectIdFieldProperty()

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.

Returns:

the relatedFeaturesJoinField property

Since:

200.1.0

See Also:

• getRelatedFeaturesJoinField()

getRelatedFeaturesJoinField

public String getRelatedFeaturesJoinField()

Gets the value of the relatedFeaturesJoinField property.

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.

Returns:

the value of the relatedFeaturesJoinField property

Since:

200.1.0

See Also:

• relatedFeaturesJoinFieldProperty()

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.

Returns:

the relatedFeaturesUrl property

Since:

200.1.0

See Also:

• getRelatedFeaturesUrl()

getRelatedFeaturesUrl

public String getRelatedFeaturesUrl()

Gets the value of the relatedFeaturesUrl property.

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.

Returns:

the value of the relatedFeaturesUrl property

Since:

200.1.0

See Also:

• relatedFeaturesUrlProperty()

spatialReferenceProperty

public ReadOnlyObjectProperty<SpatialReference> spatialReferenceProperty()

The SpatialReference of this stream service.

The default is WGS84 (4326).

Returns:

the spatialReference property

Since:

200.1.0

See Also:

• getSpatialReference()

getSpatialReference

public SpatialReference getSpatialReference()

Gets the value of the spatialReference property.

Property description:

The SpatialReference of this stream service.

The default is WGS84 (4326).

Returns:

the value of the spatialReference property

Since:

200.1.0

See Also:

• spatialReferenceProperty()

startTimeFieldProperty

public ReadOnlyStringProperty startTimeFieldProperty()

The name of the field in the track-aware service that contains start time.

Returns:

the startTimeField property

Since:

200.1.0

See Also:

• getStartTimeField()

getStartTimeField

public String getStartTimeField()

Gets the value of the startTimeField property.

Property description:

The name of the field in the track-aware service that contains start time.

Returns:

the value of the startTimeField property

Since:

200.1.0

See Also:

• startTimeFieldProperty()

trackIdFieldProperty

public ReadOnlyStringProperty trackIdFieldProperty()

The name of the field in the track-aware service that contains track ID.

Returns:

the trackIdField property

Since:

200.1.0

See Also:

• getTrackIdField()

getTrackIdField

public String getTrackIdField()

Gets the value of the trackIdField property.

Property description:

The name of the field in the track-aware service that contains track ID.

Returns:

the value of the trackIdField property

Since:

200.1.0

See Also:

• trackIdFieldProperty()