Enums

Enumerations for the geobox API.

class InputGeomType(*values)

Bases: Enum

POINT = 'POINT'

LINESTRING = 'LINESTRING'

POLYGON = 'POLYGON'

MULTIPOINT = 'MULTIPOINT'

MULTILINESTRING = 'MULTILINESTRING'

MULTIPOLYGON = 'MULTIPOLYGON'

POINT_Z = 'POINTZ'

LINESTRING_Z = 'LINESTRINGZ'

POLYGON_Z = 'POLYGONZ'

MULTIPOINT_Z = 'MULTIPOINTZ'

MULTILINESTRING_Z = 'MULTILINESTRINGZ'

MULTIPOLYGON_Z = 'MULTIPOLYGONZ'

class PublishFileType(*values)

Bases: Enum

VECTOR = 'vector'

RASTER = 'raster'

MODEL3D = 'model3d'

Tiles3D = 'tiles3d'

TABLE = 'table'

class FileType(*values)

Bases: Enum

Compressed = 'Compressed'

Complex = 'Complex'

Image = 'Image'

Video = 'Video'

Document = 'Document'

GPKG = 'GPKG'

DXF = 'DXF'

GPX = 'GPX'

CSV = 'CSV'

Shapefile = 'Shapefile'

KML = 'KML'

GLB = 'GLB'

FileGDB = 'FileGDB'

GeoTIFF = 'GeoTIFF'

GeoJSON = 'GeoJSON'

ThreedTiles = 'ThreedTiles'

class FileFormat(*values)

Bases: Enum

Shapefile = '.shp'

FileGDB = '.gdb'

CSV = '.csv'

KML = '.kml'

DXF = '.dxf'

GPX = '.gpx'

GPKG = '.gpkg'

GeoJSON = '.geojson'

JPG = '.jpg'

JPEG = '.jpeg'

SVG = '.svg'

PNG = '.png'

BMP = '.bmp'

TIF = '.tif'

GIF = '.gif'

MP4 = '.mp4'

AVI = '.avi'

OGG = '.ogg'

WEBM = '.webm'

MPEG = '.mpeg'

WMV = '.wmv'

TXT = '.txt'

DOC = '.doc'

DOCX = '.docx'

XLS = '.xls'

XLSX = '.xlsx'

PPT = '.ppt'

PPTX = '.pptx'

PDF = '.pdf'

ZIP = '.zip'

SEVEN_Z = '.7z'

RAR = '.rar'

ISO = '.iso'

GZ = '.gz'

BZ2 = '.bz2'

TAR = '.tar'

CAB = '.cab'

IMG = '.img'

class FieldType(*values)

Bases: Enum

A class representing the data type of a field.

Integer = 'Integer'

An integer field.

Float = 'Float'

A float field.

String = 'String'

A string field.

Long = 'Long'

A Long field.

DATE = 'Date'

A Date field.

TIME = 'Time'

A Time Field.

DATETIME = 'DateTime'

A DateTime Field.

class LayerType(*values)

Bases: Enum

Enumeration of supported vector layer geometry types.

This enum defines the different types of geometric shapes that can be stored in a vector layer. Each type represents a specific geometric structure supported by the Geobox API.

Point = 'Point'

A single point in 2D space

MultiPoint = 'MultiPoint'

A collection of points

Polygon = 'Polygon'

A closed shape defined by a sequence of points

Polyline = 'Polyline'

A polyline geometry

class FeatureType(*values)

Bases: Enum

Enumeration of supported feature geometry types.

This enum defines the different types of geometric shapes that can be stored in a feature. Each type represents a specific geometric structure supported by the Geobox API.

Point = 'Point'

A single point in 2D space

MultiPoint = 'MultiPoint'

A collection of points

LineString = 'LineString'

A sequence of points forming a line

MultiLineString = 'MultiLineString'

A collection of lines

Polygon = 'Polygon'

A closed shape defined by a sequence of points

MultiPolygon = 'MultiPolygon'

A collection of polygons

class TaskStatus(*values)

Bases: Enum

Enumeration of possible task statuses.

PENDING = 'PENDING'

The task is pending.

PROGRESS = 'PROGRESS'

The task is in progress.

SUCCESS = 'SUCCESS'

The task is successful.

FAILURE = 'FAILURE'

The task is failed.

ABORTED = 'ABORTED'

The task is aborted.

class QueryGeometryType(*values)

Bases: Enum

Enumeration of possible query geometry types.

POINT = 'Point'

A point geometry.

MULTIPOINT = 'Multipoint'

A multipoint geometry.

POLYLINE = 'Polyline'

A polyline geometry.

POLYGON = 'Polygon'

A polygon geometry.

class QueryParamType(*values)

Bases: Enum

Enumeration of possible query parameter types.

LAYER = 'Layer'

A layer parameter.

TABLE = 'Table'

A table parameter.

ATTRIBUTE = 'Attribute'

A Attribute parameter.

FLOAT = 'Float'

A Float parameter.

INTEGER = 'Integer'

A Integer parameter.

TEXT = 'Text'

A Text parameter.

BOOLEAN = 'Boolean'

A Boolean parameter.

class UserRole(*values)

Bases: Enum

SYSTEM_ADMIN = 'System Admin'

ACCOUNT_ADMIN = 'Account Admin'

PUBLISHER = 'Publisher'

EDITOR = 'Editor'

VIEWER = 'Viewer'

class UserStatus(*values)

Bases: Enum

NEW = 'New'

PENDING = 'Pending'

ACTIVE = 'Active'

DISABLED = 'Disabled'

class MaxLogPolicy(*values)

Bases: Enum

OverwriteFirstLog = 'OverwriteFirstLog'

IgnoreLogging = 'IgnoreLogging'

class InvalidDataPolicy(*values)

Bases: Enum

ReportToAdmin = 'ReportToAdmin'

LogOnly = 'LogOnly'

class LoginFailurePolicy(*values)

Bases: Enum

BlockIPTemporarily = 'BlockIPTemporarily'

DisableAccount = 'DisableAccount'

class MaxConcurrentSessionPolicy(*values)

Bases: Enum

CloseLastSession = 'CloseLastSession'

CloseMostInactiveSession = 'CloseMostInactiveSession'

PreventNewSession = 'PreventNewSession'

class RoutingGeometryType(*values)

Bases: Enum

geojson = 'geojson'

polyline = 'polyline'

polyline6 = 'polyline6'

class RoutingOverviewLevel(*values)

Bases: Enum

Full = 'full'

Simplified = 'simplified'

class QueryResultType(*values)

Bases: Enum

metadata = 'metadata'

data = 'data'

both = 'both'

class FileOutputFormat(*values)

Bases: Enum

Shapefile = 'Shapefile'

GPKG = 'GPKG'

GeoJSON = 'GeoJSON'

CSV = 'CSV'

KML = 'KML'

DXF = 'DXF'

class UsageScale(*values)

Bases: Enum

Hour = 'hour'

Day = 'day'

Month = 'month'

class UsageParam(*values)

Bases: Enum

Traffict = 'traffic'

Calls = 'calls'

class AnalysisDataType(*values)

Bases: Enum

uint8 = 'uint8'

uint16 = 'uint16'

int16 = 'int16'

uint32 = 'uint32'

int32 = 'int32'

float32 = 'float32'

float64 = 'float64'

class PolygonizeConnectivity(*values)

Bases: Enum

connected_8 = 8

connected_4 = 4

class AnalysisResampleMethod(*values)

Bases: Enum

near = 'near'

bilinear = 'bilinear'

cubic = 'cubic'

cubicspline = 'cubicspline'

lanczos = 'lanczos'

average = 'average'

mode = 'mode'

max = 'max'

min = 'min'

med = 'med'

q1 = 'q1'

q3 = 'q3'

rms = 'rms'

sum = 'sum'

class SlopeUnit(*values)

Bases: Enum

degree = 'degree'

percent = 'percent'

class AnalysisAlgorithm(*values)

Bases: Enum

Horn = 'Horn'

ZevenbergenThorne = 'ZevenbergenThorne'

class RangeBound(*values)

Bases: Enum

left = 'left'

right = 'right'

both = 'both'

neither = 'neither'

class DistanceUnit(*values)

Bases: Enum

GEO = 'GEO'

PIXEL = 'PIXEL'

class GroupByAggFunction(*values)

Bases: Enum

COUNT = 'count'

SUM = 'sum'

MIN = 'min'

MAX = 'max'

AVG = 'avg'

class NetworkTraceDirection(*values)

Bases: Enum

UP = 'up'

DOWN = 'down'

class SpatialAggFunction(*values)

Bases: Enum

COLLECT = 'collect'

UNION = 'union'

EXTENT = 'extent'

MAKELINE = 'makeline'

class SpatialPredicate(*values)

Bases: Enum

INTERSECT = 'Intersect'

CONTAIN = 'Contain'

CROSS = 'Cross'

EQUAL = 'Equal'

OVERLAP = 'Overlap'

TOUCH = 'Touch'

WITHIN = 'Within'

class TableExportFormat(*values)

Bases: Enum

CSV = 'CSV'

class RelationshipCardinality(*values)

Bases: Enum

OnetoOne = '1-1'

OnetoMany = '1-M'

ManytoMany = 'M-N'

class DBType(*values)

Bases: Enum

POSTGIS = 'postgis'

SQLSERVER = 'sqlserver'

ORACLE = 'oracle'

MYSQL = 'mysql'