Package io.envoyproxy.pgv.validate

Interface Validate.StringRulesOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Validate.StringRules, Validate.StringRules.Builder
Enclosing class:
Validate
public static interface Validate.StringRulesOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAddress()
    Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6).
    String
    getConst()
    Const specifies that this field must be exactly the specified value
    com.google.protobuf.ByteString
    getConstBytes()
    Const specifies that this field must be exactly the specified value
    String
    getContains()
    Contains specifies that this field must have the specified substring anywhere in the string.
    com.google.protobuf.ByteString
    getContainsBytes()
    Contains specifies that this field must have the specified substring anywhere in the string.
    boolean
    getEmail()
    Email specifies that the field must be a valid email address as defined by RFC 5322
    boolean
    getHostname()
    Hostname specifies that the field must be a valid hostname as defined by RFC 1034.
    boolean
    getIgnoreEmpty()
    IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
    String
    getIn(int index)
    In specifies that this field must be equal to one of the specified values
    com.google.protobuf.ByteString
    getInBytes(int index)
    In specifies that this field must be equal to one of the specified values
    int
    getInCount()
    In specifies that this field must be equal to one of the specified values
    List<String>
    getInList()
    In specifies that this field must be equal to one of the specified values
    boolean
    getIp()
    Ip specifies that the field must be a valid IP (v4 or v6) address.
    boolean
    getIpv4()
    Ipv4 specifies that the field must be a valid IPv4 address.
    boolean
    getIpv6()
    Ipv6 specifies that the field must be a valid IPv6 address.
    long
    getLen()
    Len specifies that this field must be the specified number of characters (Unicode code points).
    long
    getLenBytes()
    LenBytes specifies that this field must be the specified number of bytes
    long
    getMaxBytes()
    MaxBytes specifies that this field must be the specified number of bytes at a maximum
    long
    getMaxLen()
    MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum.
    long
    getMinBytes()
    MinBytes specifies that this field must be the specified number of bytes at a minimum
    long
    getMinLen()
    MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum.
    String
    getNotContains()
    NotContains specifies that this field cannot have the specified substring anywhere in the string.
    com.google.protobuf.ByteString
    getNotContainsBytes()
    NotContains specifies that this field cannot have the specified substring anywhere in the string.
    String
    getNotIn(int index)
    NotIn specifies that this field cannot be equal to one of the specified values
    com.google.protobuf.ByteString
    getNotInBytes(int index)
    NotIn specifies that this field cannot be equal to one of the specified values
    int
    getNotInCount()
    NotIn specifies that this field cannot be equal to one of the specified values
    List<String>
    getNotInList()
    NotIn specifies that this field cannot be equal to one of the specified values
    String
    getPattern()
    Pattern specifies that this field must match against the specified regular expression (RE2 syntax).
    com.google.protobuf.ByteString
    getPatternBytes()
    Pattern specifies that this field must match against the specified regular expression (RE2 syntax).
    String
    getPrefix()
    Prefix specifies that this field must have the specified substring at the beginning of the string.
    com.google.protobuf.ByteString
    getPrefixBytes()
    Prefix specifies that this field must have the specified substring at the beginning of the string.
    boolean
    getStrict()
    This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation.
    String
    getSuffix()
    Suffix specifies that this field must have the specified substring at the end of the string.
    com.google.protobuf.ByteString
    getSuffixBytes()
    Suffix specifies that this field must have the specified substring at the end of the string.
    boolean
    getUri()
    Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986
    boolean
    getUriRef()
    UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute.
    boolean
    getUuid()
    Uuid specifies that the field must be a valid UUID as defined by RFC 4122
    Validate.StringRules.WellKnownCase
    getWellKnownCase()
     
    Validate.KnownRegex
    getWellKnownRegex()
    WellKnownRegex specifies a common well known pattern defined as a regex.
    boolean
    hasAddress()
    Address specifies that the field must be either a valid hostname as defined by RFC 1034 (which does not support internationalized domain names or IDNs), or it can be a valid IP (v4 or v6).
    boolean
    hasConst()
    Const specifies that this field must be exactly the specified value
    boolean
    hasContains()
    Contains specifies that this field must have the specified substring anywhere in the string.
    boolean
    hasEmail()
    Email specifies that the field must be a valid email address as defined by RFC 5322
    boolean
    hasHostname()
    Hostname specifies that the field must be a valid hostname as defined by RFC 1034.
    boolean
    hasIgnoreEmpty()
    IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty
    boolean
    hasIp()
    Ip specifies that the field must be a valid IP (v4 or v6) address.
    boolean
    hasIpv4()
    Ipv4 specifies that the field must be a valid IPv4 address.
    boolean
    hasIpv6()
    Ipv6 specifies that the field must be a valid IPv6 address.
    boolean
    hasLen()
    Len specifies that this field must be the specified number of characters (Unicode code points).
    boolean
    hasLenBytes()
    LenBytes specifies that this field must be the specified number of bytes
    boolean
    hasMaxBytes()
    MaxBytes specifies that this field must be the specified number of bytes at a maximum
    boolean
    hasMaxLen()
    MaxLen specifies that this field must be the specified number of characters (Unicode code points) at a maximum.
    boolean
    hasMinBytes()
    MinBytes specifies that this field must be the specified number of bytes at a minimum
    boolean
    hasMinLen()
    MinLen specifies that this field must be the specified number of characters (Unicode code points) at a minimum.
    boolean
    hasNotContains()
    NotContains specifies that this field cannot have the specified substring anywhere in the string.
    boolean
    hasPattern()
    Pattern specifies that this field must match against the specified regular expression (RE2 syntax).
    boolean
    hasPrefix()
    Prefix specifies that this field must have the specified substring at the beginning of the string.
    boolean
    hasStrict()
    This applies to regexes HTTP_HEADER_NAME and HTTP_HEADER_VALUE to enable strict header validation.
    boolean
    hasSuffix()
    Suffix specifies that this field must have the specified substring at the end of the string.
    boolean
    hasUri()
    Uri specifies that the field must be a valid, absolute URI as defined by RFC 3986
    boolean
    hasUriRef()
    UriRef specifies that the field must be a valid URI as defined by RFC 3986 and may be relative or absolute.
    boolean
    hasUuid()
    Uuid specifies that the field must be a valid UUID as defined by RFC 4122
    boolean
    hasWellKnownRegex()
    WellKnownRegex specifies a common well known pattern defined as a regex.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasConst

      boolean hasConst()
       Const specifies that this field must be exactly the specified value
      optional string const = 1;
      Returns:
      Whether the const field is set.

    • getConst

      String getConst()
       Const specifies that this field must be exactly the specified value
      optional string const = 1;
      Returns:
      The const.

    • getConstBytes

      com.google.protobuf.ByteString getConstBytes()
       Const specifies that this field must be exactly the specified value
      optional string const = 1;
      Returns:
      The bytes for const.

    • hasLen

      boolean hasLen()
       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.
      optional uint64 len = 19;
      Returns:
      Whether the len field is set.

    • getLen

      long getLen()
       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.
      optional uint64 len = 19;
      Returns:
      The len.

    • hasMinLen

      boolean hasMinLen()
       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.
      optional uint64 min_len = 2;
      Returns:
      Whether the minLen field is set.

    • getMinLen

      long getMinLen()
       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.
      optional uint64 min_len = 2;
      Returns:
      The minLen.

    • hasMaxLen

      boolean hasMaxLen()
       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.
      optional uint64 max_len = 3;
      Returns:
      Whether the maxLen field is set.

    • getMaxLen

      long getMaxLen()
       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.
      optional uint64 max_len = 3;
      Returns:
      The maxLen.

    • hasLenBytes

      boolean hasLenBytes()
       LenBytes specifies that this field must be the specified number of bytes
      optional uint64 len_bytes = 20;
      Returns:
      Whether the lenBytes field is set.

    • getLenBytes

      long getLenBytes()
       LenBytes specifies that this field must be the specified number of bytes
      optional uint64 len_bytes = 20;
      Returns:
      The lenBytes.

    • hasMinBytes

      boolean hasMinBytes()
       MinBytes specifies that this field must be the specified number of bytes
 at a minimum
      optional uint64 min_bytes = 4;
      Returns:
      Whether the minBytes field is set.

    • getMinBytes

      long getMinBytes()
       MinBytes specifies that this field must be the specified number of bytes
 at a minimum
      optional uint64 min_bytes = 4;
      Returns:
      The minBytes.

    • hasMaxBytes

      boolean hasMaxBytes()
       MaxBytes specifies that this field must be the specified number of bytes
 at a maximum
      optional uint64 max_bytes = 5;
      Returns:
      Whether the maxBytes field is set.

    • getMaxBytes

      long getMaxBytes()
       MaxBytes specifies that this field must be the specified number of bytes
 at a maximum
      optional uint64 max_bytes = 5;
      Returns:
      The maxBytes.

    • hasPattern

      boolean hasPattern()
       Pattern specifies that this field must match against the specified
 regular expression (RE2 syntax). The included expression should elide
 any delimiters.
      optional string pattern = 6;
      Returns:
      Whether the pattern field is set.

    • getPattern

      String getPattern()
       Pattern specifies that this field must match against the specified
 regular expression (RE2 syntax). The included expression should elide
 any delimiters.
      optional string pattern = 6;
      Returns:
      The pattern.

    • getPatternBytes

      com.google.protobuf.ByteString getPatternBytes()
       Pattern specifies that this field must match against the specified
 regular expression (RE2 syntax). The included expression should elide
 any delimiters.
      optional string pattern = 6;
      Returns:
      The bytes for pattern.

    • hasPrefix

      boolean hasPrefix()
       Prefix specifies that this field must have the specified substring at
 the beginning of the string.
      optional string prefix = 7;
      Returns:
      Whether the prefix field is set.

    • getPrefix

      String getPrefix()
       Prefix specifies that this field must have the specified substring at
 the beginning of the string.
      optional string prefix = 7;
      Returns:
      The prefix.

    • getPrefixBytes

      com.google.protobuf.ByteString getPrefixBytes()
       Prefix specifies that this field must have the specified substring at
 the beginning of the string.
      optional string prefix = 7;
      Returns:
      The bytes for prefix.

    • hasSuffix

      boolean hasSuffix()
       Suffix specifies that this field must have the specified substring at
 the end of the string.
      optional string suffix = 8;
      Returns:
      Whether the suffix field is set.

    • getSuffix

      String getSuffix()
       Suffix specifies that this field must have the specified substring at
 the end of the string.
      optional string suffix = 8;
      Returns:
      The suffix.

    • getSuffixBytes

      com.google.protobuf.ByteString getSuffixBytes()
       Suffix specifies that this field must have the specified substring at
 the end of the string.
      optional string suffix = 8;
      Returns:
      The bytes for suffix.

    • hasContains

      boolean hasContains()
       Contains specifies that this field must have the specified substring
 anywhere in the string.
      optional string contains = 9;
      Returns:
      Whether the contains field is set.

    • getContains

      String getContains()
       Contains specifies that this field must have the specified substring
 anywhere in the string.
      optional string contains = 9;
      Returns:
      The contains.

    • getContainsBytes

      com.google.protobuf.ByteString getContainsBytes()
       Contains specifies that this field must have the specified substring
 anywhere in the string.
      optional string contains = 9;
      Returns:
      The bytes for contains.

    • hasNotContains

      boolean hasNotContains()
       NotContains specifies that this field cannot have the specified substring
 anywhere in the string.
      optional string not_contains = 23;
      Returns:
      Whether the notContains field is set.

    • getNotContains

      String getNotContains()
       NotContains specifies that this field cannot have the specified substring
 anywhere in the string.
      optional string not_contains = 23;
      Returns:
      The notContains.

    • getNotContainsBytes

      com.google.protobuf.ByteString getNotContainsBytes()
       NotContains specifies that this field cannot have the specified substring
 anywhere in the string.
      optional string not_contains = 23;
      Returns:
      The bytes for notContains.

    • getInList

      List<String> getInList()
       In specifies that this field must be equal to one of the specified
 values
      repeated string in = 10;
      Returns:
      A list containing the in.

    • getInCount

      int getInCount()
       In specifies that this field must be equal to one of the specified
 values
      repeated string in = 10;
      Returns:
      The count of in.

    • getIn

      String getIn(int index)
       In specifies that this field must be equal to one of the specified
 values
      repeated string in = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The in at the given index.

    • getInBytes

      com.google.protobuf.ByteString getInBytes(int index)
       In specifies that this field must be equal to one of the specified
 values
      repeated string in = 10;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the in at the given index.

    • getNotInList

      List<String> getNotInList()
       NotIn specifies that this field cannot be equal to one of the specified
 values
      repeated string not_in = 11;
      Returns:
      A list containing the notIn.

    • getNotInCount

      int getNotInCount()
       NotIn specifies that this field cannot be equal to one of the specified
 values
      repeated string not_in = 11;
      Returns:
      The count of notIn.

    • getNotIn

      String getNotIn(int index)
       NotIn specifies that this field cannot be equal to one of the specified
 values
      repeated string not_in = 11;
      Parameters:
      index - The index of the element to return.
      Returns:
      The notIn at the given index.

    • getNotInBytes

      com.google.protobuf.ByteString getNotInBytes(int index)
       NotIn specifies that this field cannot be equal to one of the specified
 values
      repeated string not_in = 11;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the notIn at the given index.

    • hasEmail

      boolean hasEmail()
       Email specifies that the field must be a valid email address as
 defined by RFC 5322
      bool email = 12;
      Returns:
      Whether the email field is set.

    • getEmail

      boolean getEmail()
       Email specifies that the field must be a valid email address as
 defined by RFC 5322
      bool email = 12;
      Returns:
      The email.

    • hasHostname

      boolean hasHostname()
       Hostname specifies that the field must be a valid hostname as
 defined by RFC 1034. This constraint does not support
 internationalized domain names (IDNs).
      bool hostname = 13;
      Returns:
      Whether the hostname field is set.

    • getHostname

      boolean getHostname()
       Hostname specifies that the field must be a valid hostname as
 defined by RFC 1034. This constraint does not support
 internationalized domain names (IDNs).
      bool hostname = 13;
      Returns:
      The hostname.

    • hasIp

      boolean hasIp()
       Ip specifies that the field must be a valid IP (v4 or v6) address.
 Valid IPv6 addresses should not include surrounding square brackets.
      bool ip = 14;
      Returns:
      Whether the ip field is set.

    • getIp

      boolean getIp()
       Ip specifies that the field must be a valid IP (v4 or v6) address.
 Valid IPv6 addresses should not include surrounding square brackets.
      bool ip = 14;
      Returns:
      The ip.

    • hasIpv4

      boolean hasIpv4()
       Ipv4 specifies that the field must be a valid IPv4 address.
      bool ipv4 = 15;
      Returns:
      Whether the ipv4 field is set.

    • getIpv4

      boolean getIpv4()
       Ipv4 specifies that the field must be a valid IPv4 address.
      bool ipv4 = 15;
      Returns:
      The ipv4.

    • hasIpv6

      boolean hasIpv6()
       Ipv6 specifies that the field must be a valid IPv6 address. Valid
 IPv6 addresses should not include surrounding square brackets.
      bool ipv6 = 16;
      Returns:
      Whether the ipv6 field is set.

    • getIpv6

      boolean getIpv6()
       Ipv6 specifies that the field must be a valid IPv6 address. Valid
 IPv6 addresses should not include surrounding square brackets.
      bool ipv6 = 16;
      Returns:
      The ipv6.

    • hasUri

      boolean hasUri()
       Uri specifies that the field must be a valid, absolute URI as defined
 by RFC 3986
      bool uri = 17;
      Returns:
      Whether the uri field is set.

    • getUri

      boolean getUri()
       Uri specifies that the field must be a valid, absolute URI as defined
 by RFC 3986
      bool uri = 17;
      Returns:
      The uri.

    • hasUriRef

      boolean hasUriRef()
       UriRef specifies that the field must be a valid URI as defined by RFC
 3986 and may be relative or absolute.
      bool uri_ref = 18;
      Returns:
      Whether the uriRef field is set.

    • getUriRef

      boolean getUriRef()
       UriRef specifies that the field must be a valid URI as defined by RFC
 3986 and may be relative or absolute.
      bool uri_ref = 18;
      Returns:
      The uriRef.

    • hasAddress

      boolean hasAddress()
       Address specifies that the field must be either a valid hostname as
 defined by RFC 1034 (which does not support internationalized domain
 names or IDNs), or it can be a valid IP (v4 or v6).
      bool address = 21;
      Returns:
      Whether the address field is set.

    • getAddress

      boolean getAddress()
       Address specifies that the field must be either a valid hostname as
 defined by RFC 1034 (which does not support internationalized domain
 names or IDNs), or it can be a valid IP (v4 or v6).
      bool address = 21;
      Returns:
      The address.

    • hasUuid

      boolean hasUuid()
       Uuid specifies that the field must be a valid UUID as defined by
 RFC 4122
      bool uuid = 22;
      Returns:
      Whether the uuid field is set.

    • getUuid

      boolean getUuid()
       Uuid specifies that the field must be a valid UUID as defined by
 RFC 4122
      bool uuid = 22;
      Returns:
      The uuid.

    • hasWellKnownRegex

      boolean hasWellKnownRegex()
       WellKnownRegex specifies a common well known pattern defined as a regex.
      .validate.KnownRegex well_known_regex = 24;
      Returns:
      Whether the wellKnownRegex field is set.

    • getWellKnownRegex

      Validate.KnownRegex getWellKnownRegex()
       WellKnownRegex specifies a common well known pattern defined as a regex.
      .validate.KnownRegex well_known_regex = 24;
      Returns:
      The wellKnownRegex.

    • hasStrict

      boolean hasStrict()
       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
 \r\n\0 characters, which can be used to bypass header matching rules.
      optional bool strict = 25 [default = true];
      Returns:
      Whether the strict field is set.

    • getStrict

      boolean getStrict()
       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
 \r\n\0 characters, which can be used to bypass header matching rules.
      optional bool strict = 25 [default = true];
      Returns:
      The strict.

    • hasIgnoreEmpty

      boolean hasIgnoreEmpty()
       IgnoreEmpty specifies that the validation rules of this field should be
 evaluated only if the field is not empty
      optional bool ignore_empty = 26;
      Returns:
      Whether the ignoreEmpty field is set.

    • getIgnoreEmpty

      boolean getIgnoreEmpty()
       IgnoreEmpty specifies that the validation rules of this field should be
 evaluated only if the field is not empty
      optional bool ignore_empty = 26;
      Returns:
      The ignoreEmpty.

    • getWellKnownCase

      Validate.StringRules.WellKnownCase getWellKnownCase()