Package dev.restate.admin.model

Class HandlerMetadata

java.lang.Object

dev.restate.admin.model.HandlerMetadata

public class HandlerMetadata
extends Object

HandlerMetadata

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_DOCUMENTATION
static final String	JSON_PROPERTY_INPUT_DESCRIPTION
static final String	JSON_PROPERTY_INPUT_JSON_SCHEMA
static final String	JSON_PROPERTY_METADATA
static final String	JSON_PROPERTY_NAME
static final String	JSON_PROPERTY_OUTPUT_DESCRIPTION
static final String	JSON_PROPERTY_OUTPUT_JSON_SCHEMA
static final String	JSON_PROPERTY_TY

Constructor Summary

Constructors

Constructor	Description
HandlerMetadata()

Method Summary

Modifier and Type	Method	Description
HandlerMetadata	documentation(String documentation)
boolean	equals(Object o)	Return true if this HandlerMetadata object is equal to o.
String	getDocumentation()	Documentation of the handler, as propagated by the SDKs.
String	getInputDescription()	If empty, no schema was provided by the user at discovery time.
Object	getInputJsonSchema()	JSON Schema of the handler input
Map<String,String>	getMetadata()	Additional handler metadata, as propagated by the SDKs.
String	getName()	Get name
String	getOutputDescription()	If empty, no schema was provided by the user at discovery time.
Object	getOutputJsonSchema()	JSON Schema of the handler output
HandlerMetadataType	getTy()	Get ty
int	hashCode()
HandlerMetadata	inputDescription(String inputDescription)
HandlerMetadata	inputJsonSchema(Object inputJsonSchema)
HandlerMetadata	metadata(Map<String,String> metadata)
HandlerMetadata	name(String name)
HandlerMetadata	outputDescription(String outputDescription)
HandlerMetadata	outputJsonSchema(Object outputJsonSchema)
HandlerMetadata	putMetadataItem(String key, String metadataItem)
void	setDocumentation(String documentation)
void	setInputDescription(String inputDescription)
void	setInputJsonSchema(Object inputJsonSchema)
void	setMetadata(Map<String,String> metadata)
void	setName(String name)
void	setOutputDescription(String outputDescription)
void	setOutputJsonSchema(Object outputJsonSchema)
void	setTy(HandlerMetadataType ty)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
HandlerMetadata	ty(HandlerMetadataType ty)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_NAME

public static final String JSON_PROPERTY_NAME

See Also:

• Constant Field Values

JSON_PROPERTY_TY

public static final String JSON_PROPERTY_TY

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENTATION

public static final String JSON_PROPERTY_DOCUMENTATION

See Also:

• Constant Field Values

JSON_PROPERTY_METADATA

public static final String JSON_PROPERTY_METADATA

See Also:

• Constant Field Values

JSON_PROPERTY_INPUT_DESCRIPTION

public static final String JSON_PROPERTY_INPUT_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_OUTPUT_DESCRIPTION

public static final String JSON_PROPERTY_OUTPUT_DESCRIPTION

See Also:

• Constant Field Values

JSON_PROPERTY_INPUT_JSON_SCHEMA

public static final String JSON_PROPERTY_INPUT_JSON_SCHEMA

See Also:

• Constant Field Values

JSON_PROPERTY_OUTPUT_JSON_SCHEMA

public static final String JSON_PROPERTY_OUTPUT_JSON_SCHEMA

See Also:

• Constant Field Values

Constructor Details

HandlerMetadata

public HandlerMetadata()

Method Details

name

public HandlerMetadata name(String name)

getName

@Nonnull
public String getName()

Get name

Returns:

name

setName

public void setName(String name)

ty

public HandlerMetadata ty(HandlerMetadataType ty)

getTy

@Nullable
public HandlerMetadataType getTy()

Get ty

Returns:

ty

setTy

public void setTy(HandlerMetadataType ty)

documentation

public HandlerMetadata documentation(String documentation)

getDocumentation

@Nullable
public String getDocumentation()

Documentation of the handler, as propagated by the SDKs.

Returns:

documentation

setDocumentation

public void setDocumentation(String documentation)

metadata

public HandlerMetadata metadata(Map<String,String> metadata)

putMetadataItem

public HandlerMetadata putMetadataItem(String key,
 String metadataItem)

getMetadata

@Nullable
public Map<String,String> getMetadata()

Additional handler metadata, as propagated by the SDKs.

Returns:

metadata

setMetadata

public void setMetadata(Map<String,String> metadata)

inputDescription

public HandlerMetadata inputDescription(String inputDescription)

getInputDescription

@Nonnull
public String getInputDescription()

If empty, no schema was provided by the user at discovery time.

Returns:

inputDescription

setInputDescription

public void setInputDescription(String inputDescription)

outputDescription

public HandlerMetadata outputDescription(String outputDescription)

getOutputDescription

@Nonnull
public String getOutputDescription()

If empty, no schema was provided by the user at discovery time.

Returns:

outputDescription

setOutputDescription

public void setOutputDescription(String outputDescription)

inputJsonSchema

public HandlerMetadata inputJsonSchema(Object inputJsonSchema)

getInputJsonSchema

@Nullable
public Object getInputJsonSchema()

JSON Schema of the handler input

Returns:

inputJsonSchema

setInputJsonSchema

public void setInputJsonSchema(Object inputJsonSchema)

outputJsonSchema

public HandlerMetadata outputJsonSchema(Object outputJsonSchema)

getOutputJsonSchema

@Nullable
public Object getOutputJsonSchema()

JSON Schema of the handler output

Returns:

outputJsonSchema

setOutputJsonSchema

public void setOutputJsonSchema(Object outputJsonSchema)

equals

public boolean equals(Object o)

Return true if this HandlerMetadata object is equal to o.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string