feat: Add static getter for TableDefinition in KafkaTools

[robbcamera]

No description provided.

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

[robbcamera]

I have read the CLA Document and I hereby sign the CLA

[robbcamera]

recheck

[devinrsmith]

We should explicitly call out the potential statefulness of KeyOrValueSpec. If the caller is going to rely on the correctness of this method, they must call consume with the exact same instances of keySpec / valueSpec.

ie, the following is incorrect:

TableDefinition tableDefinition = getTableDefinition(properties, null, avroSchema("MyValueSchema"));
Table table = consume(properties, ..., avroSchema("MyValueSchema"), ...)

it must be

KeyOrValueSpec myValueSpec = avroSchema("MyValueSchema");
TableDefinition tableDefinition = getTableDefinition(properties, null, myValueSpec);
Table table = consume(properties, ..., myValueSpec, ...)

[devinrsmith]

Or rather, we should add documentation about the "guarantees" between getTableDefinition and consume; in what conditions is the table definition from getTableDefinition guaranteed to be the table definition of consume? (In my mind, it should be guaranteed when you use the exact same keySpec / valueSpec due to the statefulness of them.)

[deephaven-internal]

Labels indicate documentation is required. Issues for documentation have been opened:

Community: deephaven/deephaven-docs-community#300