Skip to content

flywheel.models.search_response

SearchResponse

Bases: SearchResponseMixin

acquisition property writable

Gets the acquisition of this SearchResponse.

Returns:

Type Description
SearchAcquisitionResponse

The acquisition of this SearchResponse

analysis property writable

Gets the analysis of this SearchResponse.

Returns:

Type Description
SearchAnalysisResponse

The analysis of this SearchResponse

collection property writable

Gets the collection of this SearchResponse.

Returns:

Type Description
SearchCollectionResponse

The collection of this SearchResponse

file property writable

Gets the file of this SearchResponse.

Returns:

Type Description
SearchFileResponse

The file of this SearchResponse

group property writable

Gets the group of this SearchResponse.

Returns:

Type Description
SearchGroupResponse

The group of this SearchResponse

parent property writable

Gets the parent of this SearchResponse.

Returns:

Type Description
SearchParentResponse

The parent of this SearchResponse

permissions property writable

Gets the permissions of this SearchResponse.

Returns:

Type Description
list[RolesRoleAssignment]

The permissions of this SearchResponse

project property writable

Gets the project of this SearchResponse.

Returns:

Type Description
SearchProjectResponse

The project of this SearchResponse

return_type property writable

Gets the return_type of this SearchResponse.

Returns:

Type Description
SearchReturnType

The return_type of this SearchResponse

session property writable

Gets the session of this SearchResponse.

Returns:

Type Description
SearchSessionResponse

The session of this SearchResponse

subject property writable

Gets the subject of this SearchResponse.

Returns:

Type Description
SearchSubjectResponse

The subject of this SearchResponse

__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__(return_type=None, project=None, group=None, session=None, acquisition=None, subject=None, file=None, collection=None, analysis=None, parent=None, permissions=None)

SearchResponse - a model defined in Swagger

Parameters:

Name Type Description Default
return_type (SearchReturnType, optional)

, defaults to None

None
project (SearchProjectResponse, optional)

, defaults to None

None
group (SearchGroupResponse, optional)

, defaults to None

None
session (SearchSessionResponse, optional)

, defaults to None

None
acquisition (SearchAcquisitionResponse, optional)

, defaults to None

None
subject (SearchSubjectResponse, optional)

, defaults to None

None
file (SearchFileResponse, optional)

, defaults to None

None
collection (SearchCollectionResponse, optional)

, defaults to None

None
analysis (SearchAnalysisResponse, optional)

, defaults to None

None
parent (SearchParentResponse, optional)

, defaults to None

None
permissions (list[RolesRoleAssignment], 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