Class AttributeContext (2.15.0)

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

Implements

IMessage AttributeContext, IEquatable AttributeContext, IDeepCloneable AttributeContext, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Rpc.Context

Assembly

Google.Api.CommonProtos.dll

Constructors

AttributeContext()

public AttributeContext()

AttributeContext(AttributeContext)

public AttributeContext(AttributeContext other)

Parameter
Name	Description
`other`	`AttributeContext`

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.

Property Value
Type	Description
`AttributeContextTypesApi`

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`MessageDescriptor`

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.

Property Value
Type	Description
`AttributeContextTypesPeer`

Extensions

public RepeatedField<Any> Extensions { get; }

Supports extensions for advanced use cases, such as logs and metrics.

Property Value
Type	Description
`RepeatedFieldAny`

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.

Property Value
Type	Description
`AttributeContextTypesPeer`

Parser

public static MessageParser<AttributeContext> Parser { get; }

Property Value
Type	Description
`MessageParserAttributeContext`

Request

public AttributeContext.Types.Request Request { get; set; }

Represents a network request, such as an HTTP request.

Property Value
Type	Description
`AttributeContextTypesRequest`

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.

Property Value
Type	Description
`AttributeContextTypesResource`

Response

public AttributeContext.Types.Response Response { get; set; }

Represents a network response, such as an HTTP response.

Property Value
Type	Description
`AttributeContextTypesResponse`

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.

Property Value
Type	Description
`AttributeContextTypesPeer`

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
`int`	The number of bytes required to write this message to a coded output stream.

Clone()

public AttributeContext Clone()

Creates a deep clone of this object.

Returns
Type	Description
`AttributeContext`	A deep clone of this object.

Equals(AttributeContext)

public bool Equals(AttributeContext other)

Parameter
Name	Description
`other`	`AttributeContext`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
`input`	`CodedInputStream`

Remarks

See the user guide for precise merge semantics.

MergeFrom(AttributeContext)

public void MergeFrom(AttributeContext other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`AttributeContext`

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
`output`	`CodedOutputStream` Coded output stream to write the data to. Must not be null.