BatchGetSessionActionItem

The details of a session action returned in a batch get operation.

definition

The session action definition.

Type: SessionActionDefinition object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

farmId

The farm ID of the session action.

Type: String

Pattern: farm-[0-9a-f]{32}

Required: Yes

jobId

The job ID of the session action.

Type: String

Pattern: job-[0-9a-f]{32}

Required: Yes

queueId

The queue ID of the session action.

Type: String

Pattern: queue-[0-9a-f]{32}

Required: Yes

sessionActionId

The session action ID.

Type: String

Pattern: sessionaction-[0-9a-f]{32}-(0|([1-9][0-9]{0,9}))

Required: Yes

sessionId

The session ID for the session action.

Type: String

Pattern: session-[0-9a-f]{32}

Required: Yes

status

The status of the session action.

Type: String

Required: Yes

acquiredLimits

The limits that were acquired for the session action.

Type: Array of AcquiredLimit objects

Required: No

endedAt

The date and time the resource ended running.

Type: Timestamp

Required: No

manifests

The manifests for the session action.

Type: Array of TaskRunManifestPropertiesResponse objects

Required: No

processExitCode

The exit code to apply to the session action.

Type: Integer

Valid Range: Minimum value of -2147483648. Maximum value of 2147483647.

Required: No

progressMessage

The message that communicates the progress of the session action.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 4096.

Required: No

progressPercent

The completion percentage for the session action.

Type: Float

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

startedAt

The date and time the resource started running.

Type: Timestamp

Required: No

workerUpdatedAt

The date and time the resource was updated by a worker.

Type: Timestamp

Required: No

BatchGetSessionActionItem

Contents

See Also