Developer Guide

Lenses Box

The free version of Lenses

Lenses API Reference

Lenses CLI

Contents

• Lenses Box
  • Prerequisites
  • Getting Started
    • Step 1: Get Lenses Development Environment
    • Step 2: Single command, Up and Running with Examples
  • Access Lenses UI
  • Access Command Line
    • Kafka Cheat Sheet
  • Access Kafka Broker
  • Persist Data
  • Custom Hostname
  • Running Examples
    • View Example Topics
    • Run SQL Processors
    • View the topology
  • Connectors
  • FAQ
• Lenses CLI
  • Installation
  • Getting started
    • Passing credentials through flags
    • Configuration Contexts
    • Getting help
  • The –output flag
  • Access Control Lists
  • Alerts
  • Audits
  • Lenses Configuration
  • Connectors
  • Exporting
  • Importing
  • Interactive Shell
  • Logs
  • Data Policies
  • Processors
  • Query
  • Quotas
  • Schemas
  • Secrets
    • Modes
    • Secret Value Lookup
    • Vault Example
    • General Examples
  • Topics
  • User Profile
  • Troubleshooting
• API Reference
  • REST API
    • Authentication API
    • Topic API
      • Create Topic
      • Delete Topic
      • Delete Records from Topic-Partition up to a specified Offset
      • Update Topic Configuration
      • Get Topic information
    • Topic Metadata API
      • Retrieve All Stored Metadata
      • Retrieve Metadata For A Topic
      • Add Metadata For An Existing Topic
      • Delete Metadata For An Existing Topic
    • Data API
      • Lenses SQL URL Encoding
      • Lenses SQL Validation
      • Lenses SQL Get Data
    • Processor API
      • Get All Processors
      • Get a Processor
      • Create Processor
      • Pause Processor
      • Resume Processor
      • Update Processor Runners
      • Delete Processor
    • Access Control Lists API
      • Create/Update
      • Get ACLs
      • Delete ACLs
    • Alert API
      • Get All Alert Settings
      • Get an Alert Setting
      • Enabled an Alert Setting
      • Get Alert Setting Conditions
      • Create/Update an Alert Setting Condition
      • Delete an Alert Setting Condition
      • Get All Alert Notifications
      • Alert Identifiers
    • Alert SSE API
    • Prometheus API
    • Quota API
      • Get Quotas
      • Create/Update Quota - All Users
      • Create/Update Quota - User all Clients
      • Create/Update a Quota - User/Client pair
      • Create/Update a Quota - User
      • Create/Update Quota - All Clients
      • Create/Update a Quota - Client
      • Delete Quota - All Users
      • Delete Quota - User all Clients
      • Delete a Quota - User/Client pair
      • Delete a Quota - User
      • Delete Quota - All Clients
      • Delete a Quota - Client
    • Connector API
    • Schemas API
    • Logs API
    • Audits API
    • Audits API (SSE, Live updates)
    • Data Policies API
      • Get Obfuscation Types
      • Get categories
      • Get impact types
      • Get policies
      • Add a policy
      • Delete a policy
      • Update a policy
    • Audits API (SSE, Live updates)
    • Permissions Matrix
  • Web Socket API
    • Introduction
    • Protocol Definition
      • Login
      • Publishing
      • Subscription
      • Un-subscribe
      • Offsets Commit
      • Heartbeat
    • Working with New SQL Engine
• Knowledge Base
  • View Kafka message headers
• Lenses JDBC
  • Installation
  • Quick Start
  • Select
    • Nested Fields
    • Metadata
  • Insert
  • Prepared Statements
    • Setting Parameters
    • Batch Inserts
    • Metadata
  • Connection Parameters
  • Database Metadata
    • Table Level Information
    • Column Level Information
  • Unsupported Features
  • TroubleShooting
• Topology
  • Installation
  • Building a Topology
  • Submitting the Topology
  • Contents
    • Kafka Streams Metrics
      • Simple consumer/producer Metrics
    • Spark Structured Metrics
    • Akka Stream Metrics
    • Microservices
      • Lenses Microservices API
      • Sample project
• Clients / Python
  • Installation
    • Dependencies
    • Virtual Environment (Recommended)
    • Install Lenses Python
  • Getting started
    • Basic authentication
    • Kerberos authentication
  • SQL Data Handlers
  • Managing Topics
    • Topics Information
    • Create new topic
    • Update topic configuration
    • Delete topic
    • Delete topic records
  • Managing SQL Processors
    • Create new Processor
    • Deleting a Processor
    • Resume a Processor
    • Pause a Processor
    • Scale a Processor
  • Managing Schemas
    • List all Subjects
    • List Subject Versions
    • Get a Schema by ID
    • Register new Schema
    • Delete specific Subjects
    • Delete Schema by Version
    • Get Global Compatibility
    • Update Global Compatibility
    • Get Compatibility of a Subject
    • Change Compatibility of Subject
  • Managing Connectors
    • List Connectors
    • Get Connector Information
    • Get Connector Configuration
    • Get Connector Status
    • Get Connector Tasks
    • Get Status of specific Task
    • Create new Connector
    • Set Connector Configuration
    • Restart Connector Task
    • Delete a Connector
  • Continuous Queries
    • Subscribing
    • Publishing
    • Unsubscribe
    • Commit
  • ACLs Handler
    • Create/Update ACLs
    • Get ACLs
  • Quota Handler
    • Get Quotas
    • Create/Update Quota - All Users
    • Create/Update Quota - User all Clients
    • Create/Update a Quota - User/Client pair
    • Create/Update a Quota - User
    • Create/Update Quota - All Clients
    • Create/Update a Quota - Client
    • Delete Quota - All Users
    • Delete Quota - User all Clients
    • Delete a Quota - User/Client pair
    • Delete a Quota - User
    • Delete Quota - All Clients
    • Delete a Quota - Client
  • Policy Handler
  • TroubleShooting
• Clients / Go
  • Installation
  • Getting started
  • Authentication
  • Configuration
    • Read Config from any io.Reader or file
  • Usage
  • API Calls
  • TroubleShooting
• Clients / Redux
  • Install
  • Usage
  • Options
• Other Tools