Message validation

Validators for gRPC messages

Requests

momotor.rpc.validate.request.validate_authenticate_request(message, *, expect_oneof)

Validate AuthenticateRequest message

Parameters:

• message (AuthenticateRequest) – The message to validate

• expect_oneof (str) – Expected request field (apiKey or challengeResponse)

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_create_job_request(message)

Validate CreateJobRequest message

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 DownloadAssetRequest message

Parameters:

• message (DownloadAssetRequest) – The message to validate

• expect_oneof (str) – Expected request field (query or accepted)

Raises:

• FormatException – When the message is invalid

• AssetException – When the query is invalid

momotor.rpc.validate.request.validate_end_job_request(message)

Validate EndJobRequest message

Parameters:

message (EndJobRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_get_task_request(message)

Validate GetTaskRequest message

Parameters:

message (GetTaskRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_job_status_request(message)

Validate JobStatusRequest message

Parameters:

message (JobStatusRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_shared_lock_request(message)

Validate SharedLockRequest message

Parameters:

message (SharedLockRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_start_job_request(message)

Validate StartJobRequest message

Parameters:

message (StartJobRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_update_status_request(message)

Validate UpdateTaskStatusRequest message

Parameters:

message (UpdateTaskStatusRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_upload_asset_request(message, *, expect_oneof)

Validate UploadAssetRequest message

Parameters:

• message (UploadAssetRequest) – The message to validate

• expect_oneof (str) – Expected request field (assetData or chunk)

Raises:

• FormatException – When the message is invalid

• AssetException – When the query is invalid

Responses

momotor.rpc.validate.response.validate_authenticate_response(message, *, expect_oneof)

Validate AuthenticateResponse message

Parameters:

• message (AuthenticateResponse) – The message to validate

• expect_oneof (str) – Expected request field (challenge or authToken)

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:

• message (Message) – Message to validate

• oneof_group (str) – oneOf group to validate

• expect_oneof (str) – expected field in the oneof_group

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:

• message (Message) – Message to validate

• fields (List[str]) – List of field required field names

Raises:

FormatException – When one of the fields is missing