### Run End-to-End Example Script

Source: https://docs.confluent.io/current/tutorials/examples/connect-streams-pipeline/docs/index.html

Execute the start script to run the Kafka Connect and Kafka Streams pipeline example.

```bash
./start.sh
```

--------------------------------

### Navigate to Examples Directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/multi-region-tutorial.html

Change the current directory to the cloned examples repository. This allows access to the tutorial-specific files.

```bash
cd examples

```

--------------------------------

### Install Connector (Quick Start)

Source: https://docs.confluent.io/kafka-connectors/gcp-spanner/current/index.html

Installs the Google Cloud Spanner Sink Connector using the Confluent CLI as part of the quick start guide.

```bash
# run from your CP installation directory
confluent connect plugin install confluentinc/kafka-connect-gcp-spanner:latest

```

--------------------------------

### Example Response: Get Schema by GUID

Source: https://docs.confluent.io/platform/current/schema-registry/develop/api.html

Example of a successful response when retrieving a schema by its GUID, including subject, version, ID, and the schema definition.

```JSON
HTTP/1.1 200 OK
Content-Type: application/vnd.schemaregistry.v1+json

{
  "subject": "my-subject-value",
  "version": 1,
  "id": 100015,
  "schema": "{\"type\": \"record\", \"name\": \"MyRecord\", \"fields\": [{\"name\": \"field1\", \"type\": \"string\"}]}"
}
```

--------------------------------

### Example: Create and Load Connector Configuration

Source: https://docs.confluent.io/cloud/current/connectors/cc-github-source.html

An example of how to execute the command to create a connector using a specific configuration file.

```bash
confluent connect cluster create --config-file github-source-config.json

```

--------------------------------

### Create Directory for Example Files

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/cluster-linking/topic-data-sharing.html

Create a new directory to store configuration files and other examples for this setup. This helps organize your configuration.

```bash
mkdir my-examples
```

--------------------------------

### Example Request to Get Schema IDs by GUID

Source: https://docs.confluent.io/platform/current/api-javadoc/sr-redirect.html

Demonstrates an HTTP GET request to retrieve schema IDs associated with a specific GUID. Ensure the Host header is set to your Schema Registry instance.

```http
GET /schemas/guids/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ids HTTP/1.1
Host: schemaregistry.example.com
Accept: application/vnd.schemaregistry.v1+json, application/vnd.schemaregistry+json, application/json


```

--------------------------------

### Example: List Connect Clusters

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/unified-stream-manager/connect/confluent_unified-stream-manager_connect_list.html

Demonstrates how to execute the command to list all available Connect clusters.

```bash
confluent unified-stream-manager connect list

```

--------------------------------

### Clone Examples Repository

Source: https://docs.confluent.io/cloud/current/client-apps/examples/clojure.html

Clone the confluentinc/examples GitHub repository and check out the `latest` branch to get started.

```bash
git clone https://github.com/confluentinc/examples
cd examples
git checkout latest

```

--------------------------------

### Install Connector via Confluent Hub Client

Source: https://docs.confluent.io/kafka-connectors/aws-dynamodb/current/overview.html

Install the DynamoDB connector using the Confluent Hub Client. This is a prerequisite for using the connector in the quick start guide.

```bash
confluent-hub install confluentinc/kafka-connect-aws-dynamodb:latest
```

--------------------------------

### Install Sample Producer App and Topic

Source: https://docs.confluent.io/operator/current/co-quickstart.html

Apply the producer application and data configuration file.

```bash
kubectl apply -f $TUTORIAL_HOME/producer-app-data.yaml
```

--------------------------------

### Example Usage

Source: https://docs.confluent.io/confluent-cli/current/command-reference/ccpm/plugin/confluent_ccpm_plugin_describe.html

An example demonstrating how to describe a custom Connect plugin by its ID and specifying the environment.

```bash
confluent ccpm plugin describe plugin-123456 --environment env-12345
```

--------------------------------

### Clone Confluent Examples Repository

Source: https://docs.confluent.io/cloud/current/get-started/examples/ccloud/docs/ccloud-stack.html

Clone the confluentinc/examples GitHub repository and check out the master branch to get started with the ccloud-stack utility.

```bash
git clone https://github.com/confluentinc/examples
cd examples
git checkout master
```

--------------------------------

### Producer Configuration for JSON Schema with Header GUID

Source: https://docs.confluent.io/current/schema-registry/serdes-develop/index.html

Example of configuring a producer to use JSON Schema serialization and place the schema GUID in the message header. This is for producers starting without Schema Registry.

```java
props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG,
        "io.confluent.kafka.serializers.JSONSchemaSerializer");
props.put("value.schema.id.serializer",
        "io.confluent.kafka.serializers.schema.id.HeaderSchemaIdSerializer");
```

--------------------------------

### Example: List Catalog Integrations

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/tableflow/catalog-integration/confluent_tableflow_catalog-integration_list.html

A simple example demonstrating how to list all catalog integrations.

```bash
confluent tableflow catalog-integration list
```

--------------------------------

### Verify Example Startup by Checking Schema Registry Subjects

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/replicator/replicator-schema-translation.html

After waiting for the example to start, check the subjects in both the source and destination Schema Registries to verify the setup. The source should have one subject, and the destination should have none.

```bash
# Source Schema Registry should show one subject, i.e., the output should be ["testTopic-value"]
docker-compose exec connect curl http://srcSchemaregistry:8085/subjects

# Destination Schema Registry should show no subjects, i.e., the output should be []
docker-compose exec connect curl http://destSchemaregistry:8086/subjects

```

--------------------------------

### Example of Creating Connector

Source: https://docs.confluent.io/cloud/current/connectors/cc-amazon-redshift-sink.html

Example demonstrating how to create a connector using a specific configuration file name.

```bash
confluent connect cluster create --config-file redshift-sink-config.json

```

--------------------------------

### Example: List Custom Connector Plugins

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/connect/custom-plugin/confluent_connect_custom-plugin_list.html

An example demonstrating how to list custom connector plugins for a specific cloud provider.

```bash
confluent connect custom-plugin list --cloud aws

```

--------------------------------

### Start Interactive AI Shell

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/confluent_ai.html

Use this command to launch an interactive AI shell. No specific setup is required beyond having the Confluent CLI installed.

```bash
confluent ai [flags]

```

--------------------------------

### Example Quick Start Configuration

Source: https://docs.confluent.io/llms-full.txt

Specifies a bundled schema for the Datagen connector in the configuration file. Use 'quickstart' property to refer to the schema name.

```text
"quickstart": "users"
```

--------------------------------

### Example Command-Line Execution

Source: https://docs.confluent.io/platform/current/clients/app-development.html

Illustrates how to run the Go program from the command line with necessary arguments.

```bash
go run myprogram.go <bootstrap-servers> <schema-registry> <group> <topic>

```

```bash
go run myprogram.go localhost:9092 http://localhost:8081 consumer-group-name my-topic

```

--------------------------------

### CFK Log Entry: Migration Job Setup Phase

Source: https://docs.confluent.io/operator/current/co-migrate-kraft-troubleshooting.html

Example log entry indicating the start of a KRaft migration job during the SubPhaseSetupAddMigrationAnnotation phase. Useful for confirming job initiation.

```log
2024-10-15T19:52:31.435Z  INFO  kraftmigrationjob log/log.go:31
Migration current status SETUP/SubPhaseSetupAddMigrationAnnotation: <nil>, requeuing ...  {"name": "kraftmigrationjob", "namespace": "my-namespace"
```

--------------------------------

### Example: Create Connector

Source: https://docs.confluent.io/cloud/current/connectors/cc-azure-service-bus-source.html

Example command demonstrating how to create a connector using a specific configuration file name.

```bash
confluent connect cluster create --config-file azure-service-bus-source-config.json

```

--------------------------------

### Example: Create Connector with Specific File

Source: https://docs.confluent.io/cloud/current/connectors/cc-mqtt-source.html

Demonstrates creating a connector using a specific configuration file named `mqtt-source.json`.

```bash
confluent connect cluster create --config-file mqtt-source.json

```

--------------------------------

### Example Producer Start

Source: https://docs.confluent.io/llms-full.txt

Example output indicating that the Kafka producer has started successfully and is ready to accept messages.

```text
Starting Kafka Producer. Use Ctrl-C or Ctrl-D to exit.
```

--------------------------------

### Example: List Kafka Cluster Configurations

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/local/kafka/cluster/configuration/confluent_local_kafka_cluster_configuration_list.html

This example demonstrates how to list all configuration values for the local Kafka cluster using the default human-readable output format.

```bash
confluent local kafka cluster configuration list

```

--------------------------------

### Provider Integration Read Response Example

Source: https://docs.confluent.io/cloud/current/api-docs/pi-api.html

This JSON output represents the configuration of a provider integration retrieved using the GET API request. It contains the same details as the registration response, confirming the integration's setup.

```json
{
 "api_version": "pim/v1",
 "kind": "Integration",
 "id": "dlz-f3a90de",
 "display_name": "s3_provider_integration",
 "provider": "AWS",
 "config": {
   "iam_role_arn": "arn:aws:iam::000000000000:role/confluent-aws-role",
   "external_id": "95c35493-41aa-44f8-9154-5a25cbbc1865",
   "customer_iam_role_arn": "arn:aws:iam::000000000000:role/my-test-aws-role",
   "kind": "AwsIntegrationConfig"
 },
 "usages": [
   "crn://confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-456xy/cloud-cluster=lkc-123abc/connector=my_datagen_connector"
   ],
 "environment": {
   "id": "env-00000",
   "related": "https://api.confluent.cloud/v2/environments/env-00000",
   "resource_name": "https://api.confluent.cloud/organization=9bb441c4-edef-46ac-8a41-c49e44a3fd9a/environment=env-00000"
   }
 }


```

--------------------------------

### Get Consumer Group Request Example

Source: https://docs.confluent.io/platform/current/kafka-rest/api.html

Example HTTP GET request to retrieve details of a specific consumer group.

```HTTP
GET /clusters/{cluster_id}/consumer-groups/{consumer_group_id} HTTP/1.1
Host: example.com
```

--------------------------------

### Install Sample Producer App and Topic

Source: https://docs.confluent.io/operator/current/co-quickstart.html

Deploys a sample producer application and configures a topic for testing.

```bash
kubectl apply -f $TUTORIAL_HOME/producer-app-data.yaml

```

--------------------------------

### Example: List Connect Artifacts

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/connect/artifact/confluent_connect_artifact_list.html

This example shows how to list Connect artifacts for a specific cloud provider and environment.

```bash
confluent connect artifact list --cloud aws --environment env-abc123

```

--------------------------------

### Get Streams Group Member Request Example

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example of a GET request to retrieve a specific streams group member.

```http
GET /clusters/{cluster_id}/streams-groups/{group_id}/members/{member_id} HTTP/1.1
Host: example.com


```

--------------------------------

### Example: List Kafka Clusters

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/unified-stream-manager/kafka/confluent_unified-stream-manager_kafka_list.html

A simple example demonstrating how to list all Kafka clusters.

```bash
confluent unified-stream-manager kafka list
```

--------------------------------

### Get Consumer Lag Request Example

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

This is an example HTTP GET request to retrieve the consumer lag on a specific partition.

```HTTP
GET /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/lags/{topic_name}/partitions/{partition_id} HTTP/1.1
Host: example.com
```

--------------------------------

### Example: List all schemas in the default context (On-Premises)

Source: https://docs.confluent.io/confluent-cli/current/command-reference/schema-registry/schema/confluent_schema-registry_schema_list.html

This example lists all schemas in the default context for an on-premises setup, specifying the CA path and Schema Registry endpoint.

```bash
confluent schema-registry schema list --certificate-authority-path <certification-authority-location> --schema-registry-endpoint <schema-registry-endpoint>
```

--------------------------------

### Get Replica Example Request

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve a replica for a specific partition assigned to a broker.

```http
GET /clusters/{cluster_id}/topics/{topic_name}/partitions/{partition_id}/replicas/{broker_id} HTTP/1.1
Host: example.com


```

--------------------------------

### Example: List Configurations for a Topic

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/local/kafka/topic/configuration/confluent_local_kafka_topic_configuration_list.html

Demonstrates how to list the configurations for a specific Kafka topic named 'test'.

```bash
confluent local kafka topic configuration list test
```

--------------------------------

### Start VMware Player Installation

Source: https://docs.confluent.io/kafka-connect-netezza/current/index.html

Starts the VMware Player installation process using sudo. Ensure the file path is correct.

```bash
sudo sh ~/Downloads/VMware-Player*
```

--------------------------------

### Get Consumer Assignment Request Example

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve assignment information for a specific consumer to a partition.

```http
GET /clusters/{cluster_id}/consumer-groups/{consumer_group_id}/consumers/{consumer_id}/assignments/{topic_name}/partitions/{partition_id} HTTP/1.1
Host: example.com


```

--------------------------------

### Build Kotlin Client Examples

Source: https://docs.confluent.io/cloud/current/client-apps/examples/kotlin.html

Build the client examples using Gradle. This command compiles the code and prepares it for execution.

```bash
./gradlew clean build
```

--------------------------------

### Example: List Partitions for a Topic

Source: https://docs.confluent.io/confluent-cli/current/command-reference/kafka/partition/confluent_kafka_partition_list.html

Demonstrates how to list all partitions for a specific Kafka topic named 'my_topic'.

```bash
confluent kafka partition list --topic my_topic

```

--------------------------------

### Example GET Request for Savepoint

Source: https://docs.confluent.io/cp-flink/current/clients-api/rest.html

Shows an example HTTP GET request to retrieve a specific savepoint for an application within an environment.

```http
GET /cmf/api/v1/environments/{envName}/applications/{appName}/savepoints/{savepointName} HTTP/1.1
Host: example.com
```

--------------------------------

### Complete Agent Setup Example

Source: https://docs.confluent.io/cloud/current/flink/reference/statements/create-agent.html

A comprehensive example showing the setup of connections, tools, functions, models, and finally, a weather agent.

```sql
-- Create MCP server connection
CREATE CONNECTION mcp_connection
WITH (
  'type' = 'mcp_server',
  'api-key' = '<your-api-key>',
  'endpoint' = 'https://mcp.example.com',

);

-- Create tools
CREATE TOOL mcp_server
USING CONNECTION mcp_connection
WITH (
  'type' = 'mcp',
  'allowed_tools' = 'tool1,tool2',
  'request_timeout' = '30'
);

-- Register a function.
CREATE FUNCTION convert_to_celsius
USING JAR 'celsius.jar'
COMMENT 'function to convert degree to celsius';

-- Create a tool based on the function.
CREATE TOOL convert_to_celsius_tool
USING FUNCTION convert_to_celsius
WITH (
  'type' = 'function',
  'description' = 'This function can be used by model to convert degree to celsius'
);

-- Create a connection to the model provider.
CREATE CONNECTION openai_connection
WITH (
  'type' = 'openai',
  'endpoint' = 'https://api.openai.com/v1/chat/completions',
  'api-key' = 'your-openai-key'
);

-- Register a remote model.
CREATE MODEL openai
INPUT(text STRING)
OUTPUT (res STRING)
WITH (
  'provider' = 'openai',
  'openai.model' = 'gpt-4o',
  'openai.connection' = 'openai_connection'
);

-- Create an agent that uses the model and tools.
CREATE AGENT weather_agent
USING MODEL openai
USING PROMPT 'Find weather info for provided city'
USING TOOLS mcp_server, convert_to_celsius_tool;

```

--------------------------------

### Create Example Directory

Source: https://docs.confluent.io/platform/current/multi-dc-deployments/cluster-linking/configs.html

Creates a directory to store example files for Confluent Platform configurations. Ensure the CONFLUENT_HOME environment variable is set.

```bash
cd $CONFLUENT_HOME
mkdir my-examples
```

--------------------------------

### Example: Describe a Custom Connect Plugin

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/ccpm/plugin/confluent_ccpm_plugin_describe.html

This example demonstrates how to describe a custom Connect plugin using its ID and specifying the environment.

```bash
confluent ccpm plugin describe plugin-123456 --environment env-12345

```

--------------------------------

### Vertica JDBC Driver Installation Path Example

Source: https://docs.confluent.io/kafka-connect-vertica/current/overview.html

Example of the installation path for the vertica-jdbc.jar file within the connector's lib folder.

```text
<path-to-connector>/confluentinc-kafka-connect-vertica-1.2.2/lib/vertica-jdbc-9.2.1-0.jar
```

--------------------------------

### Example: Create MySQL Source Connector

Source: https://docs.confluent.io/cloud/current/connectors/cc-mysql-source.html

An example command demonstrating how to create a MySQL source connector using a specific configuration file.

```bash
confluent connect cluster create --config-file mysql-source.json
```

--------------------------------

### Get Share Group Consumer Request Example

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example of an HTTP GET request to retrieve a specific consumer within a share group.

```http
GET /clusters/{cluster_id}/share-groups/{group_id}/consumers/{consumer_id} HTTP/1.1
Host: example.com


```

--------------------------------

### Get Group Config Request Example

Source: https://docs.confluent.io/platform/current/api-javadoc/krest-redirect.html

Example HTTP GET request to retrieve a specific configuration for a given consumer, share, or streams group.

```HTTP
GET /clusters/{cluster_id}/groups/{group_id}/configs/{name} HTTP/1.1
Host: example.com


```

--------------------------------

### Example: Create ServiceNow Source Connector

Source: https://docs.confluent.io/cloud/current/connectors/cc-servicenow-source.html

Example command demonstrating how to create the ServiceNow Source connector using a specific configuration file.

```bash
confluent connect cluster create --config-file servicenow-source-config.json

```

--------------------------------

### Example of Creating Zendesk Source Connector

Source: https://docs.confluent.io/cloud/current/connectors/cc-zendesk-source.html

Illustrates how to execute the command to create the Zendesk Source Connector with a specified configuration file.

```bash
confluent connect cluster create --config-file zendesk-source-config.json

```

--------------------------------

### SchemaId Guid Property

Source: https://docs.confluent.io/platform/current/clients/confluent-kafka-dotnet/_site/api/Confluent.SchemaRegistry.SchemaId.html

Gets or sets the schema GUID.

```csharp
public Guid? Guid { readonly get; set; }
```

--------------------------------

### Example Prometheus SSL Certificate Installation

Source: https://docs.confluent.io/control-center/current/security/broker-to-alert.html

An example of installing a Prometheus SSL certificate on the Control Center machine, specifying the truststore location and certificate file.

```bash
sudo keytool -import -alias mycert -keystore /usr/lib/jvm/java-1.17.0-openjdk-amd64/lib/security/cacerts -file /home/ubuntu/ca.crt

```

--------------------------------

### List all custom Connect plugins in an environment

Source: https://docs.confluent.io/confluent-cli/4.64/command-reference/ccpm/plugin/confluent_ccpm_plugin_list.html

Example of how to list all custom Connect plugins within a specified environment.

```bash
confluent ccpm plugin list --environment env-12345

```