Elasticsearch Snapshot Step

This type of step creates an Elasticsearch snapshot of the index associated with a layer.

JSON Request

The following template shows the body of a JSON request that could be used in an Elasticsearch Snapshot Step PUT or PATCH request. It lists all of the step's required and optional body parameters but excludes the read-only options. The default values for each parameter are shown. Below the request (in Schema Details) is a table that describes the complete schema, including the read-only parameters. Clicking a link in the template takes you to the schema details for that parameter.

{
   "gmLinkedDataset" : "string",
   "title" : "string",
   "incrementalData" : [ "string" ],
   "type" : "ElasticsearchSnapshotStep",
   "enabled" : true,
   "contextProvider" : [ "string" ],
   "description" : "string",
   "ontology" : [ "string" ],
   "source" : [ "string" ],
   "ignoreLoadErrors" : true,
   "disableLoadCounts" : true,
   "preGenerateStatistics" : true,
   "tags" : [ {
                "description" : "string",
                "title" : "string"
            } ],
   "tagTitle" : [ "string" ]
}

Schema Details

The table below describes the Elasticsearch Snapshot Step schema.

Property	Format	Required?	Description
uri (read-only)	"uri"	Auto-generated	The URI of the step.
creator (read-only)	"uri"	Auto-generated	The creator of the step.
created (read-only)	"dateTime"	Auto-generated	The timestamp when the step was created.
modifier (read-only)	"uri"	Auto-generated	The user who modified the step.
alltypes (read-only)	Array of strings	Optional	A list of the types related to the step, such as ElasticsearchSnapshotStep, Step, LayerChild, etc.
contextAttribute (read-only)	Array of strings	Optional	A list of any context attributes that are used.
gmLinkedDataset	"uri"	Required	The URI of the Linked Dataset Catalog entry that represents the target FLDS for the export. To get the catalog entry, you can retrieve data about the dataset and use the catalogEntry value.
title	"string"	Required	The name of the step.
incrementalData	"string"	Optional	Incremental load data associated with the step.
type	"string"	Required	The type of step: "ElasticsearchSnapshotStep".
enabled	boolean	Optional	Controls whether the step is enabled or disabled.
contextProvider	[ "uri", "..." ]	Optional	A list of any referenced context providers (the data source URI). You can retrieve data for the parent layer to get a list of providers for that layer.
description	"string"	Optional	A brief description of the step.
ontology	[ "uri", "..." ]	Optional	A list of any models to associate with this step.
source	[ "uri", "..." ]	Required	The source data for the step. Options are any combination of the following values: "http://cambridgesemantics.com/ontologies/Graphmarts#Self": The source is the data that is in this step's layer. "http://cambridgesemantics.com/ontologies/Graphmarts#AllPrevious": The source is the data from all of the successful layers that precede this step's layer. Failed layers are ignored. "http://cambridgesemantics.com/ontologies/Graphmarts#Previous": The source is the data that is in the one layer that precedes this step's layer. "layer_uri": The source is a specific layer in the graphmart.
ignoreLoadErrors	boolean	Optional	Controls whether to ignore errors and proceed with the load or fail the step if there is an error.
disableLoadCounts	boolean	Optional	Controls whether Anzo periodically queries AnzoGraph to count the total number of statements that are processed. Disabling the load count decreases the number of queries that run during activation.
preGenerateStatistics	boolean	Optional	Controls whether AnzoGraph generates statistics on the data before the step is run.
tags	Array of objects	Optional	Any tags on the step.
tagTitle	["string"]	Optional	A virtual property that is available for all objects. It lists the tags associated with the step or can be used to add a tag to the step without including a description.