flywheel.models.tree_container_request_spec
TreeContainerRequestSpec
Bases: object
fields property writable
Gets the fields of this TreeContainerRequestSpec.
The list of fields to include
Returns:
| Type | Description |
|---|---|
list[str] | The fields of this TreeContainerRequestSpec |
filter property writable
Gets the filter of this TreeContainerRequestSpec.
The optional, comma-separated filter string
Returns:
| Type | Description |
|---|---|
str | The filter of this TreeContainerRequestSpec |
join_origin property writable
Gets the join_origin of this TreeContainerRequestSpec.
Whether or not to join file origins, default is false
Returns:
| Type | Description |
|---|---|
bool | The join_origin of this TreeContainerRequestSpec |
limit property writable
Gets the limit of this TreeContainerRequestSpec.
The optional maximum number of children to include
Returns:
| Type | Description |
|---|---|
int | The limit of this TreeContainerRequestSpec |
sort property writable
Gets the sort of this TreeContainerRequestSpec.
The optional, comma-separated, sort specification
Returns:
| Type | Description |
|---|---|
str | The sort of this TreeContainerRequestSpec |
__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__(fields=None, filter=None, limit=None, sort=None, join_origin=None)
TreeContainerRequestSpec - a model defined in Swagger
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
fields | (list[str], optional) | The list of fields to include, defaults to None | None |
filter | (str, optional) | The optional, comma-separated filter string, defaults to None | None |
limit | (int, optional) | The optional maximum number of children to include, defaults to None | None |
sort | (str, optional) | The optional, comma-separated, sort specification, defaults to None | None |
join_origin | (bool, optional) | Whether or not to join file origins, default is false, 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