stix.report.header Module¶

Classes¶

class stix.report.header.Header(title=None, description=None, short_description=None, handling=None, intents=None, information_source=None)¶

Bases: stix.base.Entity

The Report Header.

Parameters:	handling – The data marking section of the Header. information_source – The InformationSource section of the Header. intents – A collection of VocabString defining the intent of the parent Report. description – A description of the intent or purpose of the parent Report. short_description – A short description of the intent or purpose of the parent Report. title – The title of the Report.

title¶

The title of the parent Report.

add_description(description)¶

Adds a description to the descriptions collection.

This is the same as calling “foo.descriptions.add(bar)”.

add_intent(intent)¶

Adds VocabString object to the intents collection.

If the input is not an instance of VocabString, an effort will be made to convert it into an instance of ReportIntent.

add_short_description(description)¶

Adds a description to the short_descriptions collection.

This is the same as calling “foo.short_descriptions.add(bar)”.

description¶

A single description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one description set, this will return the description with the lowest ordinality value.

Returns:	An instance of StructuredText

short_description¶

A single short description about the contents or purpose of this object.

Default Value: None

Note

If this object has more than one short description set, this will return the description with the lowest ordinality value.

Returns:	An instance of StructuredText