java

numaflow-client-java

Numaflow

• API version: v1.2.1

• Generator version: 7.7.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 11+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.numaproj.numaflow</groupId>
  <artifactId>numaflow-client-java</artifactId>
  <version>1.2.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.numaproj.numaflow:numaflow-client-java:1.2.1"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/numaflow-client-java-1.2.1.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description

Documentation for Models

• AbstractPodTemplate
• AbstractSink
• AbstractVertex
• Authorization
• BasicAuth
• BufferServiceConfig
• CombinedEdge
• Container
• ContainerBuilder
• ContainerTemplate
• DaemonTemplate
• Edge
• FixedWindow
• ForwardConditions
• Function
• GSSAPI
• GeneratorSource
• GetContainerReq
• GetDaemonDeploymentReq
• GetJetStreamServiceSpecReq
• GetJetStreamStatefulSetSpecReq
• GetRedisServiceSpecReq
• GetRedisStatefulSetSpecReq
• GetSideInputDeploymentReq
• GetVertexPodSpecReq
• GroupBy
• HTTPSource
• IdleSource
• InterStepBufferService
• InterStepBufferServiceList
• InterStepBufferServiceSpec
• InterStepBufferServiceStatus
• JetStreamBufferService
• JetStreamConfig
• JobTemplate
• KafkaSink
• KafkaSource
• Lifecycle
• Metadata
• NativeRedis
• NatsAuth
• NatsSource
• PBQStorage
• PersistenceStrategy
• Pipeline
• PipelineLimits
• PipelineList
• PipelineSpec
• PipelineStatus
• RedisBufferService
• RedisConfig
• RedisSettings
• SASL
• SASLPlain
• Scale
• SessionWindow
• SideInput
• SideInputTrigger
• SideInputsManagerTemplate
• Sink
• SlidingWindow
• Source
• Status
• TLS
• TagConditions
• Templates
• Transformer
• UDF
• UDSink
• UDSource
• UDTransformer
• Vertex
• VertexInstance
• VertexLimits
• VertexList
• VertexSpec
• VertexStatus
• VertexTemplate
• Watermark
• Window

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Author