flywheel.models.custom_field
CustomField
Bases: object
description property writable
Gets the description of this CustomField.
Returns:
| Type | Description |
|---|---|
str | The description of this CustomField |
error_text property writable
Gets the error_text of this CustomField.
Returns:
| Type | Description |
|---|---|
str | The error_text of this CustomField |
helper_text property writable
Gets the helper_text of this CustomField.
Returns:
| Type | Description |
|---|---|
str | The helper_text of this CustomField |
key property writable
Gets the key of this CustomField.
Returns:
| Type | Description |
|---|---|
str | The key of this CustomField |
label property writable
Gets the label of this CustomField.
Returns:
| Type | Description |
|---|---|
str | The label of this CustomField |
options property writable
Gets the options of this CustomField.
Returns:
| Type | Description |
|---|---|
list[SelectItem] | The options of this CustomField |
placeholder property writable
Gets the placeholder of this CustomField.
Returns:
| Type | Description |
|---|---|
str | The placeholder of this CustomField |
required_when_visible property writable
Gets the required_when_visible of this CustomField.
Returns:
| Type | Description |
|---|---|
union[bool,list[object]] | The required_when_visible of this CustomField |
type property writable
Gets the type of this CustomField.
Returns:
| Type | Description |
|---|---|
FieldType | The type of this CustomField |
validation property writable
Gets the validation of this CustomField.
Returns:
| Type | Description |
|---|---|
list[ValidationRule] | The validation of this CustomField |
visible property writable
Gets the visible of this CustomField.
Returns:
| Type | Description |
|---|---|
union[bool,list[object]] | The visible of this CustomField |
__contains__(key)
Checks if the given value is a key in this object
__eq__(other)
Returns true if both objects are equal
__getitem__(key)
Returns the value of key
__init__(type=None, label=None, description=None, placeholder=None, key=None, helper_text=None, error_text=None, visible=None, required_when_visible=None, validation=None, options=None)
CustomField - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
type | (FieldType, optional) | , defaults to None | None |
label | (str, optional) | , defaults to None | None |
description | (str, optional) | , defaults to None | None |
placeholder | (str, optional) | , defaults to None | None |
key | (str, optional) | , defaults to None | None |
helper_text | (str, optional) | , defaults to None | None |
error_text | (str, optional) | , defaults to None | None |
visible | (union[bool, list[object]], optional) | , defaults to None | None |
required_when_visible | (union[bool, list[object]], optional) | , defaults to None | None |
validation | (list[ValidationRule], optional) | , defaults to None | None |
options | (list[SelectItem], optional) | , defaults to None | None |
__ne__(other)
Returns true if both objects are not equal
__repr__()
For print and pprint
__setitem__(key, value)
Sets the value of key
get(key, default=None)
Get the value of the provided json property, or default
items()
Returns the list of json property to value mapping
keys()
Returns the list of json properties in the object
positional_to_model(value) staticmethod
Converts a positional argument to a model value
return_value()
Unwraps return value from model
to_dict()
Returns the model properties as a dict
to_str()
Returns the string representation of the model
values()
Returns the list of values in the object