amazonka-robomaker-2.0: Amazon RoboMaker SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RobOMaker.Types.SimulationApplicationConfig

Description

 
Synopsis

Documentation

data SimulationApplicationConfig Source #

Information about a simulation application configuration.

See: newSimulationApplicationConfig smart constructor.

Constructors

SimulationApplicationConfig' 

Fields

  • applicationVersion :: Maybe Text

    The version of the simulation application.

  • tools :: Maybe [Tool]

    Information about tools configured for the simulation application.

  • uploadConfigurations :: Maybe [UploadConfiguration]

    Information about upload configurations for the simulation application.

  • useDefaultTools :: Maybe Bool

    A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

    This API is no longer supported and will throw an error if used.

  • useDefaultUploadConfigurations :: Maybe Bool

    A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

    If you set this value, you must specify an outputLocation.

    This API is no longer supported and will throw an error if used.

  • worldConfigs :: Maybe [WorldConfig]

    A list of world configurations.

  • application :: Text

    The application information for the simulation application.

  • launchConfig :: LaunchConfig

    The launch configuration for the simulation application.

Instances

Instances details
FromJSON SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

ToJSON SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

Generic SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

Associated Types

type Rep SimulationApplicationConfig :: Type -> Type #

Read SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

Show SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

NFData SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

Eq SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

Hashable SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

type Rep SimulationApplicationConfig Source # 
Instance details

Defined in Amazonka.RobOMaker.Types.SimulationApplicationConfig

type Rep SimulationApplicationConfig = D1 ('MetaData "SimulationApplicationConfig" "Amazonka.RobOMaker.Types.SimulationApplicationConfig" "amazonka-robomaker-2.0-7StvfiX8F7FIYnuj4Jp3Jq" 'False) (C1 ('MetaCons "SimulationApplicationConfig'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "applicationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tool]))) :*: (S1 ('MetaSel ('Just "uploadConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UploadConfiguration])) :*: S1 ('MetaSel ('Just "useDefaultTools") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "useDefaultUploadConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "worldConfigs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [WorldConfig]))) :*: (S1 ('MetaSel ('Just "application") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "launchConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 LaunchConfig)))))

newSimulationApplicationConfig Source #

Create a value of SimulationApplicationConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:applicationVersion:SimulationApplicationConfig', simulationApplicationConfig_applicationVersion - The version of the simulation application.

$sel:tools:SimulationApplicationConfig', simulationApplicationConfig_tools - Information about tools configured for the simulation application.

$sel:uploadConfigurations:SimulationApplicationConfig', simulationApplicationConfig_uploadConfigurations - Information about upload configurations for the simulation application.

$sel:useDefaultTools:SimulationApplicationConfig', simulationApplicationConfig_useDefaultTools - A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

$sel:useDefaultUploadConfigurations:SimulationApplicationConfig', simulationApplicationConfig_useDefaultUploadConfigurations - A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

$sel:worldConfigs:SimulationApplicationConfig', simulationApplicationConfig_worldConfigs - A list of world configurations.

$sel:application:SimulationApplicationConfig', simulationApplicationConfig_application - The application information for the simulation application.

$sel:launchConfig:SimulationApplicationConfig', simulationApplicationConfig_launchConfig - The launch configuration for the simulation application.

simulationApplicationConfig_tools :: Lens' SimulationApplicationConfig (Maybe [Tool]) Source #

Information about tools configured for the simulation application.

simulationApplicationConfig_uploadConfigurations :: Lens' SimulationApplicationConfig (Maybe [UploadConfiguration]) Source #

Information about upload configurations for the simulation application.

simulationApplicationConfig_useDefaultTools :: Lens' SimulationApplicationConfig (Maybe Bool) Source #

A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

simulationApplicationConfig_useDefaultUploadConfigurations :: Lens' SimulationApplicationConfig (Maybe Bool) Source #

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

simulationApplicationConfig_application :: Lens' SimulationApplicationConfig Text Source #

The application information for the simulation application.

simulationApplicationConfig_launchConfig :: Lens' SimulationApplicationConfig LaunchConfig Source #

The launch configuration for the simulation application.