3.0.0

Ksui gRPC/com.google.rpc/BadRequest/FieldViolation

FieldViolation

interface FieldViolation

A message type used to describe a single bad request field.

Properties

abstract val description: String

A description of why the request element is bad.

abstract val field: String

A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.

localizedMessage

abstract val localizedMessage: LocalizedMessage

Provides a localized error message for field-level errors that is safe to return to the API consumer.

val BadRequest.FieldViolation.presence: BadRequestPresence.FieldViolation

Returns the field-presence view for this BadRequest.FieldViolation instance.

abstract val reason: String

The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

Functions

fun BadRequest.FieldViolation.asInternal(): BadRequestInternal.FieldViolationInternal

fun BadRequest.FieldViolation.copy(body: <Error class: unknown class>.() -> Unit = {}): BadRequest.FieldViolation

Copies the original message, including unknown fields.