SoftwareSession

Definition of a compute session, including its software and compute resource requirements and status.

@id: stencila:SoftwareSession

Parent: Thing

Properties

Name @id Type Description Inherited from
type (required) schema:type enum{SoftwareSession} The name of the type. Entity
alternateNames schema:alternateName array[string] Alternate names (aliases) for the item. Thing
clientsLimit stencila:clientsLimit number The maximum number of concurrent clients the session is limited to. SoftwareSession
clientsRequest stencila:clientsRequest number The maximum number of concurrent clients requested for the session. SoftwareSession
cpuLimit stencila:cpuLimit number The amount of CPU the session is limited to. SoftwareSession
cpuRequest stencila:cpuRequest number The amount of CPU requested for the session. SoftwareSession
dateEnd schema:endDate Date | string:date | string:date-time The date-time that the session ended. SoftwareSession
dateStart schema:startDate Date | string:date | string:date-time The date-time that the session began. SoftwareSession
description schema:description array[BlockContent] | array[InlineContent] | string A description of the item. Thing
durationLimit stencila:durationLimit number The maximum duration (seconds) the session is limited to. SoftwareSession
durationRequest stencila:durationRequest number The maximum duration (seconds) requested for the session. SoftwareSession
environment stencila:environment SoftwareEnvironment The software environment to execute this session in. SoftwareSession
id schema:id string The identifier for this item. Entity
identifiers schema:identifier array[PropertyValue | string] Any kind of identifier for any kind of Thing. Thing
images schema:image array[ImageObject | string:uri] Images of the item. Thing
memoryLimit stencila:memoryLimit number The amount of memory that the session is limited to. SoftwareSession
memoryRequest stencila:memoryRequest number The amount of memory requested for the session. SoftwareSession
meta stencila:meta object Metadata associated with this item. Entity
name schema:name string The name of the item. Thing
networkTransferLimit stencila:networkTransferLimit number The amount of network data transfer (GiB) that the session is limited to. SoftwareSession
networkTransferRequest stencila:networkTransferRequest number The amount of network data transfer (GiB) requested for the session. SoftwareSession
status stencila:sessionStatus enum{unknown, starting, started, stopping, stopped, failed} The status of the session (starting, stopped, etc). SoftwareSession
timeoutLimit stencila:timeoutLimit number The inactivity timeout (seconds) the session is limited to. SoftwareSession
timeoutRequest stencila:timeoutRequest number The inactivity timeout (seconds) requested for the session. SoftwareSession
url schema:url string:uri The URL of the item. Thing
volumeMounts stencila:volumeMounts array[VolumeMount] Volumes to mount in the session. SoftwareSession

Note: This documentation was autogenerated from SoftwareSession.schema.yaml. Please help improve these docs (and show how we humans 💁 can do better than bots 🤖!) by creating a Markdown documentation file🙏