SandboxCommandEvent¶
- class oci.generative_ai_sandbox.models.SandboxCommandEvent(**kwargs)¶
Bases:
objectBase command event emitted while a sandbox command runs.
Attributes:
A constant which can be used with the event property of a SandboxCommandEvent.
A constant which can be used with the event property of a SandboxCommandEvent.
A constant which can be used with the event property of a SandboxCommandEvent.
A constant which can be used with the event property of a SandboxCommandEvent.
[Required] Gets the command_id of this SandboxCommandEvent.
Gets the data of this SandboxCommandEvent.
[Required] Gets the event of this SandboxCommandEvent.
[Required] Gets the seq of this SandboxCommandEvent.
[Required] Gets the timestamp of this SandboxCommandEvent.
Methods:
__init__(**kwargs)Initializes a new SandboxCommandEvent 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'¶
A constant which can be used with the event property of a SandboxCommandEvent. This constant has a value of “FINISHED”
- EVENT_STARTED = 'STARTED'¶
A constant which can be used with the event property of a SandboxCommandEvent. This constant has a value of “STARTED”
- EVENT_STDERR = 'STDERR'¶
A constant which can be used with the event property of a SandboxCommandEvent. This constant has a value of “STDERR”
- EVENT_STDOUT = 'STDOUT'¶
A constant which can be used with the event property of a SandboxCommandEvent. This constant has a value of “STDOUT”
- __init__(**kwargs)¶
Initializes a new SandboxCommandEvent object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:
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 SandboxCommandEvent. Allowed values for this property are: “STARTED”, “STDOUT”, “STDERR”, “FINISHED”
seq (int) – The value to assign to the seq property of this SandboxCommandEvent.
timestamp (datetime) – The value to assign to the timestamp property of this SandboxCommandEvent.
command_id (str) – The value to assign to the command_id property of this SandboxCommandEvent.
data (str) – The value to assign to the data property of this SandboxCommandEvent.
- property command_id¶
[Required] Gets the command_id of this SandboxCommandEvent. Sandbox command identifier.
- Returns
The command_id of this SandboxCommandEvent.
- Return type
str
- property data¶
Gets the data of this SandboxCommandEvent. Event payload.
- Returns
The data of this SandboxCommandEvent.
- Return type
str
- property 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
- 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.
- property seq¶
[Required] Gets the seq of this SandboxCommandEvent. Monotonically increasing command event sequence number.
- Returns
The seq of this SandboxCommandEvent.
- Return type
int
- property 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