numaflow-java

KO | EN

gitlite — search

#python #ai #go #golang #android #rust #linux #docker #nodejs #macos #java #awesome #vue #openai

(★ 28)

Numaflow Java SDK

numaflow-java Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Java SDK for Numaflow

[![Build](https://github.com/numaproj/numaflow-java/actions/workflows/run-tests.yaml/badge.svg?branch=main)](https://github.com/numaproj/numaflow-java/actions/workflows/run-tests.yaml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/numaproj/numaflow-java/main/LICENSE)
[![Release Version](https://img.shields.io/github/v/release/numaproj/numaflow-java?label=numaflow-java)](https://github.com/numaproj/numaflow-java/releases/latest)
[![Maven Central](https://img.shields.io/maven-central/v/io.numaproj.numaflow/numaflow-java.svg?label=Maven%20Central)](https://central.sonatype.com/search?q=numaflow+java&smo=true)

This SDK provides the interface for
writing [UDSources](https://numaflow.numaproj.io/user-guide/sources/user-defined-sources/)
, [UDTransformer](https://numaflow.numaproj.io/user-guide/sources/transformer/overview/)
, [UDFs](https://numaflow.numaproj.io/user-guide/user-defined-functions/user-defined-functions/)
and [UDSinks](https://numaflow.numaproj.io/user-guide/sinks/user-defined-sinks/) in Java.

## Getting Started

### Requirements

* `java` 11+
* `maven` 3.6+

### Importing Numaflow Java SDK

#### Maven users

Add this dependency to your project's POM:

```xml
<dependency>
  <groupId>io.numaproj.numaflow</groupId>
  <artifactId>numaflow-java</artifactId>
  <version>0.13.0</version>
</dependency>
```

#### Gradle users

Add this dependency to your project's build file:

```groovy
compile "io.numaproj.numaflow:numaflow-java:0.13.0"
```

### Build

```bash
mvn clean install
```

### Examples on how to write UDSources, UDTransformers, UDFs, UDSinks and SideInputs in Java

* **User Defined Source(UDSource)**
    * [Source](examples/src/main/java/io/numaproj/numaflow/examples/source/simple)

* **User Defined Source Transformer(UDTransformer)**
    * [Source Transformer](examples/src/main/java/io/numaproj/numaflow/examples/sourcetransformer/eventtimefilter)

* **User Defined Function(UDF)**
    * [MapStream](examples/src/main/java/io/numaproj/numaflow/examples/mapstream/flatmapstream)
    * [Map](examples/src/main/java/io/numaproj/numaflow/examples/map)
    * [Reduce](examples/src/main/java/io/numaproj/numaflow/examples/reduce)
    * [ReduceStream](examples/src/main/java/io/numaproj/numaflow/examples/reducestreamer)
    * [SessionReduce](examples/src/main/java/io/numaproj/numaflow/examples/reducesession)

* **User Defined Sink(UDSink)**
    * [Sink](examples/src/main/java/io/numaproj/numaflow/examples/sink/simple)

* **User Defined SideInput(SideInput)**
    * [SideInput](examples/src/main/java/io/numaproj/numaflow/examples/sideinput)

You will see a warning in the log on startup, which you can safely ignore:

```
Oct 25, 2022 12:26:30 PM io.netty.bootstrap.AbstractBootstrap setChannelOption
WARNING: Unknown channel option 'SO_KEEPALIVE' for channel '[id: 0x6e9c19c7]'
```

This is due to grpc-netty trying to set SO_KEEPALIVE when it
shouldn't (https://github.com/grpc/grpc-java/blob/47ddfa4f205d4672e035c37349dfd3036c74efb6/netty/src/main/java/io/grpc/netty/NettyClientTransport.java#L237)

It is suggested to use `amazoncorretto:11` as base for your docker image. We observed that without a
base image, the java user-defined container can fail the Numaflow health check.

### API Documentation

Please, refer to
our [Javadoc](https://javadoc.io/doc/io.numaproj.numaflow/numaflow-java/latest/index.html) website.

## Development

### Updating proto definition files

To keep up-to-date, do the following before building(using udf as an example):

* copy the `*.proto` files
  from [numaflow-go](https://github.com/numaproj/numaflow-go/tree/main/pkg/apis/proto)
  into `/src/main/proto`
* replace the `go_package` lines with the following `java_package`:

```protobuf
option java_package = "io.numaproj.numaflow.function.v1";
```

## Code Style

Use [Editor Config](https://www.jetbrains.com/help/idea/editorconfig.html).

numaflow-java

numaflow-java Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

numaflow-java

numaflow-java Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README