nebius.api.nebius.FieldBehavior

class documentation

class FieldBehavior(pb_enum.Enum): (source)

View In Hierarchy

Undocumented

Constant __PB2_DESCRIPTOR__ Undocumented
Constant FIELD_BEHAVIOR_UNSPECIFIED Undocumented
Constant IDENTIFIER Indicates field is a resource ID, so it MUST be present on a resource update, but MUST NOT be set on create. Otherwise, RPC will fail with the `INVALID_ARGUMENT` error
Constant IMMUTABLE This indicates that the field can't be changed during a resource update. Changing the field value will cause an `INVALID_ARGUMENT` error. Resource recreate requires a change of the field value.
Constant INPUT_ONLY Indicates field is not present in output.
Constant MEANINGFUL_EMPTY_VALUE Indicates that an empty message and a null have different semantics. Usually, that field is a feature spec message: its empty message enables that feature, and null disables it. Such a message is different from `bool` because it already has some feature parameters, or they can be added later in a backward-compatible way...
Constant NON_EMPTY_DEFAULT Indicates that an empty (default) value will be filled by the server. Usually, that field is a feature spec value, which by default is computed. Values marked with this annotation won't raise error if they are not set and the returned value is not equal to protobuf default.
Constant OUTPUT_ONLY Indicates field can't be set on create or changed on update. Otherwise, RPC will fail with the `INVALID_ARGUMENT` error

Inherited from Enum:

Class Method get_descriptor Undocumented
__PB2_DESCRIPTOR__ = (source)

Undocumented

Value
descriptor.DescriptorWrap[descriptor_1.EnumDescriptor]('.nebius.FieldBehavior',
                                                       annotations_pb2.DESCRIPTOR↵
,
                                                       descriptor_1.EnumDescriptor↵
)
FIELD_BEHAVIOR_UNSPECIFIED: int = (source)

Undocumented

Value
0
IDENTIFIER: int = (source)

Indicates field is a resource ID, so it MUST be present on a resource update, but MUST NOT be set on create. Otherwise, RPC will fail with the `INVALID_ARGUMENT` error

Value
3
IMMUTABLE: int = (source)

This indicates that the field can't be changed during a resource update. Changing the field value will cause an `INVALID_ARGUMENT` error. Resource recreate requires a change of the field value.

Value
2
INPUT_ONLY: int = (source)

Indicates field is not present in output.

Value
4
MEANINGFUL_EMPTY_VALUE: int = (source)

Indicates that an empty message and a null have different semantics. Usually, that field is a feature spec message: its empty message enables that feature, and null disables it. Such a message is different from `bool` because it already has some feature parameters, or they can be added later in a backward-compatible way. IMPORTANT: if the message itself is recursive, this behavior is forced.

Value
6
NON_EMPTY_DEFAULT: int = (source)

Indicates that an empty (default) value will be filled by the server. Usually, that field is a feature spec value, which by default is computed. Values marked with this annotation won't raise error if they are not set and the returned value is not equal to protobuf default.

IMPORTANT: Updating this value from explicit to default may not lead to Update call in some tools (eg Terraform). Compound values (messages, lists and maps) may result in unpredictable updates (see examples in guidelines).

Value
7
OUTPUT_ONLY: int = (source)

Indicates field can't be set on create or changed on update. Otherwise, RPC will fail with the `INVALID_ARGUMENT` error

Value
5