SandboxCommandFinishedEvent¶

class oci.generative_ai_sandbox.models.SandboxCommandFinishedEvent(**kwargs)¶

Bases: oci.generative_ai_sandbox.models.sandbox_command_event.SandboxCommandEvent

Event emitted when command execution finishes.

Attributes

`EVENT_FINISHED`	str(object=’’) -> str
`EVENT_STARTED`	str(object=’’) -> str
`EVENT_STDERR`	str(object=’’) -> str
`EVENT_STDOUT`	str(object=’’) -> str
`command_id`	[Required] Gets the command_id of this SandboxCommandEvent.
`data`	Gets the data of this SandboxCommandEvent.
`event`	[Required] Gets the event of this SandboxCommandEvent.
`exit_code`	Gets the exit_code of this SandboxCommandFinishedEvent.
`seq`	[Required] Gets the seq of this SandboxCommandEvent.
`timestamp`	[Required] Gets the timestamp of this SandboxCommandEvent.

Methods

`__init__`(**kwargs)	Initializes a new SandboxCommandFinishedEvent object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

EVENT_FINISHED = 'FINISHED'¶

EVENT_STARTED = 'STARTED'¶

EVENT_STDERR = 'STDERR'¶

EVENT_STDOUT = 'STDOUT'¶

__init__(**kwargs)¶

Initializes a new SandboxCommandFinishedEvent object with values from keyword arguments. The default value of the event attribute of this class is FINISHED and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

event (str) – The value to assign to the event property of this SandboxCommandFinishedEvent. Allowed values for this property are: “STARTED”, “STDOUT”, “STDERR”, “FINISHED”
seq (int) – The value to assign to the seq property of this SandboxCommandFinishedEvent.
timestamp (datetime) – The value to assign to the timestamp property of this SandboxCommandFinishedEvent.
command_id (str) – The value to assign to the command_id property of this SandboxCommandFinishedEvent.
data (str) – The value to assign to the data property of this SandboxCommandFinishedEvent.
exit_code (int) – The value to assign to the exit_code property of this SandboxCommandFinishedEvent.

command_id¶

[Required] Gets the command_id of this SandboxCommandEvent. Sandbox command identifier.

Returns:	The command_id of this SandboxCommandEvent.
Return type:	str

data¶

Gets the data of this SandboxCommandEvent. Event payload.

Returns:	The data of this SandboxCommandEvent.
Return type:	str

event¶

[Required] Gets the event of this SandboxCommandEvent. Command event type.

Allowed values for this property are: “STARTED”, “STDOUT”, “STDERR”, “FINISHED”

Returns:	The event of this SandboxCommandEvent.
Return type:	str

exit_code¶

Gets the exit_code of this SandboxCommandFinishedEvent. Process exit code when available.

Returns:	The exit_code of this SandboxCommandFinishedEvent.
Return type:	int

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

seq¶

[Required] Gets the seq of this SandboxCommandEvent. Monotonically increasing command event sequence number.

Returns:	The seq of this SandboxCommandEvent.
Return type:	int

timestamp¶

[Required] Gets the timestamp of this SandboxCommandEvent. The date and time the command event was emitted, in RFC 3339 format.

Returns:	The timestamp of this SandboxCommandEvent.
Return type:	datetime