Lists all Lenses environments.

Returns: A list containing all environments with their details including status, metrics, and metadata.

Retrieves a single Lenses environment by name.

Args: name: The name of the environment to retrieve.

Returns: A dictionary containing the environment's details including status, metrics, and metadata.

Creates a new Lenses environment.

Args: name: The name of the new environment. Must be a valid resource name (lowercase alphanumeric or hyphens, max 63 chars). display_name: The display name of the environment. If not provided, 'name' will be used. tier: The environment tier. Options: "development", "staging", "production". Default: "development". metadata: Additional metadata as key-value pairs.

Returns: The created environment object including the agent_key for setup.

Checks the health status of a Lenses environment.

Args: name: The name of the environment to check.

Returns: Health status information including agent connection and any issues.

Retrieves a list of all Kafka connectors.

Args: environment: The environment name. cluster: Optional list of cluster names to filter by. class_name: Optional list of connector class names to filter by.

Returns: A dictionary containing a list of all connectors with their details.

Fetches the current target definition for a Kafka connector.

Args: environment: The environment name. connect_cluster_name: The connect cluster name. connector_name: The connector name.

Returns: The connector definition as a YAML string.

Creates a new Kafka connector.

Args: environment: The environment name. name: The name of the connector. cluster: The cluster name where the connector will be deployed. configuration: The connector configuration as a dictionary.

Returns: The created connector object.

Controls a Kafka connector (start, stop, restart, pause, resume).

Args: environment: The environment name. cluster: The cluster name. connector: The connector name. action: The action to perform. Options: "start", "stop", "restart", "pause", "resume".

Returns: The result of the control operation.

Restarts a specific task of a Kafka connector.

Args: environment: The environment name. cluster: The cluster name. connector: The connector name. task_id: The task ID to restart.

Returns: The result of the task restart operation.

Deletes a Kafka connector.

Args: environment: The environment name. cluster: The cluster name. connector: The connector name.

Returns: The result of the delete operation.

Validates a Kafka connector configuration.

Args: environment: The environment name. name: The name of the connector. cluster: The cluster name. configuration: The connector configuration to validate.

Returns: Validation results including configuration details and any errors.

Retrieve a list of all Kafka consumer groups.

Args: environment: The environment name.

Returns: A list of consumer group objects.

Retrieve a list of consumer groups by a specific topic.

Args: environment: The environment name. topic: The name of the topic.

Returns: A list of consumer group objects.

Update the offset for a consumer group topic-partition tuples.

Args: environment: The environment name. group_id: The ID of the consumer group. offsets: A list of topic-partition offset objects.

Returns: The result of the update operation.

Delete offsets for a consumer group topic-partition tuples.

Args: environment: The environment name. group_id: The ID of the consumer group. offsets: A list of topic-partition objects.

Returns: The result of the delete operation.

Update the offset for a topic-partition for a given group.

Args: environment: The environment name. group_id: The ID of the consumer group. topic: The topic name. partition: The partition number. offset: The new offset value.

Returns: The result of the update operation.

Delete the offset for a topic-partition for a given group.

Args: environment: The environment name. group_id: The ID of the consumer group. topic: The topic name. partition: The partition number.

Returns: The result of the delete operation.

Delete a consumer group.

Args: environment: The environment name. group_id: The ID of the consumer group to delete.

Returns: The result of the delete operation.

Executes SQL statements/queries using Lenses WebSocket API.

Args: environment: The environment name. sql: The SQL statement/query to execute.

Returns: A list of MessageRecord objects representing the result of the SQL query.

Retrieves all SQL processor details.

Args: environment: The environment name.

Returns: A dictionary containing a list of all SQL processors with their details.

Retrieves a single SQL processor by ID.

Args: environment: The environment name. sql_processor_id: SQL processor unique identifier.

Returns: Detailed SQL processor information including application, metadata, and deployment status.

Creates a new SQL processor.

Args: environment: The environment name. name: The name of the SQL processor. sql: The SQL query/statement for the processor. deployment: Deployment configuration including details like mode, runners, cluster, namespace, etc. If there are no available deployment targets (Kubernetes or Connect clusters), use 'in process' mode: {{mode: "IN_PROC"}} sql_processor_id: Optional processor ID. If not provided, will be auto-generated. description: Optional description of the processor. tags: Optional list of tags for the processor.

Returns: The created SQL processor object with its ID.

Removes an existing SQL processor.

Args: environment: The environment name. sql_processor_id: SQL processor unique identifier.

Returns: Success message confirming the deletion.

Returns deployment information including available Kubernetes clusters and Connect clusters.

Args: environment: The environment name.

Returns: Dictionary containing available deployment targets (Kubernetes clusters and Connect clusters).

Returns the logs produced by a running Kubernetes Pod.

Args: environment: The environment name. cluster: Pod's cluster name. namespace: Pod's namespace. pod: Pod's name.

Returns: The logs content as a string.

Retrieve information about all topics.

Args: environment: The environment name.

Returns: List of all topics with detailed information.

Retrieve information about a specific topic.

Args: environment: The environment name. topic_name: Name of the topic.

Returns: Detailed topic information including partitions, consumers, config, etc.

Retrieve detailed partition information including messages and bytes (v2 endpoint).

Args: environment: The environment name. topic_name: Name of the topic.

Returns: Partition details with message counts, bytes, and JMX timestamp.

Creates a new Kafka topic with optional configuration.

Args: environment: The environment name. topic_name: Topic name. partitions: Number of partitions (default: 1). replication: Replication factor (default: 1). configs: Topic configurations.

Returns: Creation result.

Creates a new Kafka topic with optional format and schema configuration.

Args: environment: The environment name. name: Topic name. partitions: Number of partitions (default: 1). replication: Replication factor (default: 1). configs: Topic configurations. key_format: Key format (AVRO, JSON, CSV, XML, INT, LONG, STRING, BYTES, etc.). key_schema: Key schema (required for AVRO, JSON, CSV, XML). value_format: Value format. value_schema: Value schema.

Returns: Creation result.

Update topic configuration.

Args: environment: The environment name. topic_name: Name of the topic. configs: List of config key-value pairs [{"key": "retention.ms", "value": "86400000"}].

Returns: Success message.

Get broker configurations for a topic.

Args: environment: The environment name. topic_name: Name of the topic.

Returns: List of broker configuration details.

Add partitions to an existing topic.

Args: environment: The environment name. topic_name: Name of the topic. partitions: New total number of partitions.

Returns: Updated partition count.

Resend a Kafka message.

Args: environment: The environment name. topic_name: Name of the topic. partition: Kafka partition number. offset: Kafka offset.

Returns: Resend operation result with partition and offset.

List all topic metadata.

Args: environment: The environment name.

Returns: List of topic metadata including schemas and descriptions.

Get metadata for a specific topic.

Args: environment: The environment name. topic_name: Name of the topic.

Returns: Topic metadata including schema information and tags.

Retrieves a paginated list of datasets (topics and other data sources).

Args: environment: The environment name. page: Page number (default: 1). page_size: Items per page (default: 25). search: Search keyword for dataset, fields and description. connections: List of connection names to filter by. tags: List of tag names to filter by. sort_field: Field to sort results by. sort_order: Sorting order - "asc" or "desc" (default: "asc"). include_system: Include system entities (default: False). search_fields: Search field names/documentation (default: True). schema_format: Schema format filter for SchemaRegistrySubject. has_records: Filter based on whether dataset has records. is_compacted: Filter based on compacted status (Kafka only).

Returns: Paginated list of datasets with source types.

Get a single dataset by connection/name.

Args: environment: The environment name. connection: The connection name (e.g., "kafka"). dataset: The dataset name.

Returns: Dataset details including fields, policies, permissions, and metadata.

Get ranged metrics for a dataset's messages.

Args: environment: The environment name. entity_name: The dataset's entity name.

Returns: List of message metrics with date and message count.

Update topic description (in metadata).

Args: environment: The environment name. topic_name: Name of the topic. description: The description of the topic. Returns: Success message.

Update topic tags (in metadata).

Args: environment: The environment name. topic_name: Name of the topic. tags: List of tag names. Returns: Success message.