eventanalytics.models package

Submodules

eventanalytics.models.count_events_request module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class CountEventsRequest(data=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 = {'data': 'data'}
attribute_types = {'data': 'EventInput'}
data

Gets the data of this CountEventsRequest.

Returns:The data of this CountEventsRequest.
Return type:EventInput
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.duplicate_event_array_output module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class DuplicateEventArrayOutput(output=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 = {'output': 'output'}
attribute_types = {'output': 'list[Event]'}
output

Gets the output of this DuplicateEventArrayOutput.

Returns:The output of this DuplicateEventArrayOutput.
Return type:list[Event]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class Event(time=None, text=None, text_qc=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 = {'text': 'text', 'text_qc': 'text_qc', 'time': '_time'}
attribute_types = {'text': 'str', 'text_qc': 'int', 'time': 'str'}
text

Gets the text of this Event. The text of the event

Returns:The text of this Event.
Return type:str
text_qc

Gets the text_qc of this Event. Quality check flag

Returns:The text_qc of this Event.
Return type:int
time

Gets the time of this Event. Timestamp of the event in the ISO 8601

Returns:The time of this Event.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event_array_output module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventArrayOutput(output=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 = {'output': 'output'}
attribute_types = {'output': 'list[Event]'}
output

Gets the output of this EventArrayOutput.

Returns:The output of this EventArrayOutput.
Return type:list[Event]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event_count_output module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventCountOutput(output=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 = {'output': 'output'}
attribute_types = {'output': 'list[EventCountOutputItem]'}
output

Gets the output of this EventCountOutput.

Returns:The output of this EventCountOutput.
Return type:list[EventCountOutputItem]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event_count_output_item module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventCountOutputItem(start_time=None, end_time=None, event_count=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 = {'end_time': 'endTime', 'event_count': 'eventCount', 'start_time': 'startTime'}
attribute_types = {'end_time': 'str', 'event_count': 'int', 'start_time': 'str'}
end_time

Gets the end_time of this EventCountOutputItem. Timestamp of the event in the ISO 8601

Returns:The end_time of this EventCountOutputItem.
Return type:str
event_count

Gets the event_count of this EventCountOutputItem.

Returns:The event_count of this EventCountOutputItem.
Return type:int
start_time

Gets the start_time of this EventCountOutputItem. Timestamp of the event in the ISO 8601

Returns:The start_time of this EventCountOutputItem.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event_input module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventInput(events_metadata=None, events=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 = {'events': 'events', 'events_metadata': 'eventsMetadata'}
attribute_types = {'events': 'list[Event]', 'events_metadata': 'EventInputEventsMetadata'}
events

Gets the events of this EventInput.

Returns:The events of this EventInput.
Return type:list[Event]
events_metadata

Gets the events_metadata of this EventInput.

Returns:The events_metadata of this EventInput.
Return type:EventInputEventsMetadata
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event_input_events_metadata module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventInputEventsMetadata(event_text_property_name=None, split_interval=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 = {'event_text_property_name': 'eventTextPropertyName', 'split_interval': 'splitInterval'}
attribute_types = {'event_text_property_name': 'str', 'split_interval': 'int'}
event_text_property_name

Gets the event_text_property_name of this EventInputEventsMetadata. The property name of the events list objects that contains the text of the event

Returns:The event_text_property_name of this EventInputEventsMetadata.
Return type:str
split_interval

Gets the split_interval of this EventInputEventsMetadata. The window length represents the value in milliseconds of the period in which user wants to split input interval

Returns:The split_interval of this EventInputEventsMetadata.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.event_search_input_data_model module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventSearchInputDataModel(events_metadata=None, events=None, filter_list=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 = {'events': 'events', 'events_metadata': 'eventsMetadata', 'filter_list': 'filterList'}
attribute_types = {'events': 'list[Event]', 'events_metadata': 'EventsInputModelEventsMetadata', 'filter_list': 'list[str]'}
events

Gets the events of this EventSearchInputDataModel.

Returns:The events of this EventSearchInputDataModel.
Return type:list[Event]
events_metadata

Gets the events_metadata of this EventSearchInputDataModel.

Returns:The events_metadata of this EventSearchInputDataModel.
Return type:EventsInputModelEventsMetadata
filter_list

Gets the filter_list of this EventSearchInputDataModel. List of events which will be removed from the input list

Returns:The filter_list of this EventSearchInputDataModel.
Return type:list[str]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.events_input_model module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventsInputModel(events_metadata=None, events=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 = {'events': 'events', 'events_metadata': 'eventsMetadata'}
attribute_types = {'events': 'list[Event]', 'events_metadata': 'EventsInputModelEventsMetadata'}
events

Gets the events of this EventsInputModel.

Returns:The events of this EventsInputModel.
Return type:list[Event]
events_metadata

Gets the events_metadata of this EventsInputModel.

Returns:The events_metadata of this EventsInputModel.
Return type:EventsInputModelEventsMetadata
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.events_input_model_events_metadata module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class EventsInputModelEventsMetadata(event_text_property_name=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 = {'event_text_property_name': 'eventTextPropertyName'}
attribute_types = {'event_text_property_name': 'str'}
event_text_property_name

Gets the event_text_property_name of this EventsInputModelEventsMetadata. The property name of the events list objects that contains the text of the event

Returns:The event_text_property_name of this EventsInputModelEventsMetadata.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.filter_events_request module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class FilterEventsRequest(data=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 = {'data': 'data'}
attribute_types = {'data': 'EventSearchInputDataModel'}
data

Gets the data of this FilterEventsRequest.

Returns:The data of this FilterEventsRequest.
Return type:EventSearchInputDataModel
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.match_patterns_over_events_request module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class MatchPatternsOverEventsRequest(data=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 = {'data': 'data'}
attribute_types = {'data': 'PatternMatchingInputDataModel'}
data

Gets the data of this MatchPatternsOverEventsRequest.

Returns:The data of this MatchPatternsOverEventsRequest.
Return type:PatternMatchingInputDataModel
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.matching_pattern module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class MatchingPattern(event_text=None, min_repetitions=None, max_repetitions=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 = {'event_text': 'eventText', 'max_repetitions': 'maxRepetitions', 'min_repetitions': 'minRepetitions'}
attribute_types = {'event_text': 'str', 'max_repetitions': 'int', 'min_repetitions': 'int'}
event_text

Gets the event_text of this MatchingPattern. Event identifier.

Returns:The event_text of this MatchingPattern.
Return type:str
max_repetitions

Gets the max_repetitions of this MatchingPattern. The maximum number of desired repetitions of the event inside the pattern.

Returns:The max_repetitions of this MatchingPattern.
Return type:int
min_repetitions

Gets the min_repetitions of this MatchingPattern. The minimum number of desired repetitions of the event inside the pattern.

Returns:The min_repetitions of this MatchingPattern.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.pattern_definition module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class PatternDefinition(folder_id=None, file_id=None, pattern_id=None, pattern=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 = {'file_id': 'fileId', 'folder_id': 'folderId', 'pattern': 'pattern', 'pattern_id': 'patternId'}
attribute_types = {'file_id': 'str', 'folder_id': 'str', 'pattern': 'list[MatchingPattern]', 'pattern_id': 'str'}
file_id

Gets the file_id of this PatternDefinition. The id used to reference the file where the pattern is stored.

Returns:The file_id of this PatternDefinition.
Return type:str
folder_id

Gets the folder_id of this PatternDefinition. The id used to reference the folder where the file with the pattern is stored.

Returns:The folder_id of this PatternDefinition.
Return type:str
pattern

Gets the pattern of this PatternDefinition.

Returns:The pattern of this PatternDefinition.
Return type:list[MatchingPattern]
pattern_id

Gets the pattern_id of this PatternDefinition. The id used to reference a specific pattern. It is unique inside this collection.

Returns:The pattern_id of this PatternDefinition.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.pattern_found_by_matching module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class PatternFoundByMatching(pattern_index=None, time_window=None, pattern=None, matched_events=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 = {'matched_events': 'matchedEvents', 'pattern': 'pattern', 'pattern_index': 'patternIndex', 'time_window': 'timeWindow'}
attribute_types = {'matched_events': 'list[Event]', 'pattern': 'list[MatchingPattern]', 'pattern_index': 'int', 'time_window': 'object'}
matched_events

Gets the matched_events of this PatternFoundByMatching.

Returns:The matched_events of this PatternFoundByMatching.
Return type:list[Event]
pattern

Gets the pattern of this PatternFoundByMatching.

Returns:The pattern of this PatternFoundByMatching.
Return type:list[MatchingPattern]
pattern_index

Gets the pattern_index of this PatternFoundByMatching. The index of the pattern based on request object

Returns:The pattern_index of this PatternFoundByMatching.
Return type:int
time_window

Gets the time_window of this PatternFoundByMatching.

Returns:The time_window of this PatternFoundByMatching.
Return type:object
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.pattern_matching_input_data_model module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class PatternMatchingInputDataModel(max_pattern_interval=None, patterns_list=None, non_events=None, events_input=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 = {'events_input': 'eventsInput', 'max_pattern_interval': 'maxPatternInterval', 'non_events': 'nonEvents', 'patterns_list': 'patternsList'}
attribute_types = {'events_input': 'EventsInputModel', 'max_pattern_interval': 'int', 'non_events': 'list[str]', 'patterns_list': 'list[PatternDefinition]'}
events_input

Gets the events_input of this PatternMatchingInputDataModel.

Returns:The events_input of this PatternMatchingInputDataModel.
Return type:EventsInputModel
max_pattern_interval

Gets the max_pattern_interval of this PatternMatchingInputDataModel. The maximum time length (in milliseconds) of the sliding window where the pattern occurs

Returns:The max_pattern_interval of this PatternMatchingInputDataModel.
Return type:int
non_events

Gets the non_events of this PatternMatchingInputDataModel. List of events which will be removed from the input list

Returns:The non_events of this PatternMatchingInputDataModel.
Return type:list[str]
patterns_list

Gets the patterns_list of this PatternMatchingInputDataModel.

Returns:The patterns_list of this PatternMatchingInputDataModel.
Return type:list[PatternDefinition]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.pattern_matching_output module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class PatternMatchingOutput(output=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 = {'output': 'output'}
attribute_types = {'output': 'list[PatternFoundByMatching]'}
output

Gets the output of this PatternMatchingOutput.

Returns:The output of this PatternMatchingOutput.
Return type:list[PatternFoundByMatching]
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.remove_duplicate_events_request module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class RemoveDuplicateEventsRequest(data=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 = {'data': 'data'}
attribute_types = {'data': 'EventInput'}
data

Gets the data of this RemoveDuplicateEventsRequest.

Returns:The data of this RemoveDuplicateEventsRequest.
Return type:EventInput
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.time_window module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class TimeWindow(start_timestamp=None, end_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 = {'end_timestamp': 'endTimestamp', 'start_timestamp': 'startTimestamp'}
attribute_types = {'end_timestamp': 'str', 'start_timestamp': 'str'}
end_timestamp

Gets the end_timestamp of this TimeWindow. The end timestamp of the matched pattern.

Returns:The end_timestamp of this TimeWindow.
Return type:str
start_timestamp

Gets the start_timestamp of this TimeWindow. The start timestamp of the matched pattern.

Returns:The start_timestamp of this TimeWindow.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.top_event_output module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class TopEventOutput[source]

Bases: list

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.
append(object) → None -- append object to end
attribute_map = {}
attribute_types = {}
clear() → None -- remove all items from L
copy() → list -- a shallow copy of L
count(value) → integer -- return number of occurrences of value
extend(iterable) → None -- extend list by appending elements from the iterable
index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

insert()

L.insert(index, object) – insert object before index

pop([index]) → item -- remove and return item at index (default last).

Raises IndexError if list is empty or index is out of range.

remove(value) → None -- remove first occurrence of value.

Raises ValueError if the value is not present.

reverse()

L.reverse() – reverse IN PLACE

sort(key=None, reverse=False) → None -- stable sort *IN PLACE*
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.top_event_output_inner module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class TopEventOutputInner(appearances=None, text=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.
appearances

Gets the appearances of this TopEventOutputInner.

Returns:The appearances of this TopEventOutputInner.
Return type:int
attribute_map = {'appearances': 'appearances', 'text': 'text'}
attribute_types = {'appearances': 'int', 'text': 'str'}
text

Gets the text of this TopEventOutputInner.

Returns:The text of this TopEventOutputInner.
Return type:str
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.top_events_input_data_model module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class TopEventsInputDataModel(events_metadata=None, events=None, number_of_top_positions_required=10)[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 = {'events': 'events', 'events_metadata': 'eventsMetadata', 'number_of_top_positions_required': 'numberOfTopPositionsRequired'}
attribute_types = {'events': 'list[Event]', 'events_metadata': 'EventsInputModelEventsMetadata', 'number_of_top_positions_required': 'int'}
events

Gets the events of this TopEventsInputDataModel.

Returns:The events of this TopEventsInputDataModel.
Return type:list[Event]
events_metadata

Gets the events_metadata of this TopEventsInputDataModel.

Returns:The events_metadata of this TopEventsInputDataModel.
Return type:EventsInputModelEventsMetadata
number_of_top_positions_required

Gets the number_of_top_positions_required of this TopEventsInputDataModel. How many top positions will be returned in the response. Has to be a positive integer. If not specified, the default value 10 will be used.

Returns:The number_of_top_positions_required of this TopEventsInputDataModel.
Return type:int
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.top_events_request module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class TopEventsRequest(data=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 = {'data': 'data'}
attribute_types = {'data': 'TopEventsInputDataModel'}
data

Gets the data of this TopEventsRequest.

Returns:The data of this TopEventsRequest.
Return type:TopEventsInputDataModel
to_dict()[source]

Returns the model properties as a dict

to_str()[source]

Returns the string representation of the model

eventanalytics.models.vnd_error module

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501

class VndError(logref=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 = {'logref': 'logref', 'message': 'message'}
attribute_types = {'logref': 'str', 'message': 'str'}
logref

Gets the logref of this VndError.

Returns:The logref of this VndError.
Return type:str
message

Gets the message of this VndError.

Returns:The message of this VndError.
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

Event Analytics API

Provides the essential functionality for a data-driven analysis of the event data. # noqa: E501