AttributeContext class
This message defines the standard attribute vocabulary for Google APIs.
An attribute is a piece of metadata that describes an activity on a network service. For example, the size of an HTTP request, or the status code of an HTTP response.
Each attribute has a type and a name, which is logically defined as
a proto message field in AttributeContext
. The field type becomes the
attribute type, and the field path becomes the attribute name. For example,
the attribute source.ip
maps to field AttributeContext.source.ip
.
This message definition is guaranteed not to have any wire breaking change. So you can use it directly for passing attributes across different systems.
NOTE: Different system may generate different subset of attributes. Please verify the system specification before relying on an attribute generated a system.
- Inheritance
-
- Object
- GeneratedMessage
- AttributeContext
Constructors
- AttributeContext({AttributeContext_Peer? source, AttributeContext_Peer? destination, AttributeContext_Request? request, AttributeContext_Response? response, AttributeContext_Resource? resource, AttributeContext_Api? api, AttributeContext_Peer? origin})
-
factory
-
AttributeContext.fromBuffer(List<
int> i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY]) -
factory
- AttributeContext.fromJson(String i, [ExtensionRegistry r = $pb.ExtensionRegistry.EMPTY])
-
factory
Properties
- api ↔ AttributeContext_Api
-
Represents an API operation that is involved to a network activity.
getter/setter pair
- destination ↔ AttributeContext_Peer
-
The destination of a network activity, such as accepting a TCP connection.
In a multi hop network activity, the destination represents the receiver of
the last hop.
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
- info_ → BuilderInfo
-
no setteroverride
- isFrozen → bool
-
Returns
true
if this message is marked read-only. Otherwisefalse
.no setterinherited - origin ↔ AttributeContext_Peer
-
The origin of a network activity. In a multi hop network activity,
the origin represents the sender of the first hop. For the first hop,
the
source
and theorigin
must have the same content.getter/setter pair - request ↔ AttributeContext_Request
-
Represents a network request, such as an HTTP request.
getter/setter pair
- resource ↔ AttributeContext_Resource
-
Represents a target resource that is involved with a network activity.
If multiple resources are involved with an activity, this must be the
primary one.
getter/setter pair
- response ↔ AttributeContext_Response
-
Represents a network response, such as an HTTP response.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- source ↔ AttributeContext_Peer
-
The source of a network activity, such as starting a TCP connection.
In a multi hop network activity, the source represents the sender of the
last hop.
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
-
clearApi(
) → void -
clearDestination(
) → 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
-
clearOrigin(
) → void -
clearRequest(
) → void -
clearResource(
) → void -
clearResponse(
) → void -
clearSource(
) → void -
clone(
) → AttributeContext -
Creates a deep copy of the fields in this message.
(The generated code uses mergeFromMessage.)
override
-
copyWith(
void updates(AttributeContext)) → AttributeContext -
Apply
updates
to a copy of this message.override -
createEmptyInstance(
) → AttributeContext -
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
-
ensureApi(
) → AttributeContext_Api -
ensureDestination(
) → AttributeContext_Peer -
ensureOrigin(
) → AttributeContext_Peer -
ensureRequest(
) → AttributeContext_Request -
ensureResource(
) → AttributeContext_Resource -
ensureResponse(
) → AttributeContext_Response -
ensureSource(
) → AttributeContext_Peer -
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
-
hasApi(
) → bool -
hasDestination(
) → 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 -
hasOrigin(
) → bool -
hasRequest(
) → bool -
hasRequiredFields(
) → bool -
Whether the message has required fields.
inherited
-
hasResource(
) → bool -
hasResponse(
) → bool -
hasSource(
) → 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
Static Methods
-
create(
) → AttributeContext -
createRepeated(
) → PbList< AttributeContext> -
getDefault(
) → AttributeContext