SandboxCommandStartedEvent

class oci.generative_ai_sandbox.models.SandboxCommandStartedEvent(**kwargs)

Bases: SandboxCommandEvent

Event emitted when command execution starts.

Attributes:

EVENT_FINISHED

A constant which can be used with the event property of a SandboxCommandEvent.

EVENT_STARTED

A constant which can be used with the event property of a SandboxCommandEvent.

EVENT_STDERR

A constant which can be used with the event property of a SandboxCommandEvent.

EVENT_STDOUT

A constant which can be used with the event property of a SandboxCommandEvent.

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.

seq

[Required] Gets the seq of this SandboxCommandEvent.

timestamp

[Required] Gets the timestamp of this SandboxCommandEvent.

Methods:

__init__(**kwargs)

Initializes a new SandboxCommandStartedEvent 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 SandboxCommandStartedEvent object with values from keyword arguments. The default value of the event attribute of this class is STARTED 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 SandboxCommandStartedEvent. Allowed values for this property are: “STARTED”, “STDOUT”, “STDERR”, “FINISHED”

  • seq (int) – The value to assign to the seq property of this SandboxCommandStartedEvent.

  • timestamp (datetime) – The value to assign to the timestamp property of this SandboxCommandStartedEvent.

  • command_id (str) – The value to assign to the command_id property of this SandboxCommandStartedEvent.

  • data (str) – The value to assign to the data property of this SandboxCommandStartedEvent.

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