FieldBehavior class

An indicator of the behavior of a given field (for example, that a field is required in requests, or given as output but ignored as input). This does not change the behavior in protocol buffers itself; it only denotes the behavior and may affect how API tooling handles the field.

Note: This enum may receive new values in the future.

Inheritance

• Object
• ProtobufEnum
• FieldBehavior

Properties

hashCode → int

The hash code for this object.

no setter, inherited

name → String

This enum's name, as specified in the .proto file.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

value → int

This enum's integer value, as specified in the .proto file.

final, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

Returns this enum's name or the value if names are not represented.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

valueOf(int value) → FieldBehavior?

Constants

FIELD_BEHAVIOR_UNSPECIFIED → const FieldBehavior

Conventional default for enums. Do not use this.

IMMUTABLE → const FieldBehavior

Denotes a field as immutable. This indicates that the field may be set once in a request to create a resource, but may not be changed thereafter.

INPUT_ONLY → const FieldBehavior

Denotes a field as input only. This indicates that the field is provided in requests, and the corresponding field is not included in output.

OPTIONAL → const FieldBehavior

Specifically denotes a field as optional. While all fields in protocol buffers are optional, this may be specified for emphasis if appropriate.

OUTPUT_ONLY → const FieldBehavior

Denotes a field as output only. This indicates that the field is provided in responses, but including the field in a request does nothing (the server must ignore it and must not throw an error as a result of the field's presence).

REQUIRED → const FieldBehavior

Denotes a field as required. This indicates that the field must be provided as part of the request, and failure to do so will cause an error (usually INVALID_ARGUMENT).

UNORDERED_LIST → const FieldBehavior

Denotes that a (repeated) field is an unordered list. This indicates that the service may provide the elements of the list in any arbitrary order, rather than the order the user originally provided. Additionally, the list's order may or may not be stable.

values → const List<FieldBehavior>