iotfileservices.models package¶

Submodules¶

iotfileservices.models.badrequest module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Badrequest(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Badrequest.

Returns:	The id of this Badrequest.
Return type:	str

message¶

Gets the message of this Badrequest.

Returns:	The message of this Badrequest.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.conflict module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Conflict(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Conflict.

Returns:	The id of this Conflict.
Return type:	str

message¶

Gets the message of this Conflict.

Returns:	The message of this Conflict.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.delete_file_request module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class DeleteFileRequest(filepath=None, entity_id=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'entity_id': 'entityId', 'filepath': 'filepath'}¶

attribute_types = {'entity_id': 'str', 'filepath': 'str'}¶

entity_id¶

Gets the entity_id of this DeleteFileRequest.

Returns:	The entity_id of this DeleteFileRequest.
Return type:	str

filepath¶

Gets the filepath of this DeleteFileRequest.

Returns:	The filepath of this DeleteFileRequest.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.error module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Error(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Error.

Returns:	The id of this Error.
Return type:	str

message¶

Gets the message of this Error.

Returns:	The message of this Error.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.file_response module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class FileResponse(name=None, path=None, type=None, size=None, timestamp=None, created=None, updated=None, created_by=None, updated_by=None, description=None, e_tag=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'created': 'created', 'created_by': 'createdBy', 'description': 'description', 'e_tag': 'eTag', 'name': 'name', 'path': 'path', 'size': 'size', 'timestamp': 'timestamp', 'type': 'type', 'updated': 'updated', 'updated_by': 'updatedBy'}¶

attribute_types = {'created': 'datetime', 'created_by': 'str', 'description': 'str', 'e_tag': 'int', 'name': 'str', 'path': 'str', 'size': 'int', 'timestamp': 'datetime', 'type': 'str', 'updated': 'datetime', 'updated_by': 'str'}¶

created¶

Gets the created of this FileResponse.

Returns:	The created of this FileResponse.
Return type:	datetime

created_by¶

Gets the created_by of this FileResponse.

Returns:	The created_by of this FileResponse.
Return type:	str

description¶

Gets the description of this FileResponse.

Returns:	The description of this FileResponse.
Return type:	str

e_tag¶

Gets the e_tag of this FileResponse.

Returns:	The e_tag of this FileResponse.
Return type:	int

name¶

Gets the name of this FileResponse.

Returns:	The name of this FileResponse.
Return type:	str

path¶

Gets the path of this FileResponse.

Returns:	The path of this FileResponse.
Return type:	str

size¶

Gets the size of this FileResponse.

Returns:	The size of this FileResponse.
Return type:	int

timestamp¶

Gets the timestamp of this FileResponse.

Returns:	The timestamp of this FileResponse.
Return type:	datetime

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this FileResponse.

Returns:	The type of this FileResponse.
Return type:	str

updated¶

Gets the updated of this FileResponse.

Returns:	The updated of this FileResponse.
Return type:	datetime

updated_by¶

Gets the updated_by of this FileResponse.

Returns:	The updated_by of this FileResponse.
Return type:	str

iotfileservices.models.fileslist module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Fileslist(object_key=None, part_no=None, created=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'created': 'created', 'object_key': 'objectKey', 'part_no': 'partNo'}¶

attribute_types = {'created': 'int', 'object_key': 'str', 'part_no': 'int'}¶

created¶

Gets the created of this Fileslist.

Returns:	The created of this Fileslist.
Return type:	int

object_key¶

Gets the object_key of this Fileslist.

Returns:	The object_key of this Fileslist.
Return type:	str

part_no¶

Gets the part_no of this Fileslist.

Returns:	The part_no of this Fileslist.
Return type:	int

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.get_file_list_request module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class GetFileListRequest(filepath=None, entity_id=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'entity_id': 'entityId', 'filepath': 'filepath'}¶

attribute_types = {'entity_id': 'str', 'filepath': 'str'}¶

entity_id¶

Gets the entity_id of this GetFileListRequest.

Returns:	The entity_id of this GetFileListRequest.
Return type:	str

filepath¶

Gets the filepath of this GetFileListRequest.

Returns:	The filepath of this GetFileListRequest.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.get_file_request module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class GetFileRequest(if_none_match=None, filepath=None, range=None, entity_id=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'entity_id': 'entityId', 'filepath': 'filepath', 'if_none_match': 'If-None-Match', 'range': 'range'}¶

attribute_types = {'entity_id': 'str', 'filepath': 'str', 'if_none_match': 'int', 'range': 'str'}¶

entity_id¶

Gets the entity_id of this GetFileRequest.

Returns:	The entity_id of this GetFileRequest.
Return type:	str

filepath¶

Gets the filepath of this GetFileRequest.

Returns:	The filepath of this GetFileRequest.
Return type:	str

if_none_match¶

Gets the if_none_match of this GetFileRequest.

Returns:	The if_none_match of this GetFileRequest.
Return type:	int

range¶

Gets the range of this GetFileRequest.

Returns:	The range of this GetFileRequest.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.notfound module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Notfound(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Notfound.

Returns:	The id of this Notfound.
Return type:	str

message¶

Gets the message of this Notfound.

Returns:	The message of this Notfound.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.notmodified module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Notmodified(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Notmodified.

Returns:	The id of this Notmodified.
Return type:	str

message¶

Gets the message of this Notmodified.

Returns:	The message of this Notmodified.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.put_file_request module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class PutFileRequest(file=None, if_match=None, filepath=None, upload=None, part=None, description=None, entity_id=None, type=None, timestamp=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'description': 'description', 'entity_id': 'entityId', 'file': 'file', 'filepath': 'filepath', 'if_match': 'If-Match', 'part': 'part', 'timestamp': 'timestamp', 'type': 'type', 'upload': 'upload'}¶

attribute_types = {'description': 'str', 'entity_id': 'str', 'file': 'str', 'filepath': 'str', 'if_match': 'int', 'part': 'int', 'timestamp': 'str', 'type': 'str', 'upload': 'str'}¶

description¶

Gets the description of this PutFileRequest.

Returns:	The description of this PutFileRequest.
Return type:	str

entity_id¶

Gets the entity_id of this PutFileRequest.

Returns:	The entity_id of this PutFileRequest.
Return type:	str

file¶

Gets the file of this PutFileRequest.

Returns:	The file of this PutFileRequest.
Return type:	str

filepath¶

Gets the filepath of this PutFileRequest.

Returns:	The filepath of this PutFileRequest.
Return type:	str

if_match¶

Gets the if_match of this PutFileRequest.

Returns:	The if_match of this PutFileRequest.
Return type:	int

part¶

Gets the part of this PutFileRequest.

Returns:	The part of this PutFileRequest.
Return type:	int

timestamp¶

Gets the timestamp of this PutFileRequest.

Returns:	The timestamp of this PutFileRequest.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

type¶

Gets the type of this PutFileRequest.

Returns:	The type of this PutFileRequest.
Return type:	str

upload¶

Gets the upload of this PutFileRequest.

Returns:	The upload of this PutFileRequest.
Return type:	str

iotfileservices.models.rangenotsatisfiable module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Rangenotsatisfiable(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Rangenotsatisfiable.

Returns:	The id of this Rangenotsatisfiable.
Return type:	str

message¶

Gets the message of this Rangenotsatisfiable.

Returns:	The message of this Rangenotsatisfiable.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.search_files_request module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class SearchFilesRequest(filter=None, offset=None, limit=None, count=None, entity_id=None, order=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'count': 'count', 'entity_id': 'entityId', 'filter': 'filter', 'limit': 'limit', 'offset': 'offset', 'order': 'order'}¶

attribute_types = {'count': 'bool', 'entity_id': 'str', 'filter': 'str', 'limit': 'int', 'offset': 'float', 'order': 'str'}¶

count¶

Gets the count of this SearchFilesRequest.

Returns:	The count of this SearchFilesRequest.
Return type:	bool

entity_id¶

Gets the entity_id of this SearchFilesRequest.

Returns:	The entity_id of this SearchFilesRequest.
Return type:	str

filter¶

Gets the filter of this SearchFilesRequest.

Returns:	The filter of this SearchFilesRequest.
Return type:	str

limit¶

Gets the limit of this SearchFilesRequest.

Returns:	The limit of this SearchFilesRequest.
Return type:	int

offset¶

Gets the offset of this SearchFilesRequest.

Returns:	The offset of this SearchFilesRequest.
Return type:	float

order¶

Gets the order of this SearchFilesRequest.

Returns:	The order of this SearchFilesRequest.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

iotfileservices.models.unauthorized module¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501

class Unauthorized(id=None, message=None)[source]¶

Bases: object

Attributes:

attribute_types (dict): The key is attribute name: and the value is attribute type.
attribute_map (dict): The key is attribute name: and the value is json key in definition.

attribute_map = {'id': 'id', 'message': 'message'}¶

attribute_types = {'id': 'str', 'message': 'str'}¶

id¶

Gets the id of this Unauthorized.

Returns:	The id of this Unauthorized.
Return type:	str

message¶

Gets the message of this Unauthorized.

Returns:	The message of this Unauthorized.
Return type:	str

to_dict()[source]¶: Returns the model properties as a dict

to_str()[source]¶: Returns the string representation of the model

Module contents¶

IoT File API

The IoT File API enables storing and retrieving files for entity instances. # noqa: E501