Message validation¶
Validators for gRPC messages
Requests¶
- momotor.rpc.validate.request.validate_authenticate_request(message, *, expect_oneof)¶
Validate
AuthenticateRequestmessage- Parameters
message (
AuthenticateRequest) – The message to validateexpect_oneof (
str) – Expected request field (apiKeyorchallengeResponse)
- Raises
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_create_job_request(message)¶
Validate
CreateJobRequestmessage- Parameters
message (
CreateJobRequest) – The message to validate- Raises
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_download_asset_request(message, *, expect_oneof)¶
Validate
DownloadAssetRequestmessage- Parameters
message (
DownloadAssetRequest) – The message to validateexpect_oneof (
str) – Expected request field (queryoraccepted)
- Raises
FormatException – When the message is invalid
AssetException – When the query is invalid
- momotor.rpc.validate.request.validate_end_job_request(message)¶
Validate
EndJobRequestmessage- Parameters
message (
EndJobRequest) – The message to validate- Raises
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_job_status_request(message)¶
Validate
JobStatusRequestmessage- Parameters
message (
JobStatusRequest) – The message to validate- Raises
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_start_job_request(message)¶
Validate
StartJobRequestmessage- Parameters
message (
StartJobRequest) – The message to validate- Raises
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_upload_asset_request(message, *, expect_oneof)¶
Validate
UploadAssetRequestmessage- Parameters
message (
UploadAssetRequest) – The message to validateexpect_oneof (
str) – Expected request field (assetDataorchunk)
- Raises
FormatException – When the message is invalid
AssetException – When the query is invalid
- momotor.rpc.validate.request.validate_get_task_request(message)¶
Validate
GetTaskRequestmessage- Parameters
message (
GetTaskRequest) – The message to validate- Raises
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_update_status_request(message)¶
Validate
UpdateTaskStatusRequestmessage- Parameters
message (
UpdateTaskStatusRequest) – The message to validate- Raises
FormatException – When the message is invalid
Validate
SharedLockRequestmessage- Parameters
message (
SharedLockRequest) – The message to validate- Raises
FormatException – When the message is invalid
Responses¶
- momotor.rpc.validate.response.validate_authenticate_response(message, *, expect_oneof)¶
Validate
AuthenticateResponsemessage- Parameters
message (
AuthenticateResponse) – The message to validateexpect_oneof (
str) – Expected request field (challengeorauthToken)
- Raises
FormatException – When the message is invalid
Query¶
- momotor.rpc.validate.query.validate_query(query)¶
Validate an
AssetQuery- Parameters
query (
AssetQuery) – The query to validate- Raises
AssetException – When the query is invalid
- momotor.rpc.validate.query.validate_query_field(message)¶
Validate the query field
- Parameters
message (
Union[AssetData,DownloadAssetRequest]) – A message with a query field- Raises
FormatException – When the query field is missing
AssetException – When the query is invalid
Base¶
- momotor.rpc.validate.base.validate_oneof(message, oneof_group, expect_oneof)¶
Generic validator used by the specific validators to check the expected oneOf group field
- Parameters
- Raises
FormatException – When the oneof group has the wrong field
- momotor.rpc.validate.base.validate_required(message, fields)¶
Generic validator used by the specific validators to check that one or more required fields are included
- Parameters
- Raises
FormatException – When one of the fields is missing