SimulatorContext Class

Package:
microsoft.bonsai.simulatorapi.models
  • java.lang.Object
    • microsoft.bonsai.simulatorapi.models.SimulatorContext

public class SimulatorContext

This structure is passed (as a string) to a simulator running when launched by the Socrates backend.

Method Summary

Modifier and Type Method and Description
String collection()

Get the id of the collection.
String deploymentDetails()

Get where is this simulator deployed.
SimulatorContextTypesDeploymentMode deploymentMode()

Get possible values include: 'Unspecified', 'Hosted', 'Testing'.
String packageProperty()

Get the id of the package.
Purpose purpose()

Get the purpose value.
String simulatorClientId()

Get a simulator id generated by the client.
SimulatorContext withCollection(String collection)

Set the id of the collection.
SimulatorContext withDeploymentDetails(String deploymentDetails)

Set where is this simulator deployed.
SimulatorContext withDeploymentMode(SimulatorContextTypesDeploymentMode deploymentMode)

Set possible values include: 'Unspecified', 'Hosted', 'Testing'.
SimulatorContext withPackageProperty(String packageProperty)

Set the id of the package.
SimulatorContext withPurpose(Purpose purpose)

Set the purpose value.
SimulatorContext withSimulatorClientId(String simulatorClientId)

Set a simulator id generated by the client.

Method Details

collection

public String collection()

Get the id of the collection.

Returns:

the collection value

deploymentDetails

public String deploymentDetails()

Get where is this simulator deployed.

Returns:

the deploymentDetails value

deploymentMode

public SimulatorContextTypesDeploymentMode deploymentMode()

Get possible values include: 'Unspecified', 'Hosted', 'Testing'.

Returns:

the deploymentMode value

packageProperty

public String packageProperty()

Get the id of the package.

Returns:

the packageProperty value

purpose

public Purpose purpose()

Get the purpose value.

Returns:

the purpose value

simulatorClientId

public String simulatorClientId()

Get a simulator id generated by the client.

Returns:

the simulatorClientId value

withCollection

public SimulatorContext withCollection(String collection)

Set the id of the collection.

Parameters:

collection - the collection value to set

Returns:

the SimulatorContext object itself.

withDeploymentDetails

public SimulatorContext withDeploymentDetails(String deploymentDetails)

Set where is this simulator deployed.

Parameters:

deploymentDetails - the deploymentDetails value to set

Returns:

the SimulatorContext object itself.

withDeploymentMode

public SimulatorContext withDeploymentMode(SimulatorContextTypesDeploymentMode deploymentMode)

Set possible values include: 'Unspecified', 'Hosted', 'Testing'.

Parameters:

deploymentMode - the deploymentMode value to set

Returns:

the SimulatorContext object itself.

withPackageProperty

public SimulatorContext withPackageProperty(String packageProperty)

Set the id of the package.

Parameters:

packageProperty - the packageProperty value to set

Returns:

the SimulatorContext object itself.

withPurpose

public SimulatorContext withPurpose(Purpose purpose)

Set the purpose value.

Parameters:

purpose - the purpose value to set

Returns:

the SimulatorContext object itself.

withSimulatorClientId

public SimulatorContext withSimulatorClientId(String simulatorClientId)

Set a simulator id generated by the client.

Parameters:

simulatorClientId - the simulatorClientId value to set

Returns:

the SimulatorContext object itself.

Applies to