Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
{"swagger": "2.0","info": {"version": "1.0.0-RC1","title": "GeoWave API","description": "REST API for GeoWave CLI commands","termsOfService": "https://github.com/locationtech/geowave","contact": {"name": "GeoWave Team"},"license": {"name": "Apache2"}},"host": "10.194.173.10:8080","basePath": "/geowave-restservices-1.0.0-RC1-apache","schemes": ["http"],"consumes": ["application/json","multipart/form-data"],"produces": ["application/json"],"paths":{"/v0/analytic/dbscan":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.dbscan","description":"Density Based Scanner","parameters":[{"in":"query","type":"string","description":"main parameter","name":"storename","required":true},{"in":"query","type":"string","description":"MapReduce Configuration","name":"mapReduceConfigFile","required":false},{"in":"query","type":"string","description":"Fully qualified path to the base directory in hdfs","name":"mapReduceHdfsBaseDir","required":true},{"in":"query","type":"string","description":"HDFS hostname and port in the format hostname:port","name":"mapReduceHdfsHostPort","required":false},{"in":"query","type":"string","description":"[REQUIRED (or resourceman)] Hadoop job tracker hostname and port in the format hostname:port","name":"mapReduceJobtrackerHostPort","required":false},{"in":"query","type":"string","description":"[REQUIRED (or jobtracker)] Yarn resource manager hostname and port in the format hostname:port","name":"mapReduceYarnResourceManager","required":false},{"in":"query","type":"string","description":"Distance Function Class implements org.locationtech.geowave.analytics.distance.DistanceFn","name":"commonDistanceFunctionClass","required":false},{"in":"query","type":"string","description":"Maximum hdfs input split size","name":"extractMaxInputSplit","required":true},{"in":"query","type":"string","description":"Minimum hdfs input split size","name":"extractMinInputSplit","required":true},{"in":"query","type":"string","description":"Query","name":"extractQuery","required":false},{"in":"query","type":"string","description":"Output Format Class","name":"outputOutputFormat","required":false},{"in":"query","type":"string","description":"Input Format Class","name":"inputFormatClass","required":false},{"in":"query","type":"string","description":"Input Path","name":"inputHdfsPath","required":false},{"in":"query","type":"string","description":"Number of Reducers For Output","name":"outputReducerCount","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"The comma-separated list of authorizations used during extract; by default all authorizations are used.","name":"authorizations","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"The comma-separated list of data typess to query; by default all data types are used.","name":"typeNames","required":true},{"in":"query","type":"string","description":"The specific index to query; by default one is chosen for each adapter.","name":"indexName","required":false},{"in":"query","type":"string","description":"Output HDFS File Path","name":"outputHdfsOutputPath","required":false},{"in":"query","type":"string","description":"Comma separated list of distance thresholds, per dimension","name":"partitioningDistanceThresholds","required":false},{"in":"query","type":"string","description":"Geometric distance unit (m\u003dmeters,km\u003dkilometers, see symbols for javax.units.BaseUnit)","name":"partitioningGeometricDistanceUnit","required":false},{"in":"query","type":"string","description":"Maximum number of iterations when finding optimal clusters","name":"clusteringMaxIterations","required":true},{"in":"query","type":"string","description":"Minimum Cluster Size","name":"clusteringMinimumSize","required":true},{"in":"query","type":"string","description":"Batch ID","name":"globalBatchId","required":false},{"in":"query","type":"string","description":"Data Type ID for a centroid item","name":"hullDataTypeId","required":false},{"in":"query","type":"string","description":"Class to project on to 2D space. Implements org.locationtech.geowave.analytics.tools.Projection","name":"hullProjectionClass","required":false},{"in":"query","type":"string","description":"Output namespace for objects that will be written to GeoWave","name":"outputDataNamespaceUri","required":false},{"in":"query","type":"string","description":"Output Data ID assigned to objects that will be written to GeoWave","name":"outputDataTypeId","required":false},{"in":"query","type":"string","description":"Output Index ID for objects that will be written to GeoWave","name":"outputIndexId","required":false},{"in":"query","type":"string","description":"Maximum number of members selected from a partition","name":"partitionMaxMemberSelection","required":false},{"in":"query","type":"string","description":"Index Identifier for Centroids","name":"partitionPartitionerClass","required":false},{"in":"query","type":"string","description":"Rate of decrease for precision(within (0,1])","name":"partitionPartitionDecreaseRate","required":false},{"in":"query","type":"string","description":"Maximum Partition Distance","name":"partitionMaxDistance","required":true},{"in":"query","type":"string","description":"Partition Precision","name":"partitionPartitionPrecision","required":false},{"in":"query","type":"string","description":"Perform secondary partitioning with the provided class","name":"partitionSecondaryPartitionerClass","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/analytic/kde":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.kde","description":"Kernel Density Estimate","parameters":[{"in":"query","type":"string","description":"main parameter","name":"input_storename","required":true},{"in":"query","type":"string","description":"main parameter","name":"output_storename","required":true},{"in":"query","type":"string","description":"The name of the feature type to run a KDE on","name":"featureType","required":true},{"in":"query","type":"string","description":"An optional index name to filter the input data","name":"indexName","required":false},{"in":"query","type":"integer","description":"The min level to run a KDE at","name":"minLevel","required":true},{"in":"query","type":"integer","description":"The max level to run a KDE at","name":"maxLevel","required":true},{"in":"query","type":"integer","description":"The min partitions for the input data","name":"minSplits","required":false},{"in":"query","type":"integer","description":"The max partitions for the input data","name":"maxSplits","required":false},{"in":"query","type":"string","description":"The coverage name","name":"coverageName","required":true},{"in":"query","type":"string","description":"The hdfs host port","name":"hdfsHostPort","required":false},{"in":"query","type":"string","description":"The job submission tracker","name":"jobTrackerOrResourceManHostPort","required":true},{"in":"query","type":"integer","description":"The tile size","name":"tileSize","required":false},{"in":"query","type":"string","description":"An optional CQL filter applied to the input data","name":"cqlFilter","required":false},{"in":"query","type":"string","description":"An optional index for output datastore. Only spatial index type is supported","name":"outputIndex","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/analytic/kdespark":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.kdespark","description":"Kernel Density Estimate via Spark","parameters":[{"in":"query","type":"string","description":"main parameter","name":"input_storename","required":true},{"in":"query","type":"string","description":"main parameter","name":"output_storename","required":true},{"in":"query","type":"string","description":"The spark application name","name":"appName","required":false},{"in":"query","type":"integer","description":"The tile size","name":"tileSize","required":false},{"in":"query","type":"string","description":"An optional index name to filter the input data","name":"indexName","required":false},{"in":"query","type":"integer","description":"The min level to run a KDE at","name":"minLevel","required":true},{"in":"query","type":"integer","description":"The max level to run a KDE at","name":"maxLevel","required":true},{"in":"query","type":"string","description":"The spark driver host","name":"host","required":false},{"in":"query","type":"string","description":"The spark master designation","name":"master","required":false},{"in":"query","type":"string","description":"An optional CQL filter applied to the input data","name":"cqlFilter","required":false},{"in":"query","type":"string","description":"Feature type name to query","name":"typeName","required":false},{"in":"query","type":"integer","description":"The min partitions for the input data","name":"minSplits","required":false},{"in":"query","type":"integer","description":"The max partitions for the input data","name":"maxSplits","required":false},{"in":"query","type":"string","description":"The coverage name","name":"coverageName","required":true},{"in":"query","type":"string","description":"An optional index for output datastore. Only spatial index type is supported","name":"outputIndex","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/analytic/kmeansspark":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.kmeansspark","description":"KMeans Clustering via Spark ML","parameters":[{"in":"query","type":"string","description":"main parameter","name":"input_storename","required":true},{"in":"query","type":"string","description":"main parameter","name":"output_storename","required":true},{"in":"query","type":"string","description":"The spark application name","name":"appName","required":false},{"in":"query","type":"string","description":"The spark driver host","name":"host","required":false},{"in":"query","type":"string","description":"The spark master designation","name":"master","required":false},{"in":"query","type":"integer","description":"The number of clusters to generate","name":"numClusters","required":false},{"in":"query","type":"integer","description":"The number of iterations to run","name":"numIterations","required":false},{"in":"query","type":"string","description":"The convergence tolerance","name":"epsilon","required":false},{"in":"query","type":"boolean","description":"Use time field from input data","name":"useTime","required":false},{"in":"query","type":"boolean","description":"Generate convex hulls?","name":"generateHulls","required":false},{"in":"query","type":"boolean","description":"Compute hull count, area and density?","name":"computeHullData","required":false},{"in":"query","type":"string","description":"An optional CQL filter applied to the input data","name":"cqlFilter","required":false},{"in":"query","type":"string","description":"Feature type name to query","name":"typeName","required":false},{"in":"query","type":"integer","description":"The min partitions for the input data","name":"minSplits","required":false},{"in":"query","type":"integer","description":"The max partitions for the input data","name":"maxSplits","required":false},{"in":"query","type":"string","description":"Feature type name for centroid output","name":"centroidTypeName","required":false},{"in":"query","type":"string","description":"Feature type name for hull output","name":"hullTypeName","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/analytic/nn":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.nn","description":"Nearest Neighbors","parameters":[{"in":"query","type":"string","description":"main parameter","name":"storename","required":true},{"in":"query","type":"string","description":"MapReduce Configuration","name":"mapReduceConfigFile","required":false},{"in":"query","type":"string","description":"Fully qualified path to the base directory in hdfs","name":"mapReduceHdfsBaseDir","required":true},{"in":"query","type":"string","description":"HDFS hostname and port in the format hostname:port","name":"mapReduceHdfsHostPort","required":false},{"in":"query","type":"string","description":"[REQUIRED (or resourceman)] Hadoop job tracker hostname and port in the format hostname:port","name":"mapReduceJobtrackerHostPort","required":false},{"in":"query","type":"string","description":"[REQUIRED (or jobtracker)] Yarn resource manager hostname and port in the format hostname:port","name":"mapReduceYarnResourceManager","required":false},{"in":"query","type":"string","description":"Distance Function Class implements org.locationtech.geowave.analytics.distance.DistanceFn","name":"commonDistanceFunctionClass","required":false},{"in":"query","type":"string","description":"Maximum hdfs input split size","name":"extractMaxInputSplit","required":true},{"in":"query","type":"string","description":"Minimum hdfs input split size","name":"extractMinInputSplit","required":true},{"in":"query","type":"string","description":"Query","name":"extractQuery","required":false},{"in":"query","type":"string","description":"Output Format Class","name":"outputOutputFormat","required":false},{"in":"query","type":"string","description":"Input Format Class","name":"inputFormatClass","required":false},{"in":"query","type":"string","description":"Input Path","name":"inputHdfsPath","required":false},{"in":"query","type":"string","description":"Number of Reducers For Output","name":"outputReducerCount","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"The comma-separated list of authorizations used during extract; by default all authorizations are used.","name":"authorizations","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"The comma-separated list of data typess to query; by default all data types are used.","name":"typeNames","required":true},{"in":"query","type":"string","description":"The specific index to query; by default one is chosen for each adapter.","name":"indexName","required":false},{"in":"query","type":"string","description":"Output HDFS File Path","name":"outputHdfsOutputPath","required":true},{"in":"query","type":"string","description":"Maximum number of members selected from a partition","name":"partitionMaxMemberSelection","required":false},{"in":"query","type":"string","description":"Index Identifier for Centroids","name":"partitionPartitionerClass","required":false},{"in":"query","type":"string","description":"Maximum Partition Distance","name":"partitionMaxDistance","required":true},{"in":"query","type":"string","description":"Partition Precision","name":"partitionPartitionPrecision","required":false},{"in":"query","type":"string","description":"Comma separated list of distance thresholds, per dimension","name":"partitioningDistanceThresholds","required":false},{"in":"query","type":"string","description":"Geometric distance unit (m\u003dmeters,km\u003dkilometers, see symbols for javax.units.BaseUnit)","name":"partitioningGeometricDistanceUnit","required":false},{"in":"query","type":"string","description":"Perform secondary partitioning with the provided class","name":"partitionSecondaryPartitionerClass","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/analytic/spatialjoin":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.spatialjoin","description":"Spatial Join using Spark ","parameters":[{"in":"query","type":"string","description":"main parameter","name":"left_storename","required":true},{"in":"query","type":"string","description":"main parameter","name":"right_storename","required":true},{"in":"query","type":"string","description":"main parameter","name":"output_storename","required":true},{"in":"query","type":"string","description":"The spark application name","name":"appName","required":false},{"in":"query","type":"string","description":"The spark driver host","name":"host","required":false},{"in":"query","type":"string","description":"The spark master designation","name":"master","required":false},{"in":"query","type":"integer","description":"The default partition count to set for Spark RDDs. Should be big enough to support largest RDD that will be used. Sets spark.default.parallelism","name":"partCount","required":false},{"in":"query","type":"string","description":"Feature type name of left Store to use in join","name":"leftAdapterTypeName","required":false},{"in":"query","type":"string","description":"Feature type name of left join results.","name":"outLeftAdapterTypeName","required":false},{"in":"query","type":"string","description":"Feature type name of right Store to use in join","name":"rightAdapterTypeName","required":false},{"in":"query","type":"string","description":"Feature type name of right join results.","name":"outRightAdapterTypeName","required":false},{"in":"query","type":"string","description":"Name of the UDF function to use when performing Spatial Join","name":"predicate","required":false},{"in":"query","type":"string","description":"Used for distance join predicate and other spatial operations that require a scalar radius.","name":"radius","required":false},{"in":"query","type":"boolean","description":"Used for testing a negative result from geometry predicate. i.e GeomIntersects() \u003d\u003d false","name":"negativeTest","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/analytic/sql":{"post":{"operationId":"org.locationtech.geowave.analytic.mapreduce.operations.AnalyticSection.sql","description":"SparkSQL queries","parameters":[{"in":"query","type":"array","items":{"type":"string"},"description":"\u003csql query\u003e - e.g. \u0027select * from %storename[|adaptername|viewName] where condition...\u0027","name":"parameters","required":false},{"in":"query","type":"string","description":"The spark application name","name":"appName","required":false},{"in":"query","type":"string","description":"The spark driver host","name":"host","required":false},{"in":"query","type":"string","description":"The spark master designation","name":"master","required":false},{"in":"query","type":"string","description":"The output CSV file name","name":"csvOutputFile","required":false},{"in":"query","type":"string","description":"The output datastore name","name":"outputStoreName","required":false},{"in":"query","type":"string","description":"The output feature type (adapter) name","name":"outputTypeName","required":false},{"in":"query","type":"integer","description":"Number of result rows to display","name":"showResults","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["analytic"]}},"/v0/config/addindex":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addindex","description":"Configure an index for usage in GeoWave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default index creating stores","name":"makeDefault","required":false},{"in":"query","type":"string","description":"The type of index, such as spatial, or spatial_temporal","name":"type","required":true},{"in":"query","type":"string","description":"A custom name can be given to this index. Default name will be the based on configuration parameters.","name":"nameOverride","required":false},{"in":"query","type":"integer","description":"The number of partitions. Default partitions will be 1.","name":"numPartitions","required":false},{"in":"query","type":"string","description":"The partition strategy to use. Default will be none.","name":"partitionStrategy","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addindex/spatial":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addindex/spatial","description":"Configure an index for usage in GeoWave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default index creating stores","name":"makeDefault","required":false},{"in":"query","type":"string","description":"A custom name can be given to this index. Default name will be the based on configuration parameters.","name":"nameOverride","required":false},{"in":"query","type":"integer","description":"The number of partitions. Default partitions will be 1.","name":"numPartitions","required":false},{"in":"query","type":"string","description":"The partition strategy to use. Default will be none.","name":"partitionStrategy","required":false},{"in":"query","type":"boolean","description":"The index will store temporal values. This allows it to slightly more efficiently run spatial-temporal queries although if spatial-temporal queries are a common use case, a separate spatial-temporal index is recommended.","name":"storeTime","required":false},{"in":"query","type":"string","description":"The native Coordinate Reference System used within the index. All spatial data will be projected into this CRS for appropriate indexing as needed.","name":"crs","required":false},{"in":"query","type":"integer","description":"The maximum precision of the geometry when encoding. Lower precision will save more disk space when encoding. (Between -8 and 7)","name":"geometryPrecision","required":false},{"in":"query","type":"boolean","description":"If specified, geometry will be encoded losslessly. Uses more disk space.","name":"fullGeometryPrecision","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addindex/spatial_temporal":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addindex/spatial_temporal","description":"Configure an index for usage in GeoWave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default index creating stores","name":"makeDefault","required":false},{"in":"query","type":"string","description":"A custom name can be given to this index. Default name will be the based on configuration parameters.","name":"nameOverride","required":false},{"in":"query","type":"integer","description":"The number of partitions. Default partitions will be 1.","name":"numPartitions","required":false},{"in":"query","type":"string","description":"The partition strategy to use. Default will be none.","name":"partitionStrategy","required":false},{"in":"query","type":"string","description":"The periodicity of the temporal dimension. Because time is continuous, it is binned at this interval.","name":"periodicity","required":false},{"in":"query","type":"string","description":"The bias of the spatial-temporal index. There can be more precision given to time or space if necessary.","name":"bias","required":false},{"in":"query","type":"long","description":"The max number of duplicates per dimension range. The default is 2 per range (for example lines and polygon timestamp data would be up to 4 because its 2 dimensions, and line/poly time range data would be 8).","name":"maxDuplicates","required":false},{"in":"query","type":"string","description":"The native Coordinate Reference System used within the index. All spatial data will be projected into this CRS for appropriate indexing as needed.","name":"crs","required":false},{"in":"query","type":"integer","description":"The maximum precision of the geometry when encoding. Lower precision will save more disk space when encoding. (Between -8 and 7)","name":"geometryPrecision","required":false},{"in":"query","type":"boolean","description":"If specified, geometry will be encoded losslessly. Uses more disk space.","name":"fullGeometryPrecision","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addindexgrp":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addindexgrp","description":"Create an index group for usage in GeoWave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"main parameter","name":"indexes","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"The type of store, such as accumulo, hbase, etc","name":"storeType","required":true},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/accumulo":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/accumulo","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"A comma-separated list of zookeeper servers that an Accumulo instance is using","name":"zookeeper","required":true},{"in":"query","type":"string","description":"The Accumulo instance ID","name":"instance","required":true},{"in":"query","type":"string","description":"A valid Accumulo user ID","name":"user","required":true},{"in":"query","type":"string","description":"The password for the user. Can be specified as \u0027pass:\u003cpassword\u003e\u0027, \u0027file:\u003clocal file containing the password\u003e\u0027, \u0027propfile:\u003clocal properties file containing the password\u003e:\u003cproperty file key\u003e\u0027, \u0027env:\u003cvariable containing the pass\u003e\u0027, or stdin","name":"password","required":false},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"boolean","name":"useLocalityGroups","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/bigtable":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/bigtable","description":"Create a BigTable store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"integer","name":"scanCacheSize","required":false},{"in":"query","type":"string","name":"projectId","required":false},{"in":"query","type":"string","name":"instanceId","required":false},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/cassandra":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/cassandra","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"A single contact point or a comma delimited set of contact points to connect to the Cassandra cluster.","name":"contactPoints","required":true},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"integer","description":"The number of inserts in a batch write.","name":"batchWriteSize","required":false},{"in":"query","type":"boolean","description":"Whether to write to commit log for durability, configured only on creation of new keyspace.","name":"durableWrites","required":false},{"in":"query","type":"integer","description":"The number of replicas to use when creating a new keyspace.","name":"replicationFactor","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/dynamodb":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/dynamodb","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"The endpoint to connect to(specify either endpoint/region not both) ","name":"endpoint","required":false},{"in":"query","type":"string","description":"The AWS region to use(specify either endpoint/region not both)","name":"region","required":false},{"in":"query","type":"long","name":"writeCapacity","required":false},{"in":"query","type":"long","name":"readCapacity","required":false},{"in":"query","type":"integer","description":"The maximum number of open http(s) connections active at any given time","name":"maxConnections","required":false},{"in":"query","type":"string","description":"The protocol to use. HTTP or HTTPS","name":"protocol","required":false},{"in":"query","type":"boolean","description":"Whether to cache responses from aws(true or false). High performance systems can disable this but debugging will be more difficult","name":"enableCacheResponseMetadata","required":false},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/hbase":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/hbase","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"A comma-separated list of zookeeper servers that an HBase instance is using","name":"zookeeper","required":true},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"integer","name":"scanCacheSize","required":false},{"in":"query","type":"boolean","name":"disableVerifyCoprocessors","required":false},{"in":"query","type":"string","description":"Path (HDFS URL) to the jar containing coprocessor classes","name":"coprocessorJar","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/kudu":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/kudu","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"An URL for the Kudu master node","name":"kuduMaster","required":true},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/redis":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/redis","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"The address to connect to, such as redis://127.0.0.1:6379","name":"address","required":true},{"in":"query","type":"string","description":"Can be \"snappy\",\"lz4\", or \"none\". Defaults to snappy.","name":"compression","required":false},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/addstore/rocksdb":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.addstore/rocksdb","description":"Create a store within Geowave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"boolean","description":"Make this the default store in all operations","name":"makeDefault","required":false},{"in":"query","type":"string","description":"The directory to read/write to. Defaults to \"rocksdb\" in the working directory.","name":"directory","required":false},{"in":"query","type":"boolean","description":"Whether to compact on every write, if false it will only compact on merge. Defaults to true","name":"compactOnWrite","required":false},{"in":"query","type":"integer","description":"The size (in records) for each batched write. Anything \u003c\u003d 1 will use synchronous single record writes without batching. Defaults to 1000.","name":"batchWriteSize","required":false},{"in":"query","type":"string","description":"The geowave namespace (optional; default is no namespace)","name":"geowaveNamespace","required":false},{"in":"query","type":"boolean","name":"persistDataStatistics","required":false},{"in":"query","type":"boolean","name":"enableBlockCache","required":false},{"in":"query","type":"boolean","name":"enableServerSideLibrary","required":false},{"in":"query","type":"boolean","name":"enableSecondaryIndexing","required":false},{"in":"query","type":"boolean","name":"configuredEnableVisibility","required":false},{"in":"query","type":"integer","name":"configuredDataIndexBatchSize","required":false},{"in":"query","type":"integer","name":"configuredMaxRangeDecomposition","required":false},{"in":"query","type":"integer","name":"configuredAggregationMaxRangeDecomposition","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/geoserver":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.geoserver","description":"Create a local configuration for GeoServer","parameters":[{"in":"query","type":"string","description":"GeoServer User","name":"username","required":false},{"in":"query","type":"string","description":"GeoServer Password - Can be specified as \u0027pass:\u003cpassword\u003e\u0027, \u0027file:\u003clocal file containing the password\u003e\u0027, \u0027propfile:\u003clocal properties file containing the password\u003e:\u003cproperty file key\u003e\u0027, \u0027env:\u003cvariable containing the pass\u003e\u0027, or stdin","name":"pass","required":false},{"in":"query","type":"string","description":"GeoServer Default Workspace","name":"workspace","required":false},{"in":"query","type":"string","description":"main parameter","name":"GeoServer_URL","required":true},{"in":"query","type":"string","description":"Specify the Transport Layer Security (TLS) protocol to use when connecting to the server. By default, the system will use TLS.","name":"sslSecurityProtocol","required":false},{"in":"query","type":"string","description":"Specify the absolute path to where truststore file is located on system. The truststore file is used to validate client certificates.","name":"sslTrustStorePath","required":false},{"in":"query","type":"string","description":"Specify the password to use to access the truststore file. - Can be specified as \u0027pass:\u003cpassword\u003e\u0027, \u0027file:\u003clocal file containing the password\u003e\u0027, \u0027propfile:\u003clocal properties file containing the password\u003e:\u003cproperty file key\u003e\u0027, \u0027env:\u003cvariable containing the pass\u003e\u0027, or stdin","name":"sslTrustStorePassword","required":false},{"in":"query","type":"string","description":"Specify the type of key store used for the truststore, i.e. JKS (Java KeyStore).","name":"sslTrustStoreType","required":false},{"in":"query","type":"string","description":"Specify the name of the truststore provider to be used for the server certificate.","name":"sslTrustStoreProvider","required":false},{"in":"query","type":"string","description":"Specify the algorithm to use for the truststore.","name":"sslTrustManagerAlgorithm","required":false},{"in":"query","type":"string","description":"Specify the trust manager factory provider.","name":"sslTrustManagerProvider","required":false},{"in":"query","type":"string","description":"Specify the absolute path to where the keystore file is located on system. The keystore contains the server certificate to be loaded.","name":"sslKeyStorePath","required":false},{"in":"query","type":"string","description":"Specify the password to use to access the keystore file. - Can be specified as \u0027pass:\u003cpassword\u003e\u0027, \u0027file:\u003clocal file containing the password\u003e\u0027, \u0027propfile:\u003clocal properties file containing the password\u003e:\u003cproperty file key\u003e\u0027, \u0027env:\u003cvariable containing the pass\u003e\u0027, or stdin","name":"sslKeyStorePassword","required":false},{"in":"query","type":"string","description":"Specify the name of the keystore provider to be used for the server certificate.","name":"sslKeyStoreProvider","required":false},{"in":"query","type":"string","description":"Specify the password to be used to access the server certificate from the specified keystore file. - Can be specified as \u0027pass:\u003cpassword\u003e\u0027, \u0027file:\u003clocal file containing the password\u003e\u0027, \u0027propfile:\u003clocal properties file containing the password\u003e:\u003cproperty file key\u003e\u0027, \u0027env:\u003cvariable containing the pass\u003e\u0027, or stdin","name":"sslKeyPassword","required":false},{"in":"query","type":"string","description":"The type of keystore file to be used for the server certificate.","name":"sslKeyStoreType","required":false},{"in":"query","type":"string","description":"Specify the algorithm to use for the keystore.","name":"sslKeyManagerAlgorithm","required":false},{"in":"query","type":"string","description":"Specify the key manager factory provider.","name":"sslKeyManagerProvider","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/hdfs":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.hdfs","description":"Create a local configuration for HDFS","parameters":[{"in":"query","type":"string","description":"main parameter","name":"HDFS_DefaultFS_URL","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/list":{"get":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.list","description":"List property name within cache","parameters":[{"in":"query","type":"string","name":"filter","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/rmindex":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.rmindex","description":"Remove index configuration from Geowave configuration","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/rmindexgrp":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.rmindexgrp","description":"Remove index group from Geowave configuration","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/rmstore":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.rmstore","description":"Remove store from Geowave configuration","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/config/set":{"post":{"operationId":"org.locationtech.geowave.core.cli.operations.config.ConfigSection.set","description":"Set property name within cache","parameters":[{"in":"query","type":"string","description":"main parameter","name":"name","required":true},{"in":"query","type":"string","description":"main parameter","name":"value","required":true},{"in":"query","type":"boolean","description":"Specify if the value being set is a password and should be encrypted in the configurations","name":"password","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["config"]}},"/v0/gs/addcs":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addcs","description":"Add a GeoServer coverage store","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"coverage store name","name":"coverageStore","required":false},{"in":"query","type":"boolean","description":"This parameter will override the behavior to always perform histogram equalization if a histogram exists. Valid values are true and false.","name":"equalizeHistogramOverride","required":false},{"in":"query","type":"string","description":"This will override the default interpolation stored for each layer. Valid values are 0, 1, 2, 3 for NearestNeighbor, Bilinear, Bicubic, and Bicubic (polynomial variant) resepctively. ","name":"interpolationOverride","required":false},{"in":"query","type":"boolean","description":"By default, integer values will automatically be scaled to 8-bit and floating point values will not. This can be overridden setting this value to true or false.","name":"scaleTo8Bit","required":false},{"in":"query","type":"string","description":"main parameter","name":"GeoWave_store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/addcv":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addcv","description":"Add a GeoServer coverage","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"coverage store name","name":"cvgstore","required":true},{"in":"query","type":"string","description":"main parameter","name":"coverage_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/addds":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addds","description":"Add a GeoServer datastore","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"datastore name","name":"datastore","required":false},{"in":"query","type":"string","description":"main parameter","name":"GeoWave_store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/addfl":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addfl","description":"Add a GeoServer feature layer","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"datastore name","name":"datastore","required":true},{"in":"query","type":"string","description":"main parameter","name":"layer_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/addlayer":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addlayer","description":"Add a GeoServer layer from the given GeoWave store","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"For multiple layers, add (all | raster | vector)","name":"addOption","required":false},{"in":"query","type":"string","description":"select just \u003cadapter id\u003e from the store","name":"adapterId","required":false},{"in":"query","type":"string","description":"default style sld","name":"style","required":false},{"in":"query","type":"string","description":"main parameter","name":"GeoWave_store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/addstyle":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addstyle","description":"Add a GeoServer style","parameters":[{"in":"query","type":"string","description":"style sld file","name":"stylesld","required":true},{"in":"query","type":"string","description":"main parameter","name":"GeoWave_style_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/addws":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.addws","description":"Add GeoServer workspace","parameters":[{"in":"query","type":"string","description":"main parameter","name":"workspace_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/getcs":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.getcs","description":"Get GeoServer CoverageStore info","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"main parameter","name":"coverage_store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/getcv":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.getcv","description":"Get a GeoServer coverage\u0027s info","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"coverage store name","name":"cvgstore","required":true},{"in":"query","type":"string","description":"main parameter","name":"coverage_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/getds":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.getds","description":"Get GeoServer DataStore info","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"main parameter","name":"datastore_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/getfl":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.getfl","description":"Get GeoServer feature layer info","parameters":[{"in":"query","type":"string","description":"main parameter","name":"layer_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/getsa":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.getsa","description":"Get GeoWave store adapters","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/getstyle":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.getstyle","description":"Get GeoServer Style info","parameters":[{"in":"query","type":"string","description":"main parameter","name":"style_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/listcs":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.listcs","description":"List GeoServer coverage stores","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/listcv":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.listcv","description":"List GeoServer Coverages","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"main parameter","name":"coverage_store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/listds":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.listds","description":"List GeoServer datastores","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/listfl":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.listfl","description":"List GeoServer feature layers","parameters":[{"in":"query","type":"string","description":"Workspace Name","name":"workspace","required":false},{"in":"query","type":"string","description":"Datastore Name","name":"datastore","required":false},{"in":"query","type":"boolean","description":"Show only GeoWave feature layers (default: false)","name":"geowaveOnly","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/liststyles":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.liststyles","description":"List GeoServer styles","parameters":[],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/listws":{"get":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.listws","description":"List GeoServer workspaces","parameters":[],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/rmcs":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.rmcs","description":"Remove GeoServer Coverage Store","parameters":[{"in":"query","type":"string","description":"Workspace Name","name":"workspace","required":false},{"in":"query","type":"string","description":"main parameter","name":"coverage_store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/rmcv":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.rmcv","description":"Remove a GeoServer coverage","parameters":[{"in":"query","type":"string","description":"workspace name","name":"workspace","required":false},{"in":"query","type":"string","description":"coverage store name","name":"cvgstore","required":true},{"in":"query","type":"string","description":"main parameter","name":"coverage_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/rmds":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.rmds","description":"Remove GeoServer DataStore","parameters":[{"in":"query","type":"string","description":"Workspace Name","name":"workspace","required":false},{"in":"query","type":"string","description":"main parameter","name":"datastore_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/rmfl":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.rmfl","description":"Remove GeoServer feature Layer","parameters":[{"in":"query","type":"string","description":"main parameter","name":"layer_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/rmstyle":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.rmstyle","description":"Remove GeoServer Style","parameters":[{"in":"query","type":"string","description":"main parameter","name":"style_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/rmws":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.rmws","description":"Remove GeoServer workspace","parameters":[{"in":"query","type":"string","description":"main parameter","name":"workspace_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/gs/setls":{"post":{"operationId":"org.locationtech.geowave.cli.geoserver.GeoServerSection.setls","description":"Set GeoServer Layer Style","parameters":[{"in":"query","type":"string","description":"style name","name":"styleName","required":true},{"in":"query","type":"string","description":"main parameter","name":"layer_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["gs"]}},"/v0/ingest/kafkaToGW":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.kafkaToGW","description":"Subscribe to a Kafka topic and ingest into GeoWave","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"main parameter","name":"index_group_list","required":true},{"in":"query","type":"string","description":"The visibility of the data ingested (optional; default is \u0027public\u0027)","name":"visibility","required":false},{"in":"query","type":"string","description":"A string that uniquely identifies the group of consumer processes to which this consumer belongs. By setting the same group id multiple processes indicate that they are all part of the same consumer group.","name":"groupId","required":false},{"in":"query","type":"string","description":"Specifies the ZooKeeper connection string in the form hostname:port where host and port are the host and port of a ZooKeeper server. To allow connecting through other ZooKeeper nodes when that ZooKeeper machine is down you can also specify multiple hosts in the form hostname1:port1,hostname2:port2,hostname3:port3.","name":"zookeeperConnect","required":false},{"in":"query","type":"string","description":"What to do when there is no initial offset in ZooKeeper or if an offset is out of range:\n\t* smallest : automatically reset the offset to the smallest offset\n\t* largest : automatically reset the offset to the largest offset\n\t* anything else: throw exception to the consumer\n","name":"autoOffsetReset","required":false},{"in":"query","type":"string","description":"The number of bytes of messages to attempt to fetch for each topic-partition in each fetch request. These bytes will be read into memory for each partition, so this helps control the memory used by the consumer. The fetch request size must be at least as large as the maximum message size the server allows or else it is possible for the producer to send messages larger than the consumer can fetch.","name":"fetchMessageMaxBytes","required":false},{"in":"query","type":"string","description":"By default, this value is -1 and a consumer blocks indefinitely if no new message is available for consumption. By setting the value to a positive integer, a timeout exception is thrown to the consumer if no message is available for consumption after the specified timeout value.","name":"consumerTimeoutMs","required":false},{"in":"query","type":"boolean","description":"This flag will flush when the consumer timeout occurs (based on kafka property \u0027consumer.timeout.ms\u0027) and immediately reconnect","name":"reconnectOnTimeout","required":false},{"in":"query","type":"integer","description":"The data will automatically flush after this number of entries","name":"batchSize","required":false},{"in":"query","type":"string","description":"Properties file containing Kafka properties","name":"kafkaPropertyFile","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/listplugins":{"get":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.listplugins","description":"List supported data store types, index types, and ingest formats","parameters":[],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/localToGW":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.localToGW","description":"Ingest supported files in local file system directly, from S3 or from HDFS ","parameters":[{"in":"query","type":"string","description":"main parameter","name":"file_or_directory","required":true},{"in":"query","type":"string","description":"main parameter","name":"storename","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"main parameter","name":"index_group_list","required":true},{"in":"query","type":"integer","description":"number of threads to use for ingest, default to 1 (optional)","name":"threads","required":false},{"in":"query","type":"string","description":"The visibility of the data ingested (optional; default is \u0027public\u0027)","name":"visibility","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/localToHdfs":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.localToHdfs","description":"Stage supported files in local file system to HDFS","parameters":[{"in":"query","type":"string","description":"main parameter","name":"file_or_directory","required":true},{"in":"query","type":"string","description":"main parameter","name":"path_to_base_directory_to_write_to","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/localToKafka":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.localToKafka","description":"Stage supported files in local file system to a Kafka topic","parameters":[{"in":"query","type":"string","description":"main parameter","name":"file_or_directory","required":true},{"in":"query","type":"string","description":"This is for bootstrapping and the producer will only use it for getting metadata (topics, partitions and replicas). The socket connections for sending the actual data will be established based on the broker information returned in the metadata. The format is host1:port1,host2:port2, and the list can be a subset of brokers or a VIP pointing to a subset of brokers.","name":"metadataBrokerList","required":false},{"in":"query","type":"string","description":"This value controls when a produce request is considered completed. Specifically, how many other brokers must have committed the data to their log and acknowledged this to the leader?","name":"requestRequiredAcks","required":false},{"in":"query","type":"string","description":"This parameter specifies whether the messages are sent asynchronously in a background thread. Valid values are (1) async for asynchronous send and (2) sync for synchronous send. By setting the producer to async we allow batching together of requests (which is great for throughput) but open the possibility of a failure of the client machine dropping unsent data.","name":"producerType","required":false},{"in":"query","type":"string","description":"The serializer class for messages. The default encoder takes a byte[] and returns the same byte[].","name":"serializerClass","required":false},{"in":"query","type":"string","description":"The amount of time to wait before attempting to retry a failed produce request to a given topic partition. This avoids repeated sending-and-failing in a tight loop.","name":"retryBackoffMs","required":false},{"in":"query","type":"string","description":"Properties file containing Kafka properties","name":"kafkaPropertyFile","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/localToMrGW":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.localToMrGW","description":"Copy supported files from local file system to HDFS and ingest from HDFS","parameters":[{"in":"query","type":"string","description":"main parameter","name":"file_or_directory","required":true},{"in":"query","type":"string","description":"main parameter","name":"path_to_base_directory_to_write_to","required":true},{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"main parameter","name":"index_group_list","required":true},{"in":"query","type":"string","description":"The visibility of the data ingested (optional; default is \u0027public\u0027)","name":"visibility","required":false},{"in":"query","type":"string","description":"Hadoop job tracker hostname and port in the format hostname:port","name":"jobTrackerHostPort","required":false},{"in":"query","type":"string","description":"Yarn resource manager hostname and port in the format hostname:port","name":"resourceManager","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"Job configuration property in the format Name\u003dValue","name":"configurationProperties","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/mrToGW":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.mrToGW","description":"Ingest supported files that already exist in HDFS","parameters":[{"in":"query","type":"string","description":"main parameter","name":"path_to_base_directory_to_write_to","required":true},{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"main parameter","name":"index_group_list","required":true},{"in":"query","type":"string","description":"The visibility of the data ingested (optional; default is \u0027public\u0027)","name":"visibility","required":false},{"in":"query","type":"string","description":"Hadoop job tracker hostname and port in the format hostname:port","name":"jobTrackerHostPort","required":false},{"in":"query","type":"string","description":"Yarn resource manager hostname and port in the format hostname:port","name":"resourceManager","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"Job configuration property in the format Name\u003dValue","name":"configurationProperties","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/ingest/sparkToGW":{"post":{"operationId":"org.locationtech.geowave.core.ingest.operations.IngestSection.sparkToGW","description":"Ingest supported files that already exist in HDFS or S3","parameters":[{"in":"query","type":"string","description":"main parameter","name":"input_directory","required":true},{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"array","items":{"type":"string"},"description":"main parameter","name":"index_group_list","required":true},{"in":"query","type":"string","description":"The visibility of the data ingested (optional; default is \u0027public\u0027)","name":"visibility","required":false},{"in":"query","type":"string","description":"The spark application name","name":"appName","required":false},{"in":"query","type":"string","description":"The spark driver host","name":"host","required":false},{"in":"query","type":"string","description":"The spark master designation","name":"master","required":false},{"in":"query","type":"integer","description":"Number of executors","name":"numExecutors","required":false},{"in":"query","type":"integer","description":"Number of cores","name":"numCores","required":false},{"in":"query","type":"array","items":{"type":"string"},"description":"individual or comma-delimited set of file extensions to accept (optional)","name":"extensions","required":false},{"in":"query","type":"string","description":"Explicitly set the ingest formats by name (or multiple comma-delimited formats), if not set all available ingest formats will be used","name":"formats","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["ingest"]}},"/v0/remote/calcstat":{"post":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.calcstat","description":"Calculate a specific statistic in the remote store, given adapter ID and statistic ID","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"string","description":"main parameter","name":"datatype_name","required":true},{"in":"query","type":"string","description":"main parameter","name":"stat_type","required":true},{"in":"query","type":"string","description":"If the statistic is maintained per field, optionally provide a field name","name":"fieldName","required":false},{"in":"query","type":"string","description":"The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.","name":"authorizations","required":false},{"in":"query","type":"boolean","description":"Output in JSON format.","name":"jsonFormatFlag","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/clear":{"post":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.clear","description":"Clear ALL data from a GeoWave store and delete tables","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/listindices":{"get":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.listindices","description":"Display all indices in this remote store","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/liststats":{"get":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.liststats","description":"Print statistics of an existing GeoWave dataset to standard output. ","parameters":[{"in":"query","type":"string","description":"Optionally list a single data type\u0027s stats","name":"typeName","required":false},{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"string","description":"The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.","name":"authorizations","required":false},{"in":"query","type":"boolean","description":"Output in JSON format.","name":"jsonFormatFlag","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/listtypes":{"get":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.listtypes","description":"Display all type names in this remote store","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/recalcstats":{"post":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.recalcstats","description":"Calculate the statistics of an existing GeoWave dataset","parameters":[{"in":"query","type":"string","description":"Optionally recalculate a single datatype\u0027s stats","name":"typeName","required":false},{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"string","description":"The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.","name":"authorizations","required":false},{"in":"query","type":"boolean","description":"Output in JSON format.","name":"jsonFormatFlag","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/rmstat":{"post":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.rmstat","description":"Remove a statistic from the remote store. You will be prompted with are you sure","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"string","description":"main parameter","name":"datatype_name","required":true},{"in":"query","type":"string","description":"main parameter","name":"stat_type","required":true},{"in":"query","type":"string","description":"If the statistic is maintained per field, optionally provide a field name","name":"fieldName","required":false},{"in":"query","type":"string","description":"The authorizations used for the statistics calculation as a subset of the accumulo user authorization; by default all authorizations are used.","name":"authorizations","required":false},{"in":"query","type":"boolean","description":"Output in JSON format.","name":"jsonFormatFlag","required":false}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/rmtype":{"post":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.rmtype","description":"Remove an data type from the remote store and all associated data of that type","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true},{"in":"query","type":"string","description":"main parameter","name":"datatype_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/remote/version":{"get":{"operationId":"org.locationtech.geowave.core.store.cli.remote.RemoteSection.version","description":"Get the version of GeoWave running on the instance of a remote datastore","parameters":[{"in":"query","type":"string","description":"main parameter","name":"store_name","required":true}],"responses":{"200":{"description":"success"},"404":{"description":"route not found"},"500":{"description":"invalid or null parameter"}},"tags":["remote"]}},"/v0/fileupload": {"post":{"operationId": "fileupload","consumes": ["multipart/form-data"],"description": "Get the version of GeoWave running on the instance of a remote datastore","parameters": [{"name": "body","description": "file detail","required": false,"type": "file","paramType": "body","in": "formData","allowMultiple": false }], "responses": { "200": { "description": "success" },"404": { "description": "route not found"},"500": { "description": "invalid or null parameter"} },"tags": ["fileupload"]}}}}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.