public sealed class AttributeContext : IMessage<AttributeContext>, IEquatable<AttributeContext>, IDeepCloneable<AttributeContext>, IBufferMessage, IMessage
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 >
AttributeContext
Namespace
Google.Rpc.Context
Assembly
Google.Api.CommonProtos.dll
Constructors
AttributeContext()
public AttributeContext()
AttributeContext(AttributeContext)
public AttributeContext(AttributeContext other)
Fields
ApiFieldNumber
public const int ApiFieldNumber = 6
Field number for the "api" field.
Field Value |
Type |
Description |
int |
|
DestinationFieldNumber
public const int DestinationFieldNumber = 2
Field number for the "destination" field.
Field Value |
Type |
Description |
int |
|
ExtensionsFieldNumber
public const int ExtensionsFieldNumber = 8
Field number for the "extensions" field.
Field Value |
Type |
Description |
int |
|
OriginFieldNumber
public const int OriginFieldNumber = 7
Field number for the "origin" field.
Field Value |
Type |
Description |
int |
|
RequestFieldNumber
public const int RequestFieldNumber = 3
Field number for the "request" field.
Field Value |
Type |
Description |
int |
|
ResourceFieldNumber
public const int ResourceFieldNumber = 5
Field number for the "resource" field.
Field Value |
Type |
Description |
int |
|
ResponseFieldNumber
public const int ResponseFieldNumber = 4
Field number for the "response" field.
Field Value |
Type |
Description |
int |
|
SourceFieldNumber
public const int SourceFieldNumber = 1
Field number for the "source" field.
Field Value |
Type |
Description |
int |
|
Properties
Api
public AttributeContext.Types.Api Api { get; set; }
Represents an API operation that is involved to a network activity.
Descriptor
public static MessageDescriptor Descriptor { get; }
Destination
public AttributeContext.Types.Peer Destination { get; set; }
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.
Extensions
public RepeatedField<Any> Extensions { get; }
Supports extensions for advanced use cases, such as logs and metrics.
Origin
public AttributeContext.Types.Peer Origin { get; set; }
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 the origin
must have the same content.
Parser
public static MessageParser<AttributeContext> Parser { get; }
Request
public AttributeContext.Types.Request Request { get; set; }
Represents a network request, such as an HTTP request.
Resource
public AttributeContext.Types.Resource Resource { get; set; }
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.
Response
public AttributeContext.Types.Response Response { get; set; }
Represents a network response, such as an HTTP response.
Source
public AttributeContext.Types.Peer Source { get; set; }
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.
Methods
CalculateSize()
public int CalculateSize()
Returns |
Type |
Description |
int |
|
Clone()
public AttributeContext Clone()
Equals(AttributeContext)
public bool Equals(AttributeContext other)
Returns |
Type |
Description |
bool |
|
Equals(object)
public override bool Equals(object other)
Parameter |
Name |
Description |
other |
object
|
Returns |
Type |
Description |
bool |
|
Overrides
GetHashCode()
public override int GetHashCode()
Returns |
Type |
Description |
int |
|
Overrides
MergeFrom(CodedInputStream)
public void MergeFrom(CodedInputStream input)
MergeFrom(AttributeContext)
public void MergeFrom(AttributeContext other)
ToString()
public override string ToString()
Returns |
Type |
Description |
string |
|
Overrides
WriteTo(CodedOutputStream)
public void WriteTo(CodedOutputStream output)