roboto.domain.comments#

Submodules#

Package Contents#

class roboto.domain.comments.Comment(record, roboto_client=None)#

Comments can be made on a number of Roboto resources, like datasets, files, action invocations, and more. They support @<user_id> mention syntax that you can use to notify others of the comment.

Parameters:
property comment_id: str#
Return type:

str

classmethod create(comment_text, entity_id, entity_type, roboto_client=None, caller_org_id=None)#
Parameters:
Return type:

Comment

property created: datetime.datetime#
Return type:

datetime.datetime

property created_by: str#
Return type:

str

delete_comment()#
Return type:

None

classmethod for_entity(entity_type, entity_id, owner_org_id=None, page_token=None, roboto_client=None)#
Parameters:
Return type:

tuple[collections.abc.Sequence[Comment], Optional[str]]

classmethod for_entity_type(entity_type, owner_org_id=None, page_token=None, roboto_client=None)#
Parameters:
Return type:

tuple[collections.abc.Sequence[Comment], Optional[str]]

classmethod for_user(user_id, owner_org_id=None, page_token=None, roboto_client=None)#
Parameters:

  • user_id (str)

  • owner_org_id (Optional[str])

  • page_token (Optional[str])

  • roboto_client (Optional[roboto.http.RobotoClient])

Return type:

tuple[collections.abc.Sequence[Comment], Optional[str]]

classmethod from_id(comment_id, owner_org_id=None, roboto_client=None)#
Parameters:
Return type:

Comment

property modified: datetime.datetime#
Return type:

datetime.datetime

property modified_by: str#
Return type:

str

classmethod recent_for_org(owner_org_id=None, page_token=None, roboto_client=None)#
Parameters:
Return type:

tuple[collections.abc.Sequence[Comment], Optional[str]]

property record: roboto.domain.comments.record.CommentRecord#
Return type:

roboto.domain.comments.record.CommentRecord

update_comment(comment_text)#
Parameters:

comment_text (str)

Return type:

Comment

class roboto.domain.comments.CommentEntityType#

Bases: str, enum.Enum

Roboto entities that are comment-able.

Action = 'action'#
Collection = 'collection'#
Dataset = 'dataset'#
File = 'file'#
Invocation = 'invocation'#
Trigger = 'trigger'#
class roboto.domain.comments.CommentRecord(/, **data)#

Bases: pydantic.BaseModel

A wire-transmissible representation of a comment.

Parameters:

data (Any)

comment_id: str#
comment_text: str#
created: datetime.datetime#
created_by: str#
entity_id: str#
entity_type: CommentEntityType#
mentions: list[str] = None#
modified: datetime.datetime#
modified_by: str#
org_id: str#
class roboto.domain.comments.CreateCommentRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to create a comment

Parameters:

data (Any)

comment_text: str#
entity_id: str#
entity_type: roboto.domain.comments.record.CommentEntityType#
class roboto.domain.comments.UpdateCommentRequest(/, **data)#

Bases: pydantic.BaseModel

Request payload to update a comment

Parameters:

data (Any)

comment_text: str#
On this page