Configuration for Unreal Build Accelerator Horde session. More...

Inheritance diagram for Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig:

Public Member Functions
virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHorde (object val=null)
	Uri of the Horde server.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeToken (object val=null)
	Uri of the Horde server Auth token for the Horde server.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeOidc (object val=null)
	OIDC id for the login to use.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordePool (object val=null)
	Pool for the Horde agent to assign, only used for commandline override.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeRequirements (object val=null)
	Requirements for the Horde agent to assign.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeHost (object val=null)
	Which ip UBA server should give to agents. This will invert so host listens and agents connect.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeMaxCores (double? val=null)
	Max cores allowed to be used by build session.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeDelay (double? val=null)
	How long UBT should wait to ask for help. Useful in build configs where machine can delay remote work and still get same wall time results (pch dependencies etc)

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeAllowWine (bool present=true)
	Allow use of Wine. Only applicable to Horde agents running Linux. Can still be ignored if Wine executable is not set on agent.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeConnectionMode (object val=null)
	Connection mode for agent/compute communication ConnectionMode for valid modes.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeEncryption (object val=null)
	Encryption to use for agent/compute communication. Note that UBA agent uses its own encryption. Encryption for valid modes.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBASentryUrl (object val=null)
	Sentry URL to send box data to. Optional.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBADisableHorde (bool? val=null)
	Disable horde all together.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeCluster (object val=null)
	Compute cluster ID to use in Horde. Set to "_auto" to let Horde server resolve a suitable cluster. In multi-region setups this is can simplify configuration of UBT/UBA a lot.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeMaxWorkers (double? val=null)
	Max workers allowed to be used by build session.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeMaxIdle (double? val=null)
	Max idle time in seconds to maintain a connection to a worker when no pending actions are currently available due to waiting on dependencies.

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeCacheEnabled (bool? val=null)
	Enabled parameter for use by INI config, expects one of [True, False, BuildMachineOnly].

virtual UnrealBuildAcceleratorHordeConfigConfig	UBAHordeCacheDesiredConnectionCount (double? val=null)
	Number of desired connections when connecting to cache.

Public Member Functions inherited from Nuke.Unreal.Tools.ToolConfig
virtual void	AppendArgument (UnrealToolArgument arg)

virtual void	AppendArgument (string arg, UnrealToolArgumentMeta? meta=null)

virtual void	AppendSubtool (ToolConfig subtool)

virtual string	Gather (EngineVersion ueVersion)
	Gether the arguments and subtools and render a command line output.

Properties
override string	Name `[get]`

override string	CliName `[get]`

override UnrealCompatibility	Compatibility `[get]`

override ToolConfig[]	Configs `[get]`

Properties inherited from Nuke.Unreal.Tools.ToolConfig
string	Name `[get]`
	The C# friendly name of the tool which will be used inside configurators.

string	CliName `[get]`
	The name which will be rendered onto command line.

UnrealCompatibility	Compatibility `[get]`
	Compatibility with either Unreal Engine 4 or 5 or both. If tool is configured to run with an incompatible engine its entire configuration will be ignored.

virtual ToolConfig[]	Configs `[get]`

Private Attributes
ToolConfig[]	_configs = null

Additional Inherited Members
Protected Attributes inherited from Nuke.Unreal.Tools.ToolConfig
List< UnrealToolArgument >	UsingArguments = []

readonly Dictionary< string, ToolConfig >	UsingSubtools = []

Detailed Description

Configuration for Unreal Build Accelerator Horde session.

Definition at line 20258 of file UbtConfigGenerated.cs.

Member Function Documentation

◆ UBADisableHorde()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBADisableHorde ( bool? val = null )

virtual

Disable horde all together.

Definition at line 20520 of file UbtConfigGenerated.cs.

◆ UBAHorde()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHorde ( object val = null )

virtual

Uri of the Horde server.

Definition at line 20267 of file UbtConfigGenerated.cs.

◆ UBAHordeAllowWine()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeAllowWine ( bool present = true )

virtual

Allow use of Wine. Only applicable to Horde agents running Linux. Can still be ignored if Wine executable is not set on agent.

Definition at line 20434 of file UbtConfigGenerated.cs.

◆ UBAHordeCacheDesiredConnectionCount()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeCacheDesiredConnectionCount ( double? val = null )

virtual

Number of desired connections when connecting to cache.

Definition at line 20626 of file UbtConfigGenerated.cs.

◆ UBAHordeCacheEnabled()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeCacheEnabled ( bool? val = null )

virtual

Enabled parameter for use by INI config, expects one of [True, False, BuildMachineOnly].

Definition at line 20605 of file UbtConfigGenerated.cs.

◆ UBAHordeCluster()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeCluster ( object val = null )

virtual

Compute cluster ID to use in Horde. Set to "_auto" to let Horde server resolve a suitable cluster. In multi-region setups this is can simplify configuration of UBT/UBA a lot.

Definition at line 20542 of file UbtConfigGenerated.cs.

◆ UBAHordeConnectionMode()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeConnectionMode ( object val = null )

virtual

Connection mode for agent/compute communication ConnectionMode for valid modes.

Definition at line 20456 of file UbtConfigGenerated.cs.

◆ UBAHordeDelay()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeDelay ( double? val = null )

virtual

How long UBT should wait to ask for help. Useful in build configs where machine can delay remote work and still get same wall time results (pch dependencies etc)

Definition at line 20413 of file UbtConfigGenerated.cs.

◆ UBAHordeEncryption()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeEncryption ( object val = null )

virtual

Encryption to use for agent/compute communication. Note that UBA agent uses its own encryption. Encryption for valid modes.

Definition at line 20478 of file UbtConfigGenerated.cs.

◆ UBAHordeHost()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeHost ( object val = null )

virtual

Which ip UBA server should give to agents. This will invert so host listens and agents connect.

Definition at line 20371 of file UbtConfigGenerated.cs.

◆ UBAHordeMaxCores()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeMaxCores ( double? val = null )

virtual

Max cores allowed to be used by build session.

Definition at line 20392 of file UbtConfigGenerated.cs.

◆ UBAHordeMaxIdle()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeMaxIdle ( double? val = null )

virtual

Max idle time in seconds to maintain a connection to a worker when no pending actions are currently available due to waiting on dependencies.

Definition at line 20584 of file UbtConfigGenerated.cs.

◆ UBAHordeMaxWorkers()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeMaxWorkers ( double? val = null )

virtual

Max workers allowed to be used by build session.

Definition at line 20563 of file UbtConfigGenerated.cs.

◆ UBAHordeOidc()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeOidc ( object val = null )

virtual

OIDC id for the login to use.

Definition at line 20308 of file UbtConfigGenerated.cs.

◆ UBAHordePool()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordePool ( object val = null )

virtual

Pool for the Horde agent to assign, only used for commandline override.

Definition at line 20329 of file UbtConfigGenerated.cs.

◆ UBAHordeRequirements()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeRequirements ( object val = null )

virtual

Requirements for the Horde agent to assign.

Definition at line 20350 of file UbtConfigGenerated.cs.

◆ UBAHordeToken()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBAHordeToken ( object val = null )

virtual

Uri of the Horde server Auth token for the Horde server.

Definition at line 20287 of file UbtConfigGenerated.cs.

◆ UBASentryUrl()

virtual UnrealBuildAcceleratorHordeConfigConfig Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.UBASentryUrl ( object val = null )

virtual

Sentry URL to send box data to. Optional.

Definition at line 20499 of file UbtConfigGenerated.cs.

Member Data Documentation

◆ _configs

ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig._configs = null

private

Definition at line 20644 of file UbtConfigGenerated.cs.

Property Documentation

◆ CliName

override string Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.CliName

get

Definition at line 20261 of file UbtConfigGenerated.cs.

◆ Compatibility

override UnrealCompatibility Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.Compatibility

get

Definition at line 20262 of file UbtConfigGenerated.cs.

◆ Configs

override ToolConfig [] Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.Configs

getprotected

Definition at line 20645 of file UbtConfigGenerated.cs.

◆ Name

override string Nuke.Unreal.Tools.UbtConfigGenerated.UnrealBuildAcceleratorHordeConfigConfig.Name

get

Definition at line 20260 of file UbtConfigGenerated.cs.

The documentation for this class was generated from the following file:

/home/runner/work/Nuke.Unreal/Nuke.Unreal/src/Nuke.Unreal/Tools/UbtConfigGenerated.cs

Public Member Functions

Properties

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ UBADisableHorde()

◆ UBAHorde()

◆ UBAHordeAllowWine()

◆ UBAHordeCacheDesiredConnectionCount()

◆ UBAHordeCacheEnabled()

◆ UBAHordeCluster()

◆ UBAHordeConnectionMode()

◆ UBAHordeDelay()

◆ UBAHordeEncryption()

◆ UBAHordeHost()

◆ UBAHordeMaxCores()

◆ UBAHordeMaxIdle()

◆ UBAHordeMaxWorkers()

◆ UBAHordeOidc()

◆ UBAHordePool()

◆ UBAHordeRequirements()

◆ UBAHordeToken()

◆ UBASentryUrl()

Member Data Documentation

◆ _configs

Property Documentation

◆ CliName

◆ Compatibility

◆ Configs

◆ Name