AnalysisJobRecording¶

class AnalysisJobRecording¶

Returned by

• AnalysisJobApi.CreateRecording

AddMappingName(mappingName)¶

Adds mapping name to this recording.

Note:

Only use in the context of a analysis package (*.ta)

Parameters:

mappingName : str¶

Mapping name to add

Clone()¶

Call this method if you want to use API-objects in multiple contexts, e.g. if you want to insert a specific test step in multiple blocks.

Returns:

A copy of this object

Return type:

AnalysisJobRecording

GetDescription()¶

Returns description of recording (corresponds to recording group description in trace analysis)

Returns:

Description of this recording

Return type:

str

GetMappingNames()¶

Returns all mapping names of this recording.

Note:

Only use in the context of a analysis package (*.ta)

Returns:

Mapping names

Return type:

list[str]

GetName()¶

Returns name of recording (corresponds to recording group name in trace analysis)

Returns:

Name of this recording

Return type:

str

GetRecordingInfo()¶

Returns recording info object of the recording

Returns:

Recording info object of the recording

Return type:

RecordingInfo

RemoveMappingName(mappingName)¶

Removes mapping name from this recording.

Note:

Only use in the context of a analysis package (*.ta)

Parameters:

mappingName : str¶

Mapping name to remove

SetDescription(value)¶

Sets description of recording.

Parameters:

value : str¶

New description

SetMappingNames(mappingNames)¶

Sets mapping names of this recording.

Note:

Only use in the context of a analysis package (*.ta)

Parameters:

mappingNames : list[str]¶

New mapping names

SetRecordingInfo(value)¶

Sets recording info object of the recording

Parameters:

value¶

New recording info object