Reference documentation and code samples for the Google API Common Protos Client class AttributeContext.
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.
Generated from protobuf message google.rpc.context.AttributeContext
Namespace
Google \ Rpc \ ContextMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 the origin
must have the same content.
↳ 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.
↳ 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.
↳ request
↳ response
↳ 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.
↳ api
↳ extensions
getOrigin
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.
hasOrigin
clearOrigin
setOrigin
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.
$this
getSource
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.
hasSource
clearSource
setSource
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.
$this
getDestination
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.
hasDestination
clearDestination
setDestination
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.
$this
getRequest
Represents a network request, such as an HTTP request.
hasRequest
clearRequest
setRequest
Represents a network request, such as an HTTP request.
$this
getResponse
Represents a network response, such as an HTTP response.
hasResponse
clearResponse
setResponse
Represents a network response, such as an HTTP response.
$this
getResource
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.
hasResource
clearResource
setResource
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.
$this
getApi
Represents an API operation that is involved to a network activity.
hasApi
clearApi
setApi
Represents an API operation that is involved to a network activity.
$this
getExtensions
Supports extensions for advanced use cases, such as logs and metrics.
setExtensions
Supports extensions for advanced use cases, such as logs and metrics.
$this