Package org.apache.iceberg.types

Class Types.NestedField

java.lang.Object

org.apache.iceberg.types.Types.NestedField

All Implemented Interfaces:

Serializable

Enclosing class:

Types

public static class Types.NestedField
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Types.NestedField.Builder

Method Summary

Modifier and Type	Method	Description
Types.NestedField	asOptional()
Types.NestedField	asRequired()
String	doc()
boolean	equals(Object o)
int	fieldId()
static Types.NestedField.Builder	from(Types.NestedField field)
int	hashCode()
Object	initialDefault()
boolean	isOptional()
boolean	isRequired()
String	name()
static Types.NestedField	of(int id, boolean isOptional, String name, Type type)
static Types.NestedField	of(int id, boolean isOptional, String name, Type type, String doc)
static Types.NestedField	optional(int id, String name, Type type)
static Types.NestedField	optional(int id, String name, Type type, String doc)
static Types.NestedField.Builder	optional(String name)
static Types.NestedField	required(int id, String name, Type type)
static Types.NestedField	required(int id, String name, Type type, String doc)
static Types.NestedField.Builder	required(String name)
String	toString()
Type	type()
Types.NestedField	withFieldId(int newId)	Deprecated. will be removed in 2.0.0; use Types.NestedField.Builder.withId(int) instead
Object	writeDefault()

Methods inherited from class java.lang.Object

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

Method Details

optional

public static Types.NestedField optional(int id,
 String name,
 Type type)

optional

public static Types.NestedField optional(int id,
 String name,
 Type type,
 String doc)

required

public static Types.NestedField required(int id,
 String name,
 Type type)

required

public static Types.NestedField required(int id,
 String name,
 Type type,
 String doc)

of

public static Types.NestedField of(int id,
 boolean isOptional,
 String name,
 Type type)

of

public static Types.NestedField of(int id,
 boolean isOptional,
 String name,
 Type type,
 String doc)

from

public static Types.NestedField.Builder from(Types.NestedField field)

required

public static Types.NestedField.Builder required(String name)

optional

public static Types.NestedField.Builder optional(String name)

isOptional

public boolean isOptional()

asOptional

public Types.NestedField asOptional()

isRequired

public boolean isRequired()

asRequired

public Types.NestedField asRequired()

withFieldId

@Deprecated
public Types.NestedField withFieldId(int newId)

Deprecated.

will be removed in 2.0.0; use Types.NestedField.Builder.withId(int) instead

fieldId

public int fieldId()

name

public String name()

type

public Type type()

doc

public String doc()

initialDefault

public Object initialDefault()

writeDefault

public Object writeDefault()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object