AttributeContext_Request class
This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.
- Inheritance
-
- Object
- GeneratedMessage
- AttributeContext_Request
Constructors
-
AttributeContext_Request({String? id, String? method, Map<
String, String> ? headers, String? path, String? host, String? scheme, String? query, Timestamp? time, Int64? size, String? protocol, String? reason, AttributeContext_Auth? auth}) -
factory
-
AttributeContext_Request.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- AttributeContext_Request.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- auth ↔ AttributeContext_Auth
-
The request authentication. May be absent for unauthenticated requests.
Derived from the HTTP request
Authorization
header or equivalent.getter/setter pair - eventPlugin → EventPlugin?
-
Subclasses can override this getter to be notified of changes
to protobuf fields.
no setterinherited
- hashCode → int
-
Calculates a hash code based on the contents of the protobuf.
no setterinherited
-
headers
→ Map<
String, String> -
The HTTP request headers. If multiple headers share the same key, they
must be merged according to the HTTP spec. All header keys must be
lowercased, because HTTP header keys are case-insensitive.
no setter
- host ↔ String
-
The HTTP request
Host
header value.getter/setter pair - id ↔ String
-
The unique ID for a request, which can be propagated to downstream
systems. The ID should have low probability of collision
within a single day for a specific service.
getter/setter pair
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
true
if this message is marked read-only. Otherwisefalse
.no setterinherited - method ↔ String
-
The HTTP request method, such as
GET
,POST
.getter/setter pair - path ↔ String
-
The HTTP URL path.
getter/setter pair
- protocol ↔ String
-
The network protocol used with the request, such as "http/1.1",
"spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See
https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids
for details.
getter/setter pair
- query ↔ String
-
The HTTP URL query in the format of
name1=value1&name2=value2
, as it appears in the first line of the HTTP request. No decoding is performed.getter/setter pair - reason ↔ String
-
A special parameter for request reason. It is used by security systems
to associate auditing information with a request.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scheme ↔ String
-
The HTTP URL scheme, such as
http
andhttps
.getter/setter pair - size ↔ Int64
-
The HTTP request size in bytes. If unknown, it must be -1.
getter/setter pair
- time ↔ Timestamp
-
The timestamp when the
destination
service receives the first byte of the request.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
-
clearAuth(
) → 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
-
clearHost(
) → void -
clearId(
) → void -
clearMethod(
) → void -
clearPath(
) → void -
clearProtocol(
) → void -
clearQuery(
) → void -
clearReason(
) → void -
clearScheme(
) → void -
clearSize(
) → void -
clearTime(
) → void -
clone(
) → AttributeContext_Request -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(AttributeContext_Request)) → AttributeContext_Request -
Apply
updates
to a copy of this message.override -
createEmptyInstance(
) → AttributeContext_Request -
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
-
ensureAuth(
) → AttributeContext_Auth -
ensureTime(
) → Timestamp -
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
-
hasAuth(
) → bool -
hasExtension(
Extension extension) → bool -
Returns
true
if a value ofextension
is present.inherited -
hasField(
int tagNumber) → bool -
Whether this message has a field associated with
tagNumber
.inherited -
hasHost(
) → bool -
hasId(
) → bool -
hasMethod(
) → bool -
hasPath(
) → bool -
hasProtocol(
) → bool -
hasQuery(
) → bool -
hasReason(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasScheme(
) → bool -
hasSize(
) → bool -
hasTime(
) → 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
other
into 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
-
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