HttpRoute_HeaderMatch class
Specifies how to select a route rule based on HTTP request headers.
- Inheritance
-
- Object
- GeneratedMessage
- HttpRoute_HeaderMatch
Constructors
- HttpRoute_HeaderMatch({String? header, String? exactMatch, String? regexMatch, String? prefixMatch, bool? presentMatch, String? suffixMatch, HttpRoute_HeaderMatch_IntegerRange? rangeMatch, bool? invertMatch})
-
factory
-
HttpRoute_HeaderMatch.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- HttpRoute_HeaderMatch.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- exactMatch ↔ String
-
The value of the header should match exactly the content of
exact_match.
getter/setter pair
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
- header ↔ String
-
The name of the HTTP header to match against.
getter/setter pair
- info_ → BuilderInfo
-
no setteroverride
- invertMatch ↔ bool
-
If specified, the match result will be inverted before checking. Default
value is set to false.
getter/setter pair
- isFrozen → bool
-
Returns
trueif this message is marked read-only. Otherwisefalse.no setterinherited - prefixMatch ↔ String
-
The value of the header must start with the contents of prefix_match.
getter/setter pair
- presentMatch ↔ bool
-
A header with header_name must exist. The match takes place whether or
not the header has a value.
getter/setter pair
- rangeMatch ↔ HttpRoute_HeaderMatch_IntegerRange
-
If specified, the rule will match if the request header value is within
the range.
getter/setter pair
- regexMatch ↔ String
-
The value of the header must match the regular expression specified in
regex_match. For regular expression grammar, please see:
https://github.com/google/re2/wiki/Syntax
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- suffixMatch ↔ String
-
The value of the header must end with the contents of suffix_match.
getter/setter pair
- unknownFields → UnknownFieldSet
-
no setterinherited
Methods
-
addExtension(
Extension extension, Object? value) → void -
Adds an extension field value to a repeated field.
inherited
-
check(
) → void -
inherited
-
clear(
) → void -
Clears all data that was set in this message.
inherited
-
clearExactMatch(
) → void -
clearExtension(
Extension extension) → void -
Clears an extension field and also removes the extension.
inherited
-
clearField(
int tagNumber) → void -
Clears the contents of a given field.
inherited
-
clearHeader(
) → void -
clearInvertMatch(
) → void -
clearMatchType(
) → void -
clearPrefixMatch(
) → void -
clearPresentMatch(
) → void -
clearRangeMatch(
) → void -
clearRegexMatch(
) → void -
clearSuffixMatch(
) → void -
clone(
) → HttpRoute_HeaderMatch -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(HttpRoute_HeaderMatch)) → HttpRoute_HeaderMatch -
Apply
updatesto a copy of this message.override -
createEmptyInstance(
) → HttpRoute_HeaderMatch -
Creates an empty instance of the same message type as this.
override
-
createMapField<
K, V> (int tagNumber, MapFieldInfo< K, V> fi) → Map<K, V> -
Creates a Map representing a map field.
inherited
-
createRepeatedField<
T> (int tagNumber, FieldInfo< T> fi) → List<T> -
Creates List implementing a mutable repeated field.
inherited
-
ensureRangeMatch(
) → HttpRoute_HeaderMatch_IntegerRange -
extensionsAreInitialized(
) → bool -
inherited
-
freeze(
) → GeneratedMessage -
Make this message read-only.
inherited
-
getDefaultForField(
int tagNumber) → dynamic -
Returns the default value for the given field.
inherited
-
getExtension(
Extension extension) → dynamic -
Returns the value of
extension.inherited -
getField(
int tagNumber) → dynamic -
Returns the value of the field associated with
tagNumber, or the default value if it is not set.inherited -
getFieldOrNull(
int tagNumber) → dynamic -
Returns the value of a field, ignoring any defaults.
inherited
-
getTagNumber(
String fieldName) → int? -
inherited
-
hasExactMatch(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
trueif a value ofextensionis present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber.inherited -
hasHeader(
) → bool -
hasInvertMatch(
) → bool -
hasPrefixMatch(
) → bool -
hasPresentMatch(
) → bool -
hasRangeMatch(
) → bool -
hasRegexMatch(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasSuffixMatch(
) → bool -
isInitialized(
) → bool -
Whether all required fields in the message and embedded messages are set.
inherited
-
mergeFromBuffer(
List< int> input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges serialized protocol buffer data into this message.
inherited
-
mergeFromCodedBufferReader(
CodedBufferReader input, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
inherited
-
mergeFromJson(
String data, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from
data, a JSON object, encoded as described byGeneratedMessage.writeToJson.inherited -
mergeFromJsonMap(
Map< String, dynamic> json, [ExtensionRegistry extensionRegistry = ExtensionRegistry.EMPTY]) → void -
Merges field values from a JSON object represented as a Dart map.
inherited
-
mergeFromMessage(
GeneratedMessage other) → void -
Merges the contents of the
otherinto this message.inherited -
mergeFromProto3Json(
Object? json, {TypeRegistry typeRegistry = const TypeRegistry.empty(), bool ignoreUnknownFields = false, bool supportNamesWithUnderscores = true, bool permissiveEnums = false}) → void -
Merges field values from
json, a JSON object using proto3 encoding.inherited -
mergeUnknownFields(
UnknownFieldSet unknownFieldSet) → void -
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setExtension(
Extension extension, Object value) → void -
Sets the value of a non-repeated extension field to
value.inherited -
setField(
int tagNumber, Object value) → void -
Sets the value of a field by its
tagNumber.inherited -
toBuilder(
) → GeneratedMessage -
Creates a writable, shallow copy of this message.
inherited
-
toDebugString(
) → String -
Returns a String representation of this message.
inherited
-
toProto3Json(
{TypeRegistry typeRegistry = const TypeRegistry.empty()}) → Object? -
Returns an Object representing Proto3 JSON serialization of
this.inherited -
toString(
) → String -
Returns a String representation of this message.
inherited
-
whichMatchType(
) → HttpRoute_HeaderMatch_MatchType -
writeToBuffer(
) → Uint8List -
inherited
-
writeToCodedBufferWriter(
CodedBufferWriter output) → void -
inherited
-
writeToJson(
) → String -
Returns a JSON string that encodes this message.
inherited
-
writeToJsonMap(
) → Map< String, dynamic> -
Returns the JSON encoding of this message as a Dart Map.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
create(
) → HttpRoute_HeaderMatch -
createRepeated(
) → PbList< HttpRoute_HeaderMatch> -
getDefault(
) → HttpRoute_HeaderMatch