nebius.api.nebius.MethodBehavior

class documentation

class MethodBehavior(pb_enum.Enum): (source)

View In Hierarchy

MethodBehavior describes special behaviors of a method that affect code generation and tooling.

Constant __PB2_DESCRIPTOR__ Undocumented
Constant METHOD_BEHAVIOR_UNSPECIFIED Indicates that the method behavior is default and is not specified. For instance, an Update method will lose its update semantics if this value is set. Does not mean anything if set along with other values.
Constant METHOD_PAGINATED Indicates that the method is used to list something, and supports pagination.
Constant METHOD_UPDATER Indicates that the method is used to update a resource or a number of resources, therefore it requires a reset mask to unset fields. This will enable SDKs to generate the reset mask on request, as well as the gateway to pass and sanitize it...
Constant METHOD_WITHOUT_GET Indicates that the method will create an operation, which doesn't have a gettable resource after its completion, and therefore must not call a get method. For instance, it can be used for long-running operations that don't return any resource, or for resource deletion operations.

Inherited from Enum:

Class Method get_descriptor Return the protobuf EnumDescriptor for this enum.
__PB2_DESCRIPTOR__ = (source)

Undocumented

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

Indicates that the method behavior is default and is not specified. For instance, an Update method will lose its update semantics if this value is set. Does not mean anything if set along with other values.

Value
0
METHOD_PAGINATED: int = (source)

Indicates that the method is used to list something, and supports pagination.

Value
3
METHOD_UPDATER: int = (source)

Indicates that the method is used to update a resource or a number of resources, therefore it requires a reset mask to unset fields. This will enable SDKs to generate the reset mask on request, as well as the gateway to pass and sanitize it. The CLI will add flags to set partial or full updates and custom reset masks.

Value
2
METHOD_WITHOUT_GET: int = (source)

Indicates that the method will create an operation, which doesn't have a gettable resource after its completion, and therefore must not call a get method. For instance, it can be used for long-running operations that don't return any resource, or for resource deletion operations.

Value
4