org.apache.flink.statefun.flink.core.httpfn.binders.v1

Class HttpEndpointBinderV1

java.lang.Object

org.apache.flink.statefun.flink.core.httpfn.binders.v1.HttpEndpointBinderV1

All Implemented Interfaces:

ComponentBinder

public final class HttpEndpointBinderV1
extends java.lang.Object
implements ComponentBinder

Version 1 ComponentBinder for binding a HttpFunctionProvider. Corresponding TypeName is io.statefun.endpoints.v1/http.

Below is an example YAML document of the ComponentJsonObject recognized by this binder, with the expected types of each field:

 kind: io.statefun.endpoints.v1/http                                (typename)
 spec:                                                              (object)
   functions: com.foo.bar/*                                         (typename)
   urlPathTemplate: https://bar.foo.com:8080/{function.name}        (string)
   maxNumBatchRequests: 10000                                       (int, optional)
   timeouts:                                                        (object, optional)
     call: 1minute                                                  (duration, optional)
     connect: 20seconds                                             (duration, optional)
     read: 30seconds                                                (duration, optional)
     write: 3seconds                                                (duration, optional)
 

Field Summary

Fields

Modifier and Type	Field and Description
static TypeName	KIND_TYPE

Method Summary

Modifier and Type	Method and Description
void	bind(ComponentJsonObject component, StatefulFunctionModule.Binder binder) Bind a ComponentJsonObject to an underlying remote module through the provided module binder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KIND_TYPE

public static final TypeName KIND_TYPE

Method Detail

bind

public void bind(ComponentJsonObject component,
                 StatefulFunctionModule.Binder binder)

Description copied from interface: ComponentBinder

Bind a ComponentJsonObject to an underlying remote module through the provided module binder.

Specified by:

bind in interface ComponentBinder

Parameters:

component - the component to parse and bind.

binder - the binder to use to bind application entities to the underlying remote module.