Field behavior

Rules for AIP-203, covering field behavior.

Rule name Description
immutable Immutable fields should be annotated.
input-only Input only fields should be annotated.
optional Optional fields may be annotated.
optional-conflict Optional fields must not have any other field behavior.
optional-consistency Optional fields should either be always or never annotated.
output-only Output only fields should be annotated.
required Required fields should be annotated.

Note: Because AIPs sometimes cover topics that have some overlap, some rules related to field behavior may be included in the rules for other AIPs.