org.apache.pulsar.client.api.schema

Interface FieldSchemaBuilder<S extends FieldSchemaBuilder<S>>

public interface FieldSchemaBuilder<S extends FieldSchemaBuilder<S>>

Build a field for a record.

Method Summary

Modifier and Type	Method and Description
S	aliases(String... aliases) The optional name aliases of this field.
S	defaultValue(Object value) Set the default value of this field.
S	doc(String doc) The documentation of this field.
S	optional() Make this field optional.
S	property(String name, String val) Set name-value pair properties for this field.
S	required() Make this field required.
S	type(SchemaType type) The type of this field.

Method Detail

property

S property(String name,
           String val)

Set name-value pair properties for this field.

Parameters:

name - name of the property

val - value of the property

Returns:

field schema builder

doc

S doc(String doc)

The documentation of this field.

Parameters:

doc - documentation

Returns:

field schema builder

aliases

S aliases(String... aliases)

The optional name aliases of this field.

Parameters:

aliases - the name aliases of this field

Returns:

field schema builder

type

S type(SchemaType type)

The type of this field.

Currently only primitive types are supported.

Parameters:

type - schema type of this field

Returns:

field schema builder

optional

S optional()

Make this field optional.

Returns:

field schema builder

required

S required()

Make this field required.

Returns:

field schema builder

defaultValue

S defaultValue(Object value)

Set the default value of this field.

The value is validated against the schema type.

Returns:

value