Skip to content

flywheel.models.container_pipeline_input

ContainerPipelineInput

Bases: object

columns property writable

Gets the columns of this ContainerPipelineInput.

Returns:

Type Description
list[Column]

The columns of this ContainerPipelineInput

description property writable

Gets the description of this ContainerPipelineInput.

Returns:

Type Description
str

The description of this ContainerPipelineInput

error_column property writable

Gets the error_column of this ContainerPipelineInput.

Whether or not to include errors column. Default is true

Returns:

Type Description
bool

The error_column of this ContainerPipelineInput

file_spec property writable

Gets the file_spec of this ContainerPipelineInput.

Returns:

Type Description
DataViewFileSpec

The file_spec of this ContainerPipelineInput

filter property writable

Gets the filter of this ContainerPipelineInput.

Returns:

Type Description
str

The filter of this ContainerPipelineInput

group_by property writable

Gets the group_by of this ContainerPipelineInput.

Returns:

Type Description
GroupBy

The group_by of this ContainerPipelineInput

id property writable

Gets the id of this ContainerPipelineInput.

Unique database ID

Returns:

Type Description
str

The id of this ContainerPipelineInput

include_ids property writable

Gets the include_ids of this ContainerPipelineInput.

Whether or not to include container id fields. Default is true

Returns:

Type Description
bool

The include_ids of this ContainerPipelineInput

include_labels property writable

Gets the include_labels of this ContainerPipelineInput.

Whether or not to include container label fields. Default is true

Returns:

Type Description
bool

The include_labels of this ContainerPipelineInput

label property writable

Gets the label of this ContainerPipelineInput.

Application-specific label

Returns:

Type Description
str

The label of this ContainerPipelineInput

missing_data_strategy property writable

Gets the missing_data_strategy of this ContainerPipelineInput.

Returns:

Type Description
DataStrategy

The missing_data_strategy of this ContainerPipelineInput

origin property writable

Gets the origin of this ContainerPipelineInput.

Returns:

Type Description
Origin

The origin of this ContainerPipelineInput

parent property writable

Gets the parent of this ContainerPipelineInput.

The parent container id

Returns:

Type Description
str

The parent of this ContainerPipelineInput

sort property writable

Gets the sort of this ContainerPipelineInput.

Opt out of sorting results by setting value to false

Returns:

Type Description
bool

The sort of this ContainerPipelineInput

__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__(parent=None, label=None, description=None, columns=None, file_spec=None, filter=None, group_by=None, include_ids=None, include_labels=None, error_column=None, missing_data_strategy=None, sort=False, id=None, origin=None)

ContainerPipelineInput - a model defined in Swagger

Parameters:

Name Type Description Default
parent (str, optional)

The parent container id, defaults to None

None
label (str, optional)

Application-specific label, defaults to None

None
description (str, optional)

, defaults to None

None
columns (list[Column], optional)

, defaults to None

None
file_spec (DataViewFileSpec, optional)

, defaults to None

None
filter (str, optional)

, defaults to None

None
group_by (GroupBy, optional)

, defaults to None

None
include_ids (bool, optional)

Whether or not to include container id fields. Default is true, defaults to None

None
include_labels (bool, optional)

Whether or not to include container label fields. Default is true, defaults to None

None
error_column (bool, optional)

Whether or not to include errors column. Default is true, defaults to None

None
missing_data_strategy (DataStrategy, optional)

, defaults to None

None
sort (bool, optional)

Opt out of sorting results by setting value to false, defaults to False

False
id (str, optional)

Unique database ID, defaults to None

None
origin (Origin, 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