jira.Worklog

class documentation

class Worklog(Resource): (source)

View In Hierarchy

Worklog on an issue.

Method __init__ Initializes a generic resource.
Method delete Delete this worklog entry from its associated issue.
Instance Variable raw Undocumented

Inherited from Resource:

Method __eq__ Default equality test.
Method __getattr__ Allow access of attributes via names.
Method __getstate__ Pickling the resource.
Method __hash__ Hash calculation.
Method __repr__ Identify the class and include any and all relevant values.
Method __setstate__ Unpickling of the resource.
Method __str__ Return the first value we find that is likely to be human-readable.
Method find Finds a resource based on the input parameters.
Method update Update this resource on the server.
Constant JIRA_BASE_URL Undocumented
Method _default_headers Undocumented
Method _find_by_url Finds a resource on the specified url.
Method _get_url Gets the url for the specified path.
Method _load Load a resource.
Method _parse_raw Parse a raw dictionary to create a resource.
Constant _HASH_IDS Undocumented
Constant _READABLE_IDS Undocumented
Instance Variable _base_url Undocumented
Instance Variable _options Undocumented
Instance Variable _resource Undocumented
Instance Variable _session Undocumented
def __init__(self, options: Dict[str, str], session: ResilientSession, raw: Dict[str, Any] = None): (source)
overrides jira.resources.Resource.__init__

Initializes a generic resource. Args: resource (str): The name of the resource. options (Dict[str,str]): Options for the new resource session (ResilientSession): Session used for the resource. base_url (Optional[str]): The Base Jira url.

def delete(self, adjustEstimate: Optional[str] = None, newEstimate=None, increaseBy=None): (source)
overrides jira.resources.Resource.delete

Delete this worklog entry from its associated issue. Args: adjustEstimate: one of ``new``, ``leave``, ``manual`` or ``auto``. ``auto`` is the default and adjusts the estimate automatically. ``leave`` leaves the estimate unchanged by this deletion. newEstimate: combined with ``adjustEstimate=new``, set the estimate to this value increaseBy: combined with ``adjustEstimate=manual``, increase the remaining estimate by this amount

raw: Dict[str, Any] = (source)
overrides jira.resources.Resource.raw

Undocumented