SystemStatusRequest

class borneo.SystemStatusRequest[source]

Bases: borneo.operations.Request

On-premise only.

SystemStatusRequest is an on-premise-only request used to check the status of an operation started using a SystemRequest.

Methods Summary

get_operation_id() Returns the operation id to use for the request, None if not set.
get_statement() Returns the statement set by set_statement(), or None if not set.
get_timeout() Returns the timeout to use for the operation, in milliseconds.
set_operation_id(operation_id) Sets the operation id to use for the request.
set_statement(statement) Sets the statement that was used for the operation.
set_timeout(timeout_ms) Sets the request timeout value, in milliseconds.

Methods Documentation

get_operation_id()[source]

Returns the operation id to use for the request, None if not set.

Returns:the operation id.
Return type:str
get_statement()[source]

Returns the statement set by set_statement(), or None if not set.

Returns:the statement.
Return type:str
get_timeout()[source]

Returns the timeout to use for the operation, in milliseconds. A value of 0 indicates that the timeout has not been set.

Returns:the timeout value.
Return type:int
set_operation_id(operation_id)[source]

Sets the operation id to use for the request. The operation id can be obtained via SystemResult.get_operation_id(). This parameter is not optional and represents an asynchronous operation that may be in progress. It is used to examine the result of the operation and if the operation has failed an exception will be thrown in response to a NoSQLHandle.system_status() operation. If the operation is in progress or has completed successfully, the state of the operation is returned.

Parameters:operation_id (str) – the operation id.
Returns:self.
Raises:IllegalArgumentException – raises the exception if operation_id is a negative number.
set_statement(statement)[source]

Sets the statement that was used for the operation. This is optional and is not used in any significant way. It is returned, unmodified, in the SystemResult for convenience.

Parameters:statement (str) – the statement. This is a optional parameter.
Returns:self.
Raises:IllegalArgumentException – raises the exception if statement is not a string.
set_timeout(timeout_ms)[source]

Sets the request timeout value, in milliseconds. This overrides any default value set in NoSQLHandleConfig. The value must be positive.

Parameters:timeout_ms (int) – the timeout value, in milliseconds.
Returns:self.
Raises:IllegalArgumentException – raises the exception if the timeout value is less than or equal to 0.