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

      All Methods Instance Methods Abstract Methods 
      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 specifes that this field must match against the specified regular expression (RE2 syntax).
      com.google.protobuf.ByteString getPatternBytes()
      Pattern specifes 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 specifes 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 Detail

      • hasConst

        boolean hasConst()
         Const specifies that this field must be exactly the specified value
        optional string const = 1;

      • getConst

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

      • getConstBytes

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

      • 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;

      • 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;

      • 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;

      • 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;

      • 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;

      • 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;

      • hasLenBytes

        boolean hasLenBytes()
         LenBytes specifies that this field must be the specified number of bytes
        optional uint64 len_bytes = 20;

      • getLenBytes

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

      • hasMinBytes

        boolean hasMinBytes()
         MinBytes specifies that this field must be the specified number of bytes
 at a minimum
        optional uint64 min_bytes = 4;

      • getMinBytes

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

      • hasMaxBytes

        boolean hasMaxBytes()
         MaxBytes specifies that this field must be the specified number of bytes
 at a maximum
        optional uint64 max_bytes = 5;

      • getMaxBytes

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

      • hasPattern

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

      • getPattern

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

      • getPatternBytes

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

      • hasPrefix

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

      • getPrefix

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

      • 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;

      • hasSuffix

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

      • getSuffix

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

      • 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;

      • hasContains

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

      • getContains

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

      • getContainsBytes

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

      • hasNotContains

        boolean hasNotContains()
         NotContains specifies that this field cannot have the specified substring
 anywhere in the string.
        optional string not_contains = 23;

      • getNotContains

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

      • 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;

      • getInList

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

      • getInCount

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

      • getIn

        String getIn​(int index)
         In specifies that this field must be equal to one of the specified
 values
        repeated string in = 10;

      • 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;

      • getNotInList

        List<String> getNotInList()
         NotIn specifies that this field cannot be equal to one of the specified
 values
        repeated string not_in = 11;

      • getNotInCount

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

      • getNotIn

        String getNotIn​(int index)
         NotIn specifies that this field cannot be equal to one of the specified
 values
        repeated string not_in = 11;

      • 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;

      • hasEmail

        boolean hasEmail()
         Email specifies that the field must be a valid email address as
 defined by RFC 5322
        optional bool email = 12;

      • getEmail

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

      • 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).
        optional bool hostname = 13;

      • 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).
        optional bool hostname = 13;

      • 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.
        optional bool ip = 14;

      • 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.
        optional bool ip = 14;

      • hasIpv4

        boolean hasIpv4()
         Ipv4 specifies that the field must be a valid IPv4 address.
        optional bool ipv4 = 15;

      • getIpv4

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

      • hasIpv6

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

      • getIpv6

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

      • hasUri

        boolean hasUri()
         Uri specifies that the field must be a valid, absolute URI as defined
 by RFC 3986
        optional bool uri = 17;

      • getUri

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

      • hasUriRef

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

      • getUriRef

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

      • 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).
        optional bool address = 21;

      • 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).
        optional bool address = 21;

      • hasUuid

        boolean hasUuid()
         Uuid specifies that the field must be a valid UUID as defined by
 RFC 4122
        optional bool uuid = 22;

      • getUuid

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

      • hasWellKnownRegex

        boolean hasWellKnownRegex()
         WellKnownRegex specifies a common well known pattern defined as a regex.
        optional .validate.KnownRegex well_known_regex = 24;

      • getWellKnownRegex

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

      • 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];

      • 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];

      • 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;

      • 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;