StringRules

StringRules describe the constraints applied to string values

const: Const specifies that this field must be exactly the specified value
len: Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string.
minLen: MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string.
maxLen: MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string.
lenBytes: LenBytes specifies that this field must be the specified number of bytes
minBytes: MinBytes specifies that this field must be the specified number of bytes at a minimum
maxBytes: MaxBytes specifies that this field must be the specified number of bytes at a maximum
pattern: Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters.
prefix: Prefix specifies that this field must have the specified substring at the beginning of the string.
suffix: Suffix specifies that this field must have the specified substring at the end of the string.
contains: Contains specifies that this field must have the specified substring anywhere in the string.
notContains: NotContains specifies that this field cannot have the specified substring anywhere in the string.
in: In specifies that this field must be equal to one of the specified values
notIn: NotIn specifies that this field cannot be equal to one of the specified values
strict: This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows &92;r&92;n&92;0 characters, which can be used to bypass header matching rules.
ignoreEmpty: IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty

Annotations: @SerialVersionUID()

Linear Supertypes

Product, Equals, Updatable[StringRules], Message[StringRules], GeneratedMessage, Serializable, Serializable, AnyRef, Any

Instance Constructors

new StringRules(const: Option[String] = _root_.scala.None, len: Option[Long] = _root_.scala.None, minLen: Option[Long] = _root_.scala.None, maxLen: Option[Long] = _root_.scala.None, lenBytes: Option[Long] = _root_.scala.None, minBytes: Option[Long] = _root_.scala.None, maxBytes: Option[Long] = _root_.scala.None, pattern: Option[String] = _root_.scala.None, prefix: Option[String] = _root_.scala.None, suffix: Option[String] = _root_.scala.None, contains: Option[String] = _root_.scala.None, notContains: Option[String] = _root_.scala.None, in: Seq[String] = _root_.scala.Seq.empty, notIn: Seq[String] = _root_.scala.Seq.empty, strict: Option[Boolean] = _root_.scala.None, ignoreEmpty: Option[Boolean] = _root_.scala.None, wellKnown: WellKnown = ...)

const
Const specifies that this field must be exactly the specified value
len
Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string.
minLen
MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string.
maxLen
MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string.
lenBytes
LenBytes specifies that this field must be the specified number of bytes
minBytes
MinBytes specifies that this field must be the specified number of bytes at a minimum
maxBytes
MaxBytes specifies that this field must be the specified number of bytes at a maximum
pattern
Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters.
prefix
Prefix specifies that this field must have the specified substring at the beginning of the string.
suffix
Suffix specifies that this field must have the specified substring at the end of the string.
contains
Contains specifies that this field must have the specified substring anywhere in the string.
notContains
NotContains specifies that this field cannot have the specified substring anywhere in the string.
in
In specifies that this field must be equal to one of the specified values
notIn
NotIn specifies that this field cannot be equal to one of the specified values
strict
This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows &92;r&92;n&92;0 characters, which can be used to bypass header matching rules.
ignoreEmpty
IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addAllIn(__vs: Iterable[String]): StringRules
def addAllNotIn(__vs: Iterable[String]): StringRules
def addIn(__vs: String*): StringRules
def addNotIn(__vs: String*): StringRules
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clearConst: StringRules
def clearContains: StringRules
def clearIgnoreEmpty: StringRules
def clearIn: StringRules
def clearLen: StringRules
def clearLenBytes: StringRules
def clearMaxBytes: StringRules
def clearMaxLen: StringRules
def clearMinBytes: StringRules
def clearMinLen: StringRules
def clearNotContains: StringRules
def clearNotIn: StringRules
def clearPattern: StringRules
def clearPrefix: StringRules
def clearStrict: StringRules
def clearSuffix: StringRules
def clearWellKnown: StringRules
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def companion: StringRules.type

Definition Classes
StringRules → GeneratedMessage
val const: Option[String]

Const specifies that this field must be exactly the specified value
val contains: Option[String]

Contains specifies that this field must have the specified substring anywhere in the string.
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def getAddress: Boolean
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getConst: String
def getContains: String
def getEmail: Boolean
def getField(__field: FieldDescriptor): PValue

Definition Classes
StringRules → GeneratedMessage
def getFieldByNumber(__fieldNumber: Int): Any

Definition Classes
StringRules → GeneratedMessage
def getHostname: Boolean
def getIgnoreEmpty: Boolean
def getIp: Boolean
def getIpv4: Boolean
def getIpv6: Boolean
def getLen: Long
def getLenBytes: Long
def getMaxBytes: Long
def getMaxLen: Long
def getMinBytes: Long
def getMinLen: Long
def getNotContains: String
def getPattern: String
def getPrefix: String
def getStrict: Boolean
def getSuffix: String
def getUri: Boolean
def getUriRef: Boolean
def getUuid: Boolean
def getWellKnownRegex: KnownRegex
val ignoreEmpty: Option[Boolean]

IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
val in: Seq[String]

In specifies that this field must be equal to one of the specified values
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val len: Option[Long]

Len specifies that this field must be the specified number of characters (Unicode code points).
Len specifies that this field must be the specified number of characters (Unicode code points). Note that the number of characters may differ from the number of bytes in the string.
val lenBytes: Option[Long]

LenBytes specifies that this field must be the specified number of bytes
val maxBytes: Option[Long]

MaxBytes specifies that this field must be the specified number of bytes at a maximum
val maxLen: Option[Long]

MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum.
MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum. Note that the number of characters may differ from the number of bytes in the string.
def mergeFrom(_input__: CodedInputStream): StringRules

Definition Classes
StringRules → Message
val minBytes: Option[Long]

MinBytes specifies that this field must be the specified number of bytes at a minimum
val minLen: Option[Long]

MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum.
MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum. Note that the number of characters may differ from the number of bytes in the string.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val notContains: Option[String]

NotContains specifies that this field cannot have the specified substring anywhere in the string.
val notIn: Seq[String]

NotIn specifies that this field cannot be equal to one of the specified values
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val pattern: Option[String]

Pattern specifes that this field must match against the specified regular expression (RE2 syntax).
Pattern specifes that this field must match against the specified regular expression (RE2 syntax). The included expression should elide any delimiters.
val prefix: Option[String]

Prefix specifies that this field must have the specified substring at the beginning of the string.
final def serializedSize: Int

Definition Classes
StringRules → GeneratedMessage
val strict: Option[Boolean]

This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation.
This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation. By default, this is true, and HTTP header validations are RFC-compliant. Setting to false will enable a looser validations that only disallows &92;r&92;n&92;0 characters, which can be used to bypass header matching rules.
val suffix: Option[String]

Suffix specifies that this field must have the specified substring at the end of the string.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toByteArray: Array[Byte]

Definition Classes
GeneratedMessage
def toByteString: ByteString

Definition Classes
GeneratedMessage
def toPMessage: PMessage

Definition Classes
GeneratedMessage
def toProtoString: String

Definition Classes
StringRules → GeneratedMessage
def update(ms: (Lens[StringRules, StringRules]) ⇒ Mutation[StringRules]*): StringRules

Definition Classes
Updatable
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val wellKnown: WellKnown
def withAddress(__v: Boolean): StringRules
def withConst(__v: String): StringRules
def withContains(__v: String): StringRules
def withEmail(__v: Boolean): StringRules
def withHostname(__v: Boolean): StringRules
def withIgnoreEmpty(__v: Boolean): StringRules
def withIn(__v: Seq[String]): StringRules
def withIp(__v: Boolean): StringRules
def withIpv4(__v: Boolean): StringRules
def withIpv6(__v: Boolean): StringRules
def withLen(__v: Long): StringRules
def withLenBytes(__v: Long): StringRules
def withMaxBytes(__v: Long): StringRules
def withMaxLen(__v: Long): StringRules
def withMinBytes(__v: Long): StringRules
def withMinLen(__v: Long): StringRules
def withNotContains(__v: String): StringRules
def withNotIn(__v: Seq[String]): StringRules
def withPattern(__v: String): StringRules
def withPrefix(__v: String): StringRules
def withStrict(__v: Boolean): StringRules
def withSuffix(__v: String): StringRules
def withUri(__v: Boolean): StringRules
def withUriRef(__v: Boolean): StringRules
def withUuid(__v: Boolean): StringRules
def withWellKnown(__v: WellKnown): StringRules
def withWellKnownRegex(__v: KnownRegex): StringRules
def writeDelimitedTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage
def writeTo(_output__: CodedOutputStream): Unit

Definition Classes
StringRules → GeneratedMessage
def writeTo(output: OutputStream): Unit

Definition Classes
GeneratedMessage

Deprecated Value Members

def getAllFields: Map[FieldDescriptor, Any]

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use toPMessage
def getField(field: FieldDescriptor): Any

Definition Classes
GeneratedMessage
Annotations
@deprecated
Deprecated
(Since version 0.6.0) Use getField that accepts a ScalaPB descriptor and returns PValue

Related Docs: object StringRules | package validate

Instance Constructors

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addAllIn(__vs: Iterable[String]): StringRules

def addAllNotIn(__vs: Iterable[String]): StringRules

def addIn(__vs: String*): StringRules

def addNotIn(__vs: String*): StringRules

final def asInstanceOf[T0]: T0

def clearConst: StringRules

def clearContains: StringRules

def clearIgnoreEmpty: StringRules

def clearIn: StringRules

def clearLen: StringRules

def clearLenBytes: StringRules

def clearMaxBytes: StringRules

def clearMaxLen: StringRules

def clearMinBytes: StringRules

def clearMinLen: StringRules

def clearNotContains: StringRules

def clearNotIn: StringRules

def clearPattern: StringRules

def clearPrefix: StringRules

def clearStrict: StringRules

def clearSuffix: StringRules

def clearWellKnown: StringRules

def clone(): AnyRef

def companion: StringRules.type

val const: Option[String]

val contains: Option[String]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

def getAddress: Boolean

final def getClass(): Class[_]

def getConst: String

def getContains: String

def getEmail: Boolean

def getField(__field: FieldDescriptor): PValue

def getFieldByNumber(__fieldNumber: Int): Any

def getHostname: Boolean

def getIgnoreEmpty: Boolean

def getIp: Boolean

def getIpv4: Boolean

def getIpv6: Boolean

def getLen: Long

def getLenBytes: Long

def getMaxBytes: Long

def getMaxLen: Long

def getMinBytes: Long

def getMinLen: Long

def getNotContains: String

def getPattern: String

def getPrefix: String

def getStrict: Boolean

def getSuffix: String

def getUri: Boolean

def getUriRef: Boolean

def getUuid: Boolean

def getWellKnownRegex: KnownRegex

val ignoreEmpty: Option[Boolean]

val in: Seq[String]

final def isInstanceOf[T0]: Boolean

val len: Option[Long]

val lenBytes: Option[Long]

val maxBytes: Option[Long]

val maxLen: Option[Long]

def mergeFrom(_input__: CodedInputStream): StringRules

val minBytes: Option[Long]

val minLen: Option[Long]

final def ne(arg0: AnyRef): Boolean

val notContains: Option[String]

val notIn: Seq[String]

final def notify(): Unit

final def notifyAll(): Unit

val pattern: Option[String]

val prefix: Option[String]

final def serializedSize: Int