import ReplicaDefinition from "@arcgis/core/rest/knowledgeGraph/ReplicaDefinition.js";const ReplicaDefinition = await $arcgis.import("@arcgis/core/rest/knowledgeGraph/ReplicaDefinition.js");- Inheritance
- ReplicaDefinition→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 5.1
A replica definition returned from a knowledge graph replica endpoint.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
replicaFilters
- Type
- ReplicaFilters | null | undefined
Filters that define the replica scope.
syncDirection
- Type
- ReplicaSyncDirection | null | undefined
Synchronization direction for the replica.
Type definitions
ReplicaProvenanceOptions
- Type
- { includeProvenance: true; includeSourceDocuments?: boolean; } | { includeProvenance: false; }
ReplicaDocumentOptions
- Type
- { includeConnectedDocuments: true; includeDocumentProvenance: true; includeDocumentSourceDocuments?: boolean; } | { includeConnectedDocuments: true; includeDocumentProvenance?: false; } | { includeConnectedDocuments: false; }
ReplicaNamedTypeDefinition
Entity type and relationship type definitions included in the replica definition.
At least one of entityTypeReplicaDefinitions or relationshipTypeReplicaDefinitions must be provided with at least one definition.
provenanceOptions
- Type
- ReplicaProvenanceOptions | null | undefined
Options for specifying how provenance is included in the replica.
parameters
- Type
- Record<string, ValidBindParameterType> | null | undefined
Bind parameters to send with the openCypher query to define the replica.
ReplicaEntityTypeDefinition
Entity type definitions included in the replica static definition.
At least one of entityTypeReplicaDefinitions or relationshipTypeReplicaDefinitions
must be provided with at least one definition.
- Supertypes
- ReplicaNamedTypeDefinition
ReplicaRelationshipTypeDefinition
Relationship type definitions included in the replica static definition.
At least one of entityTypeReplicaDefinitions or relationshipTypeReplicaDefinitions
must be provided with at least one definition.
- Supertypes
- ReplicaNamedTypeDefinition
ReplicaStaticDefinition
The definition of a replica including the entity types and relationship types to be included. Additional filters can be applied to each type to get a subset of data.
entityTypeReplicaDefinitions
- Type
- ReplicaEntityTypeDefinition[] | null | undefined
Entity type definitions included in the replica static definition.
At least one of entityTypeReplicaDefinitions or relationshipTypeReplicaDefinitions
must be provided with at least one definition.
relationshipTypeReplicaDefinitions
- Type
- ReplicaRelationshipTypeDefinition[] | null | undefined
Relationship type definitions included in the replica static definition.
At least one of entityTypeReplicaDefinitions or relationshipTypeReplicaDefinitions
must be provided with at least one definition.
ReplicaFilters
inputQuantizationParameters
- Type
- InputQuantizationParameters | null | undefined
Custom quantization parameters for input geometry that compresses geometry for transfer to the server. Overrides the default lossless WGS84 quantization.
inputSpatialReference
- Type
- SpatialReference | null | undefined
Custom spatial reference for input geometry.
BaseReplicaOptions
Base options shared by replica create request variants.
syncDirection
- Type
- ReplicaSyncDirection
Synchronization direction for the replica operation.
ReferenceReplicaOptions
Additional options used by executeCreateReplica() for reference replica creation.
- Supertypes
- BaseReplicaOptions
FilterReplicaOptions
Additional options used by executeCreateReplica() for filtered replica creation.
- Supertypes
- BaseReplicaOptions