SessionsImpl Class

Package:
microsoft.bonsai.simulatorapi.implementation
  • java.lang.Object
    • Sessions
      • microsoft.bonsai.simulatorapi.implementation.SessionsImpl

public class SessionsImpl implements Sessions

An instance of this class provides access to all the operations defined in Sessions.

Constructor Summary

Constructor Description
SessionsImpl(Retrofit retrofit, SimulatorAPIImpl client)

Initializes an instance of Sessions.

Method Summary

Modifier and Type Method and Description
Event advance(String workspaceName, String sessionId, SimulatorState body)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.
Observable<Event> advanceAsync(String workspaceName, String sessionId, SimulatorState body)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.
ServiceFuture<Event> advanceAsync(String workspaceName, String sessionId, SimulatorState body, final ServiceCallback<Event> serviceCallback)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.
Observable<ServiceResponse<Event>> advanceWithServiceResponseAsync(String workspaceName, String sessionId, SimulatorState body)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.
SimulatorSessionResponse create(String workspaceName, SimulatorInterface body)

Registers a simulator with the Bonsai platform.
Observable<SimulatorSessionResponse> createAsync(String workspaceName, SimulatorInterface body)

Registers a simulator with the Bonsai platform.
ServiceFuture<SimulatorSessionResponse> createAsync(String workspaceName, SimulatorInterface body, final ServiceCallback<SimulatorSessionResponse> serviceCallback)

Registers a simulator with the Bonsai platform.
Observable<ServiceResponse<SimulatorSessionResponse>> createWithServiceResponseAsync(String workspaceName, SimulatorInterface body)

Registers a simulator with the Bonsai platform.
void delete(String workspaceName, String sessionId)

Deletes the Simulator session.
Observable<Void> deleteAsync(String workspaceName, String sessionId)

Deletes the Simulator session.
ServiceFuture<Void> deleteAsync(String workspaceName, String sessionId, final ServiceCallback<Void> serviceCallback)

Deletes the Simulator session.
Observable<ServiceResponse<Void>> deleteWithServiceResponseAsync(String workspaceName, String sessionId)

Deletes the Simulator session.
SimulatorSessionResponse get(String workspaceName, String sessionId)

Retrieves a simulator session corresponding to the sessionId.
Observable<SimulatorSessionResponse> getAsync(String workspaceName, String sessionId)

Retrieves a simulator session corresponding to the sessionId.
ServiceFuture<SimulatorSessionResponse> getAsync(String workspaceName, String sessionId, final ServiceCallback<SimulatorSessionResponse> serviceCallback)

Retrieves a simulator session corresponding to the sessionId.
Event getMostRecentAction(String workspaceName, String sessionId)

Gets the most recent action sent to the simulator to process.
Observable<Event> getMostRecentActionAsync(String workspaceName, String sessionId)

Gets the most recent action sent to the simulator to process.
ServiceFuture<Event> getMostRecentActionAsync(String workspaceName, String sessionId, final ServiceCallback<Event> serviceCallback)

Gets the most recent action sent to the simulator to process.
Observable<ServiceResponse<Event>> getMostRecentActionWithServiceResponseAsync(String workspaceName, String sessionId)

Gets the most recent action sent to the simulator to process.
Observable<ServiceResponse<SimulatorSessionResponse>> getWithServiceResponseAsync(String workspaceName, String sessionId)

Retrieves a simulator session corresponding to the sessionId.
List<SimulatorSessionSummary> list(String workspaceName)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
List<SimulatorSessionSummary> list(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
Observable<List<SimulatorSessionSummary>> listAsync(String workspaceName)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
ServiceFuture<List<SimulatorSessionSummary>> listAsync(String workspaceName, final ServiceCallback<List<SimulatorSessionSummary>> serviceCallback)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
Observable<List<SimulatorSessionSummary>> listAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
ServiceFuture<List<SimulatorSessionSummary>> listAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter, final ServiceCallback<List<SimulatorSessionSummary>> serviceCallback)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
Observable<ServiceResponse<List<SimulatorSessionSummary>>> listWithServiceResponseAsync(String workspaceName)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.
Observable<ServiceResponse<List<SimulatorSessionSummary>>> listWithServiceResponseAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Constructor Details

SessionsImpl

public SessionsImpl(Retrofit retrofit, SimulatorAPIImpl client)

Initializes an instance of Sessions.

Parameters:

retrofit - the Retrofit instance built from a Retrofit Builder.
client - the instance of the service client containing this operation class.

Method Details

advance

public Event advance(String workspaceName, String sessionId, SimulatorState body)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.

Overrides:

SessionsImpl.advance(String workspaceName, String sessionId, SimulatorState body)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identifier for the simulator.
body - The new state of the simulator.

Returns:

the Event object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

advanceAsync

public Observable advanceAsync(String workspaceName, String sessionId, SimulatorState body)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.

Overrides:

SessionsImpl.advanceAsync(String workspaceName, String sessionId, SimulatorState body)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identifier for the simulator.
body - The new state of the simulator.

Returns:

the observable to the Event object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

advanceAsync

public ServiceFuture advanceAsync(String workspaceName, String sessionId, SimulatorState body, final ServiceCallback serviceCallback)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.

Overrides:

SessionsImpl.advanceAsync(String workspaceName, String sessionId, SimulatorState body, final ServiceCallback<Event> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identifier for the simulator.
body - The new state of the simulator.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

advanceWithServiceResponseAsync

public Observable> advanceWithServiceResponseAsync(String workspaceName, String sessionId, SimulatorState body)

Advance the RL agent with the new state of the simulator, and returns an action computed by our policy. Simulatorsession is supposed to use the returned action for stepping inside the sim and thne getting the new state.false You can send the same state again, as long as you didn't get a Non-Idle Action back.

Overrides:

SessionsImpl.advanceWithServiceResponseAsync(String workspaceName, String sessionId, SimulatorState body)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identifier for the simulator.
body - The new state of the simulator.

Returns:

the observable to the Event object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

create

public SimulatorSessionResponse create(String workspaceName, SimulatorInterface body)

Registers a simulator with the Bonsai platform.

Overrides:

SessionsImpl.create(String workspaceName, SimulatorInterface body)

Parameters:

workspaceName - The workspace identifier.
body - Information and capabilities about the simulator.

Returns:

the SimulatorSessionResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

createAsync

public Observable createAsync(String workspaceName, SimulatorInterface body)

Registers a simulator with the Bonsai platform.

Overrides:

SessionsImpl.createAsync(String workspaceName, SimulatorInterface body)

Parameters:

workspaceName - The workspace identifier.
body - Information and capabilities about the simulator.

Returns:

the observable to the SimulatorSessionResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createAsync

public ServiceFuture createAsync(String workspaceName, SimulatorInterface body, final ServiceCallback serviceCallback)

Registers a simulator with the Bonsai platform.

Overrides:

SessionsImpl.createAsync(String workspaceName, SimulatorInterface body, final ServiceCallback<SimulatorSessionResponse> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
body - Information and capabilities about the simulator.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

createWithServiceResponseAsync

public Observable> createWithServiceResponseAsync(String workspaceName, SimulatorInterface body)

Registers a simulator with the Bonsai platform.

Overrides:

SessionsImpl.createWithServiceResponseAsync(String workspaceName, SimulatorInterface body)

Parameters:

workspaceName - The workspace identifier.
body - Information and capabilities about the simulator.

Returns:

the observable to the SimulatorSessionResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public void delete(String workspaceName, String sessionId)

Deletes the Simulator session.

Overrides:

SessionsImpl.delete(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - The session ID generated during registration

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(String workspaceName, String sessionId)

Deletes the Simulator session.

Overrides:

SessionsImpl.deleteAsync(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - The session ID generated during registration

Returns:

the ServiceResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String workspaceName, String sessionId, final ServiceCallback serviceCallback)

Deletes the Simulator session.

Overrides:

SessionsImpl.deleteAsync(String workspaceName, String sessionId, final ServiceCallback<Void> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
sessionId - The session ID generated during registration
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable> deleteWithServiceResponseAsync(String workspaceName, String sessionId)

Deletes the Simulator session.

Overrides:

SessionsImpl.deleteWithServiceResponseAsync(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - The session ID generated during registration

Returns:

the ServiceResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

public SimulatorSessionResponse get(String workspaceName, String sessionId)

Retrieves a simulator session corresponding to the sessionId.

Overrides:

SessionsImpl.get(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - The sessionId of the simulator session to fetch

Returns:

the SimulatorSessionResponse object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAsync

public Observable getAsync(String workspaceName, String sessionId)

Retrieves a simulator session corresponding to the sessionId.

Overrides:

SessionsImpl.getAsync(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - The sessionId of the simulator session to fetch

Returns:

the observable to the SimulatorSessionResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String workspaceName, String sessionId, final ServiceCallback serviceCallback)

Retrieves a simulator session corresponding to the sessionId.

Overrides:

SessionsImpl.getAsync(String workspaceName, String sessionId, final ServiceCallback<SimulatorSessionResponse> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
sessionId - The sessionId of the simulator session to fetch
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getMostRecentAction

public Event getMostRecentAction(String workspaceName, String sessionId)

Gets the most recent action sent to the simulator to process.

Overrides:

SessionsImpl.getMostRecentAction(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identification of the simulator.

Returns:

the Event object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getMostRecentActionAsync

public Observable getMostRecentActionAsync(String workspaceName, String sessionId)

Gets the most recent action sent to the simulator to process.

Overrides:

SessionsImpl.getMostRecentActionAsync(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identification of the simulator.

Returns:

the observable to the Event object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getMostRecentActionAsync

public ServiceFuture getMostRecentActionAsync(String workspaceName, String sessionId, final ServiceCallback serviceCallback)

Gets the most recent action sent to the simulator to process.

Overrides:

SessionsImpl.getMostRecentActionAsync(String workspaceName, String sessionId, final ServiceCallback<Event> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identification of the simulator.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getMostRecentActionWithServiceResponseAsync

public Observable> getMostRecentActionWithServiceResponseAsync(String workspaceName, String sessionId)

Gets the most recent action sent to the simulator to process.

Overrides:

SessionsImpl.getMostRecentActionWithServiceResponseAsync(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - Unique identification of the simulator.

Returns:

the observable to the Event object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String workspaceName, String sessionId)

Retrieves a simulator session corresponding to the sessionId.

Overrides:

SessionsImpl.getWithServiceResponseAsync(String workspaceName, String sessionId)

Parameters:

workspaceName - The workspace identifier.
sessionId - The sessionId of the simulator session to fetch

Returns:

the observable to the SimulatorSessionResponse object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public List list(String workspaceName)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.list(String workspaceName)

Parameters:

workspaceName - The workspace identifier.

Returns:

the List<SimulatorSessionSummary> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

list

public List list(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.list(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Parameters:

workspaceName - The workspace identifier.
deploymentMode - A specifier to filter on deployment mode
sessionStatus - A specifier to filter on session status
collection - If present, only sessions in this collection
packageParameter - If present, only sessions in this package

Returns:

the List<SimulatorSessionSummary> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation
ProblemDetailsException - thrown if the request is rejected by server
RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable> listAsync(String workspaceName)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.listAsync(String workspaceName)

Parameters:

workspaceName - The workspace identifier.

Returns:

the observable to the List<SimulatorSessionSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(String workspaceName, final ServiceCallback> serviceCallback)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.listAsync(String workspaceName, final ServiceCallback<List<SimulatorSessionSummary>> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public Observable> listAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.listAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Parameters:

workspaceName - The workspace identifier.
deploymentMode - A specifier to filter on deployment mode
sessionStatus - A specifier to filter on session status
collection - If present, only sessions in this collection
packageParameter - If present, only sessions in this package

Returns:

the observable to the List<SimulatorSessionSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter, final ServiceCallback> serviceCallback)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.listAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter, final ServiceCallback<List<SimulatorSessionSummary>> serviceCallback)

Parameters:

workspaceName - The workspace identifier.
deploymentMode - A specifier to filter on deployment mode
sessionStatus - A specifier to filter on session status
collection - If present, only sessions in this collection
packageParameter - If present, only sessions in this package
serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable>> listWithServiceResponseAsync(String workspaceName)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.listWithServiceResponseAsync(String workspaceName)

Parameters:

workspaceName - The workspace identifier.

Returns:

the observable to the List<SimulatorSessionSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable>> listWithServiceResponseAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Retrieves all of the simulators currently registered with all simulator gateways within this workspace. The deployment_mode appears in the query string. It can be one of Unspecified, Testing, or Hosted. If it has a 'neq:' prefix, that means "not;" e.g., {.../simulatorSessions?deployment_mode=neq:Hosted} means the response should not include simulators that are hosted. The session_status can be one of Attachable, Attached, Detaching, Rejected, and supports the neq: prefix. The collection appears in the query string The package appears in the query string The filter queries can appear together, like {.../simulatorSessions?deployment_mode=Hosted&collection=1234-455-33333}.

Overrides:

SessionsImpl.listWithServiceResponseAsync(String workspaceName, String deploymentMode, String sessionStatus, String collection, String packageParameter)

Parameters:

workspaceName - The workspace identifier.
deploymentMode - A specifier to filter on deployment mode
sessionStatus - A specifier to filter on session status
collection - If present, only sessions in this collection
packageParameter - If present, only sessions in this package

Returns:

the observable to the List<SimulatorSessionSummary> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Applies to