KeyFieldOutOfBoundsException (Flink : Core 1.18.1-cp1 API)

java.lang.Object
- java.lang.Throwable
- - java.lang.Exception
  - - java.lang.RuntimeException
    - - org.apache.flink.types.KeyFieldOutOfBoundsException

All Implemented Interfaces:

Serializable
```
@Public
public class KeyFieldOutOfBoundsException
extends RuntimeException
```
An exception specifying that a required key field was not set in a record, i.e. was null.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`KeyFieldOutOfBoundsException()`	Constructs an `KeyFieldOutOfBoundsException` with `null` as its error detail message.
`KeyFieldOutOfBoundsException(int fieldNumber)`	Constructs an `KeyFieldOutOfBoundsException` with a default message, referring to given field number as the null key field.
`KeyFieldOutOfBoundsException(int fieldNumber, Throwable parent)`
`KeyFieldOutOfBoundsException(String message)`	Constructs an `KeyFieldOutOfBoundsException` with the specified detail message.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

int getFieldNumber()
Gets the field number that was attempted to access.
- Methods inherited from class java.lang.Throwable
  addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KeyFieldOutOfBoundsException
```
public KeyFieldOutOfBoundsException()
```
    Constructs an KeyFieldOutOfBoundsException with null as its error detail message.
  - KeyFieldOutOfBoundsException
```
public KeyFieldOutOfBoundsException(String message)
```
    Constructs an KeyFieldOutOfBoundsException with the specified detail message.
    
    Parameters:
    
    message - The detail message.
  - KeyFieldOutOfBoundsException
```
public KeyFieldOutOfBoundsException(int fieldNumber)
```
    Constructs an KeyFieldOutOfBoundsException with a default message, referring to given field number as the null key field.
    
    Parameters:
    
    fieldNumber - The index of the field that was null, bit expected to hold a key.
  - KeyFieldOutOfBoundsException
```
public KeyFieldOutOfBoundsException(int fieldNumber,
                                    Throwable parent)
```
- Method Detail
  - getFieldNumber
```
public int getFieldNumber()
```
    Gets the field number that was attempted to access. If the number is not set, this method returns -1.
    
    Returns:
    
    The field number that was attempted to access, or -1, if not set.