org.apache.flink.statefun.extensions

Class ComponentJsonObject

java.lang.Object

org.apache.flink.statefun.extensions.ComponentJsonObject

@PublicEvolving
public final class ComponentJsonObject
extends java.lang.Object

A ComponentJsonObject consists one or more application entities (i.e. function providers, ingresses, routers, or egresses) that should be bound to a remote StatefulFunctionModule.

Each component is represented in remote module YAML specification files as a single YAML document of the following format:

 kind: com.foo.bar.v5/some.component         (typename)
 spec:
   ...                                       (specification document of the component)
 

The kind is a TypeName that should be universally unique within the application. It identifies which ComponentBinder recognizes this component and knows how to parse it to resolve application entities to be bound to the module.

See Also:

ComponentBinder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BINDER_KIND_FIELD
static java.lang.String	SPEC_FIELD

Constructor Summary

Constructors

Constructor and Description
ComponentJsonObject(org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode)

Method Summary

Modifier and Type	Method and Description
TypeName	binderTypename() Returns the TypeName of the binder for this component.
org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.node.ObjectNode	get() Returns the complete component JSON object.
org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.JsonNode	specJsonNode() Returns the specification JSON node for this component.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

BINDER_KIND_FIELD

public static final java.lang.String BINDER_KIND_FIELD

See Also:

Constant Field Values

SPEC_FIELD

public static final java.lang.String SPEC_FIELD

See Also:

Constant Field Values

Constructor Detail

ComponentJsonObject

public ComponentJsonObject(org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.JsonNode jsonNode)

Method Detail

get

public org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.node.ObjectNode get()

Returns the complete component JSON object.

Returns:

the complete component JSON object.

binderTypename

public TypeName binderTypename()

Returns the TypeName of the binder for this component.

Returns:

the TypeName of the binder for this component.

specJsonNode

public org.apache.flink.shaded.jackson2.com.fasterxml.jackson.databind.JsonNode specJsonNode()

Returns the specification JSON node for this component.

Returns:

the specification JSON node for this component.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object