docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License
Show / Hide Table of Contents
    • AddCollectorMenuAttribute
  • Unity.Simulation
    • AggregatedSample
    • AggregationEvent
    • ArrayCast
    • ArrayUtilities
    • AsyncRequest
    • AsyncRequest.ExecutionContext
    • AsyncRequest.Result
    • AsyncRequest.State
    • AsyncRequest<T>
    • BaseDataConsumer<T>
    • BaseDataConsumer<T>.Uploadable
    • Category
    • ChunkedStream
    • ChunkedUnityLog
    • CollectorBase
    • CollectorBase.ConsumeCollectorReport
    • CollectorElement
    • CollectorsBaseEditor
    • CollectorsList
    • Configuration
    • Configuration.SimulationConfiguration
    • ContentType
    • ContinuousEvents
    • ContinuousEvents.EventCollectionDelegate
    • ContinuousEvents.EventDispatchDelegate
    • CoreProfilerUtils
    • CounterEvent
    • CounterEventData
    • DXChunkedStream
    • DXChunkedUnityLog
    • DXFile
    • DXFormat
    • DXManager
    • DXTimeLogger
    • DataCapturePaths
    • DirectoryNameComponent
    • Dispatcher
    • EventBase
    • ExecUtility
    • ExitPlaymode
    • ExtensionNameComponent
    • FileNameComponent
    • FileProducer
    • Format
    • FrameCountCondition
    • FrameLimit
    • FrameNumberNameComponent
    • ICondition
    • IDataProduced
    • IGlobalProfilerDataDispatcher
    • IgnoreCollectorAttribute
    • LabelNameComponent
    • LambdaJob
    • LambdaJob.DelegateType
    • Log
    • Log.Level
    • Manager
    • Manager.NotificationDelegate
    • Manager.TickDelegate
    • NameComponent
    • NameGenerator
    • Options
    • PackageImportTests
    • PathUtility
    • PerfStatsManager
    • PlayerResolution
    • PlayerResolutionSettings
    • ProfilerManager
    • ProfilerProperties
    • ProfilerReport
    • ProfilerSamplingEvent
    • ReportingUtils
    • Sample
    • SampleProfilerCollector
    • SequenceNameComponent
    • SequencedPathName
    • SignedURLDataConsumer
    • SimSecondsCondition
    • SimulationProfiler
    • SimulationProfilerBase
    • SimulationProfilerEditor
    • TestUtility
    • ThreadUtility
    • TimeLimit
    • TimeLogger
    • TimeScale
    • TimeScaleEditor
    • TimeUtility
    • Timer
    • TimerSource
    • TimestampNameComponent
    • WallSecondsCondition

Struct Configuration.SimulationConfiguration

Inherited Members
ValueType.Equals(object)
ValueType.GetHashCode()
ValueType.ToString()
object.Equals(object, object)
object.GetType()
object.ReferenceEquals(object, object)
Namespace: Unity.Simulation
Assembly: Unity.Simulation.Core.dll
Syntax
[Serializable]
public struct Configuration.SimulationConfiguration

Fields

app_param_id

The app param id for this instance.

Declaration
public string app_param_id
Field Value
Type Description
string

app_param_uri

Local path of the app param json to read.

Declaration
public string app_param_uri
Field Value
Type Description
string

bearer_token

Bearer token to use for getting signed url uploads.

Declaration
public string bearer_token
Field Value
Type Description
string

chunk_size_bytes

The size in bytes for the buffer used to write out logs in chunks.

Declaration
public int chunk_size_bytes
Field Value
Type Description
int

chunk_timeout_ms

The timeout in seconds for flushing the log to disk in chunks.

Declaration
public int chunk_timeout_ms
Field Value
Type Description
int

current_attempt

The attempt number for this simulation. 0 - 2

Declaration
public int current_attempt
Field Value
Type Description
int

definition_id

The run definitio id for this run.

Declaration
public string definition_id
Field Value
Type Description
string

execution_id

The execution id for this run.

Declaration
public string execution_id
Field Value
Type Description
string

heartbeat_timeout_sec

The interval at which the heartbeat log is emitted.

Declaration
public float heartbeat_timeout_sec
Field Value
Type Description
float

instance_id

The instance number for this simulation. If you scheduled 10 instances, then 1 - 10

Declaration
public string instance_id
Field Value
Type Description
string

signlynx_host

The signed url endpoint to get signed urls for cloud agnostic uploads.

Declaration
public string signlynx_host
Field Value
Type Description
string

signlynx_port

The signed url port to use when getting signed urls for cloud agnostic uploads.

Declaration
public ushort signlynx_port
Field Value
Type Description
ushort

storage_uri_prefix

Deprecated. The storage URI when using GCS uploading.

Declaration
public string storage_uri_prefix
Field Value
Type Description
string

time_logging_timeout_sec

The logging interval in seconds for the time logger. Time logger will log simulation time, wall time and FPS at this interval.

Declaration
public float time_logging_timeout_sec
Field Value
Type Description
float

Properties

bucketName

Returns the cloud storage bucket name.

Declaration
public string bucketName { get; }
Property Value
Type Description
string

storagePath

Returns the full cloud storage path.

Declaration
public string storagePath { get; }
Property Value
Type Description
string

storagePathOther

Declaration
public string storagePathOther { get; }
Property Value
Type Description
string

Methods

GetConfig(string)

Returns the configuration for the current simulation in progress.

Declaration
public static Configuration.SimulationConfiguration GetConfig(string config)
Parameters
Type Name Description
string config

Simulation config file. (Provided by the USim agent).

Returns
Type Description
Configuration.SimulationConfiguration

Simulation Configuration for the current run.

In This Article
Back to top
Copyright © 2026 Unity Technologies — Trademarks and terms of use
  • Legal
  • Privacy Policy
  • Cookie Policy
  • Do Not Sell or Share My Personal Information