SimulatedActionInfo

java.lang.Object
- com.soasta.scripting.v1.SimulatedActionInfo

```
public class SimulatedActionInfo
extends java.lang.Object
```
Contains information about a simulated Action that is being recorded into the Result via the recordActionCompletion method of the Result object.
Note that an instance of this class cannot be constructed directly via "new". Instead, the createSimulatedActionInfo factory method must be used.
See the ScriptEnvironment interface for general background information about this API.

Field Summary

Fields
Modifier and Type	Field and Description
`long`	`bytesReceived` The number of bytes received for this action.
`long`	`bytesSent` The number of bytes sent for this action.
`java.lang.String`	`completionType` The completion type for this action.
`long`	`connectionEstablishTime` The amount of time, in milliseconds, spent establishing a connection for this action.
`long`	`deltaFromScheduledStart` The difference, in milliseconds, between the time this action was "scheduled" to be started and when it was actually started.
`long`	`dnsLookupDuration` The amount of time, in milliseconds, spent performing DNS lookup for this action.
`long`	`duration` The length of time, in milliseconds, spent actually communicating to perform this action, in milliseconds.
`java.lang.String`	`failureText` If the action is to be considered as having failed, this is the error text for the failure.
`java.lang.String`	`name` The name to be assigned to the action.
`java.lang.String`	`operation` The "operation" for this action.
`java.lang.String`	`parentPath` `parentPathType` and `parentPath` specify the "starting point" of the path, and the path itself, respectively, to the containing item into which this action is to be recorded.
`java.lang.String`	`parentPathType` See `parentPath`.
`long`	`receiveTime` The amount of time, in milliseconds, spent receiving for this action.
`int`	`repeatIndex` An optional repeat index if the simulated action is to be considered to be repeating.
`long`	`sendTime` The amount of time, in milliseconds, spent sending for this action.
`long`	`startTime` The time at which the the action started, in milliseconds since epoch.
`java.lang.String`	`textReceived` The text of the response that was received for this action, to be reported in the Result.
`java.lang.String`	`textSent` The text that was sent for this action, to be reported in the Result.
`long`	`totalPortRetryCount` The number of retries required to obtain a port from the OS in order to perform this action.
`long`	`totalPortRetryTime` The amount of time, in milliseconds, spent retrying to obtain a port from the OS in order to perform this action.
`long`	`totalTime` The total amount of time, in milliseconds, spent for this action, including communication time and other overhead processing time.
`long`	`ttfb` Time to first byte, in milliseconds.
`long`	`ttlb` Time to last byte, in milliseconds.
`java.lang.String`	`url` The "URL" for this action.
`boolean`	`validationPassed` True if the action's "validation" is to be considered to have passed for Result reporting purposes.
`long`	`waitForConnectionPoolTime` The amount of time, in milliseconds, spent waiting on a Connection Pool for this action.

Constructor Summary

Constructors
Constructor and Description

SimulatedActionInfo()

Constructors
Constructor and Description
`SimulatedActionInfo()`

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - parentPathType
```
public java.lang.String parentPathType
```
    See parentPath.
  - parentPath
```
public java.lang.String parentPath
```
    parentPathType and parentPath specify the "starting point" of the path, and the path itself, respectively, to the containing item into which this action is to be recorded. These are relative to the context in which the current Script is playing, as specified for property paths within "In Situ Substitution Specifications" (ISSEs).
    Refer to the separate documentation on ISSEs on CloudLink for more information about pathing.
    The parent item specified must be a Clip or a container within a Clip, and must be an item that is currently playing (has started but has not yet completed). Typically this might be either some parent of the current Script, or else a simulated Transaction that was started earlier by calling the Result.recordTransactionStart() method.
    If these members are null, the parent of the Script object that called this Java code will be used as the parent.
  - name
```
public java.lang.String name
```
    The name to be assigned to the action. Corresponds to the name of a Message if this had been a standard Message. This name cannnot be the same as the name of any other object in the parent container.
  - repeatIndex
```
public int repeatIndex
```
    An optional repeat index if the simulated action is to be considered to be repeating. Negative means no repeat. The index cannot be the same as any other index given with the same name previously. Gaps within the indexes are permitted.
  - operation
```
public java.lang.String operation
```
    The "operation" for this action. This can be any string desired, it is merely reported in the Result, in the same way that "GET", "POST", etc. are reported for an HTTP Message.
  - url
```
public java.lang.String url
```
    The "URL" for this action. This can be any string desired, it is merely reported in the Result.
    Although this URL is not used to perform any actual processing, it will still be parsed during Result processing and therefore if given it should be a correctly-formatted URL.
    The URL is used in the "URL Analysis" and "Error Analysis" widgets, as well as some charts that are shown by domain. At this time, no Results displays use the query string portion of the URL, but other parts of the URL, such as the protocol and domain are used.
  - failureText
```
public java.lang.String failureText
```
    If the action is to be considered as having failed, this is the error text for the failure. This text is used only if the "completionType" is "Fail"
  - validationPassed
```
public boolean validationPassed
```
    True if the action's "validation" is to be considered to have passed for Result reporting purposes.
  - textSent
```
public java.lang.String textSent
```
    The text that was sent for this action, to be reported in the Result.
  - textReceived
```
public java.lang.String textReceived
```
    The text of the response that was received for this action, to be reported in the Result.
  - completionType
```
public java.lang.String completionType
```
    The completion type for this action. Must be "Success", "Fail", or "Stop".
  - duration
```
public long duration
```
    The length of time, in milliseconds, spent actually communicating to perform this action, in milliseconds.
  - deltaFromScheduledStart
```
public long deltaFromScheduledStart
```
    The difference, in milliseconds, between the time this action was "scheduled" to be started and when it was actually started. Usually only meant to be used for Timed Clips.
  - bytesSent
```
public long bytesSent
```
    The number of bytes sent for this action.
  - bytesReceived
```
public long bytesReceived
```
    The number of bytes received for this action.
  - totalPortRetryCount
```
public long totalPortRetryCount
```
    The number of retries required to obtain a port from the OS in order to perform this action.
  - totalPortRetryTime
```
public long totalPortRetryTime
```
    The amount of time, in milliseconds, spent retrying to obtain a port from the OS in order to perform this action.
  - connectionEstablishTime
```
public long connectionEstablishTime
```
    The amount of time, in milliseconds, spent establishing a connection for this action.
  - sendTime
```
public long sendTime
```
    The amount of time, in milliseconds, spent sending for this action.
  - receiveTime
```
public long receiveTime
```
    The amount of time, in milliseconds, spent receiving for this action.
  - totalTime
```
public long totalTime
```
    The total amount of time, in milliseconds, spent for this action, including communication time and other overhead processing time.
  - ttfb
```
public long ttfb
```
    Time to first byte, in milliseconds.
  - ttlb
```
public long ttlb
```
    Time to last byte, in milliseconds.
  - dnsLookupDuration
```
public long dnsLookupDuration
```
    The amount of time, in milliseconds, spent performing DNS lookup for this action.
  - waitForConnectionPoolTime
```
public long waitForConnectionPoolTime
```
    The amount of time, in milliseconds, spent waiting on a Connection Pool for this action.
  - startTime
```
public long startTime
```
    The time at which the the action started, in milliseconds since epoch. Time zone must match CloudTest server time.
- Constructor Detail
  - SimulatedActionInfo
```
public SimulatedActionInfo()
```

Class SimulatedActionInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

parentPathType

parentPath

name

repeatIndex

operation

url

failureText

validationPassed

textSent

textReceived

completionType

duration

deltaFromScheduledStart

bytesSent

bytesReceived

totalPortRetryCount

totalPortRetryTime

connectionEstablishTime

sendTime

receiveTime

totalTime

ttfb

ttlb

dnsLookupDuration

waitForConnectionPoolTime

startTime

Constructor Detail

SimulatedActionInfo