Exceptions

exception bosdyn.client.exceptions.Error[source]

Bases: Exception

Base exception that all public api exceptions are derived from.

exception bosdyn.client.exceptions.ResponseError(response, error_message=None)[source]

Bases: Error

Exception triggered by a server response whose rpc succeeded.

exception bosdyn.client.exceptions.InvalidRequestError(response, error_message=None)[source]

Bases: ResponseError

The provided request arguments are ill-formed or invalid, independent of the system state.

exception bosdyn.client.exceptions.LeaseUseError(response, lease_use_result)[source]

Bases: ResponseError

Request was rejected due to using an invalid lease.

exception bosdyn.client.exceptions.LicenseError(response, error_message=None)[source]

Bases: ResponseError

Request was rejected due to using an invalid license.

exception bosdyn.client.exceptions.ServerError(response, error_message=None)[source]

Bases: ResponseError

Service encountered an unrecoverable error.

exception bosdyn.client.exceptions.InternalServerError(response, error_message=None)[source]

Bases: ServerError

Service experienced an unexpected error state.

exception bosdyn.client.exceptions.UnsetStatusError(response, error_message=None)[source]

Bases: ServerError

Response’s status field (in either message or common header) was UNKNOWN value.

exception bosdyn.client.exceptions.RpcError(original_error, error_message=None)[source]

Bases: Error

An error occurred trying to reach a service on the robot.

exception bosdyn.client.exceptions.RetryableRpcError(original_error, error_message=None)[source]

Bases: RpcError

An RpcError that denotes the same request may succeed if retried.

exception bosdyn.client.exceptions.PersistentRpcError(original_error, error_message=None)[source]

Bases: RpcError

An RpcError that will almost certainly continue to keep failing if retried

exception bosdyn.client.exceptions.ClientCancelledOperationError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The user cancelled the rpc request.

exception bosdyn.client.exceptions.InvalidClientCertificateError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The provided client certificate is invalid.

exception bosdyn.client.exceptions.NonexistentAuthorityError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The app token’s authority field names a nonexistent service.

exception bosdyn.client.exceptions.PermissionDeniedError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The rpc request was denied access.

exception bosdyn.client.exceptions.ProxyConnectionError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The proxy on the robot could not be reached.

exception bosdyn.client.exceptions.ResponseTooLargeError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The rpc response was larger than allowed max size.

exception bosdyn.client.exceptions.ServiceUnavailableError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The proxy could not find the (possibly unregistered) service.

exception bosdyn.client.exceptions.TooManyRequestsError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The remote procedure call did not go through the proxy due to rate limiting.

exception bosdyn.client.exceptions.ServiceFailedDuringExecutionError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The service encountered an unexpected failure.

exception bosdyn.client.exceptions.TimedOutError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The remote procedure call did not terminate within the allotted time.

exception bosdyn.client.exceptions.UnableToConnectToRobotError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The robot may be offline or otherwise unreachable.

exception bosdyn.client.exceptions.RetryableUnavailableError(original_error, error_message=None)[source]

Bases: UnableToConnectToRobotError

Service unavailable or channel reset. Likely transient and can be resolved by retrying.

exception bosdyn.client.exceptions.UnauthenticatedError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The user needs to authenticate or does not have permission to access requested service.

exception bosdyn.client.exceptions.UnknownDnsNameError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The system is unable to translate the domain name.

exception bosdyn.client.exceptions.NotFoundError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The backend system could not be found.

exception bosdyn.client.exceptions.UnimplementedError(original_error, error_message=None)[source]

Bases: PersistentRpcError

The API does not recognize the request and is unable to complete the request.

exception bosdyn.client.exceptions.TransientFailureError(original_error, error_message=None)[source]

Bases: RetryableRpcError

The channel is in state TRANSIENT_FAILURE, often caused by a connection failure.

exception bosdyn.client.exceptions.TimeSyncRequired[source]

Bases: Error

Time synchronization is required but none seems to be established.

exception bosdyn.client.exceptions.CustomParamError(response, custom_param_error)[source]

Bases: ResponseError

A custom parameter that was provided did not match the specification