Index
All Classes and Interfaces|All Packages|Serialized Form
A
- accept(T) - Method in interface co.decodable.sdk.pipeline.testing.PipelineTestContext.ThrowingConsumer
- add(StreamRecord<T>) - Method in interface co.decodable.sdk.pipeline.testing.DecodableStream
-
Adds the given stream record to this stream.
B
- bootstrapServers() - Method in class co.decodable.sdk.pipeline.testing.TestEnvironment
-
Returns the Kafka bootstrap server(s) configured for this environment.
- build() - Method in interface co.decodable.sdk.pipeline.DecodableStreamSinkBuilder
-
Returns a new
DecodableStreamSink
for the given configuration. - build() - Method in interface co.decodable.sdk.pipeline.DecodableStreamSourceBuilder
-
Returns a new
DecodableStreamSource
for the given configuration. - build() - Method in class co.decodable.sdk.pipeline.testing.TestEnvironment.Builder
-
Returns a new
TestEnvironment
for the given configuration. - builder() - Static method in interface co.decodable.sdk.pipeline.DecodableStreamSink
-
Returns a builder for creating a new
DecodableStreamSink
. - builder() - Static method in interface co.decodable.sdk.pipeline.DecodableStreamSource
-
Returns a builder for creating a new
DecodableStreamSource
. - builder() - Static method in class co.decodable.sdk.pipeline.testing.TestEnvironment
-
Returns a builder for creating a new
TestEnvironment
. - Builder() - Constructor for class co.decodable.sdk.pipeline.testing.TestEnvironment.Builder
C
- close() - Method in class co.decodable.sdk.pipeline.testing.PipelineTestContext
- co.decodable.sdk.pipeline - package co.decodable.sdk.pipeline
-
An SDK for implementing Apache Flink jobs and running them on Decodable.
- co.decodable.sdk.pipeline.exception - package co.decodable.sdk.pipeline.exception
- co.decodable.sdk.pipeline.metadata - package co.decodable.sdk.pipeline.metadata
-
Annotations for linking custom pipelines to managed Decodable streams.
- co.decodable.sdk.pipeline.testing - package co.decodable.sdk.pipeline.testing
-
Infrastructure and utilities for (integration) testing custom Decodable pipelines.
- co.decodable.sdk.pipeline.util - package co.decodable.sdk.pipeline.util
-
Miscellaneous utilities.
- createTime() - Method in interface co.decodable.sdk.pipeline.DecodableSecret
-
Returns the creation time of the secret.
- createWriter(Sink.InitContext) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSink
- Custom Metrics - Search tag in package co.decodable.sdk.pipeline
- Section
D
- DecodableSecret - Interface in co.decodable.sdk.pipeline
-
Represents a Decodable secret.
- DecodableSourceEnumeratorState - Interface in co.decodable.sdk.pipeline
-
Enumerator state used with
DecodableStreamSource
. - DecodableSourceSplit - Interface in co.decodable.sdk.pipeline
-
A source split used with
DecodableStreamSource
. - DecodableStream<T> - Interface in co.decodable.sdk.pipeline.testing
-
Represents a data stream on the Decodable platform.
- DecodableStreamSink<T> - Interface in co.decodable.sdk.pipeline
-
A
StatefulSink
which allows to write to a Decodable stream from within a Flink job. - DecodableStreamSinkBuilder<T> - Interface in co.decodable.sdk.pipeline
-
Builder for creating DecodableStreamSink instances.
- DecodableStreamSource<T> - Interface in co.decodable.sdk.pipeline
-
A
Source
which allows to retrieve the contents of a Decodable stream from within a Flink job. - DecodableStreamSourceBuilder<T> - Interface in co.decodable.sdk.pipeline
-
Builder for creating DecodableStreamSource instances.
- DecodableWriter<T> - Interface in co.decodable.sdk.pipeline
-
Sink writer used by
DecodableStreamSink
. - description() - Method in interface co.decodable.sdk.pipeline.DecodableSecret
-
Returns the secret description.
E
- EARLIEST_OFFSET - Enum constant in enum class co.decodable.sdk.pipeline.StartupMode
-
Consume the stream starting at the earliest available offset.
- EnvironmentAccess - Class in co.decodable.sdk.pipeline
-
Provides access to the environment from within a custom Flink job.
- EnvironmentAccess.Environment - Interface in co.decodable.sdk.pipeline
-
Exposes the environment variables of the current process.
F
- fromString(String) - Static method in enum class co.decodable.sdk.pipeline.StartupMode
-
Parses the given string value into
StartupMode
instance.
G
- getEnvironment() - Static method in class co.decodable.sdk.pipeline.EnvironmentAccess
-
Returns the current environment.
- getEnvironmentConfiguration() - Method in interface co.decodable.sdk.pipeline.EnvironmentAccess.Environment
-
Returns the current environment variables, keyed by name.
- getEnvironmentConfiguration() - Method in class co.decodable.sdk.pipeline.testing.TestEnvironment
-
Returns the current environment variables, keyed by name.
I
- Incubating - Annotation Interface in co.decodable.sdk.pipeline.util
-
Denotes that the annotated element (type, method, etc.) is under active development and that its API surface may be changed in backwards incompatible ways in future releases.
L
- LATEST_OFFSET - Enum constant in enum class co.decodable.sdk.pipeline.StartupMode
-
Consume the stream starting at the latest available offset.
N
- name() - Method in interface co.decodable.sdk.pipeline.DecodableSecret
-
Returns the name of the secret.
O
- Operator naming convention - Search tag in package co.decodable.sdk.pipeline
- Section
P
- PipelineTestContext - Class in co.decodable.sdk.pipeline.testing
-
Provides access to Decodable streams during testing as well as the ability to run custom Flink jobs.
- PipelineTestContext(TestEnvironment) - Constructor for class co.decodable.sdk.pipeline.testing.PipelineTestContext
-
Creates a new testing context, using the given
TestEnvironment
. - PipelineTestContext.ThrowingConsumer<T> - Interface in co.decodable.sdk.pipeline.testing
-
A
Consumer
variant which allows for declared checked exception types.
R
- resetEnvironment() - Static method in class co.decodable.sdk.pipeline.EnvironmentAccess
-
Resets active the environment to the system environment.
- runJobAsync(PipelineTestContext.ThrowingConsumer<String[]>, String...) - Method in class co.decodable.sdk.pipeline.testing.PipelineTestContext
-
Asynchronously executes the given Flink job main method.
S
- SecretNotFoundException - Exception Class in co.decodable.sdk.pipeline.exception
-
This exception is thrown when a Decodable secret cannot be accessed.
- SecretNotFoundException(String) - Constructor for exception class co.decodable.sdk.pipeline.exception.SecretNotFoundException
- SecretNotFoundException(String, Throwable) - Constructor for exception class co.decodable.sdk.pipeline.exception.SecretNotFoundException
- setEnvironment(EnvironmentAccess.Environment) - Static method in class co.decodable.sdk.pipeline.EnvironmentAccess
-
Sets the given environment as the active one.
- SinkStreams - Annotation Interface in co.decodable.sdk.pipeline.metadata
-
Denotes the sink streams accessed by a custom pipeline.
- SourceStreams - Annotation Interface in co.decodable.sdk.pipeline.metadata
-
Denotes the source streams accessed by a custom pipeline.
- StartupMode - Enum Class in co.decodable.sdk.pipeline
-
Defines from which offset to consume the underlying stream when starting up a
DecodableStreamSource
. - stream(String) - Method in class co.decodable.sdk.pipeline.testing.PipelineTestContext
-
Returns a stream for the given name.
- Stream Metadata - Search tag in package co.decodable.sdk.pipeline
- Section
- StreamRecord<T> - Class in co.decodable.sdk.pipeline.testing
-
Represents one element on a Decodable stream.
- StreamRecord(T) - Constructor for class co.decodable.sdk.pipeline.testing.StreamRecord
-
Creates a new stream record with the given value.
T
- take(int) - Method in interface co.decodable.sdk.pipeline.testing.DecodableStream
-
Retrieves
n
elements from this stream. - takeOne() - Method in interface co.decodable.sdk.pipeline.testing.DecodableStream
-
Retrieves one element from this stream.
- TestEnvironment - Class in co.decodable.sdk.pipeline.testing
-
An
EnvironmentAccess.Environment
implementation for testing purposes, allowing to define one or more Decodable streams which then can be accessed from the job under test. - TestEnvironment.Builder - Class in co.decodable.sdk.pipeline.testing
-
A builder for creating new
TestEnvironment
instances. - topicFor(String) - Method in class co.decodable.sdk.pipeline.testing.TestEnvironment
-
Returns the name of the Kafka topic backing the given stream.
U
- Unmodifiable - Annotation Interface in co.decodable.sdk.pipeline.util
-
Denotes that the annotated field is unmodifiable.
- updateTime() - Method in interface co.decodable.sdk.pipeline.DecodableSecret
-
Returns the time the secret was last updated.
V
- value() - Method in interface co.decodable.sdk.pipeline.DecodableSecret
-
Returns the plaintext secret value.
- value() - Element in annotation interface co.decodable.sdk.pipeline.metadata.SinkStreams
-
Names of the sink streams.
- value() - Element in annotation interface co.decodable.sdk.pipeline.metadata.SourceStreams
-
Names of the source streams.
- value() - Method in class co.decodable.sdk.pipeline.testing.StreamRecord
-
Returns the value of this stream record.
- valueOf(String) - Static method in enum class co.decodable.sdk.pipeline.StartupMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class co.decodable.sdk.pipeline.StartupMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VisibleForTesting - Annotation Interface in co.decodable.sdk.pipeline.util
-
Denotes that the annotated element is exposed for testing purposes only and should not be referenced from production code.
W
- withBootstrapServers(String) - Method in class co.decodable.sdk.pipeline.testing.TestEnvironment.Builder
-
Specifies the bootstrap server(s) to be used.
- withDeserializationSchema(DeserializationSchema<T>) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSourceBuilder
-
Specifies the deserialization schema to be used.
- withName(String) - Static method in interface co.decodable.sdk.pipeline.DecodableSecret
-
Looks up the secret by name and returns a
DecodableSecret
instance. - withSerializationSchema(SerializationSchema<T>) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSinkBuilder
-
Specifies the serialization schema to be used.
- withStartupMode(StartupMode) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSourceBuilder
-
Specifies the start-up mode to use when reading from the stream.
- withStreamId(String) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSinkBuilder
-
Specifies the id of the stream to write to.
- withStreamId(String) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSourceBuilder
-
Specifies the id of the stream to read from.
- withStreamName(String) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSinkBuilder
-
Specifies the name of the stream to write to.
- withStreamName(String) - Method in interface co.decodable.sdk.pipeline.DecodableStreamSourceBuilder
-
Specifies the name of the stream to read from.
- withStreams(String, String...) - Method in class co.decodable.sdk.pipeline.testing.TestEnvironment.Builder
-
Specifies the names of the stream(s) which should be available via this test environment.
All Classes and Interfaces|All Packages|Serialized Form