Documentation

AttributeContext extends Message
in package

Application

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

Properties

$api : mixed: Represents an API operation that is involved to a network activity.
$destination : mixed: The destination of a network activity, such as accepting a TCP connection.
$origin : mixed: 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.
$request : mixed: Represents a network request, such as an HTTP request.
$resource : mixed: Represents a target resource that is involved with a network activity.
$response : mixed: Represents a network response, such as an HTTP response.
$source : mixed: The source of a network activity, such as starting a TCP connection.
$extensions : mixed: Supports extensions for advanced use cases, such as logs and metrics.

Methods

__construct() : mixed: Constructor.
clearApi() : mixed
clearDestination() : mixed
clearOrigin() : mixed
clearRequest() : mixed
clearResource() : mixed
clearResponse() : mixed
clearSource() : mixed
getApi() : Api|null: Represents an API operation that is involved to a network activity.
getDestination() : Peer|null: The destination of a network activity, such as accepting a TCP connection.
getExtensions() : RepeatedField: Supports extensions for advanced use cases, such as logs and metrics.
getOrigin() : Peer|null: 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.
getRequest() : Request|null: Represents a network request, such as an HTTP request.
getResource() : Resource|null: Represents a target resource that is involved with a network activity.
getResponse() : Response|null: Represents a network response, such as an HTTP response.
getSource() : Peer|null: The source of a network activity, such as starting a TCP connection.
hasApi() : mixed
hasDestination() : mixed
hasOrigin() : mixed
hasRequest() : mixed
hasResource() : mixed
hasResponse() : mixed
hasSource() : mixed
setApi() : $this: Represents an API operation that is involved to a network activity.
setDestination() : $this: The destination of a network activity, such as accepting a TCP connection.
setExtensions() : $this: Supports extensions for advanced use cases, such as logs and metrics.
setOrigin() : $this: 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.
setRequest() : $this: Represents a network request, such as an HTTP request.
setResource() : $this: Represents a target resource that is involved with a network activity.
setResponse() : $this: Represents a network response, such as an HTTP response.
setSource() : $this: The source of a network activity, such as starting a TCP connection.

$api

Represents an API operation that is involved to a network activity.


    protected
        mixed
    $api
     = null

Generated from protobuf field .google.rpc.context.AttributeContext.Api api = 6 [json_name = "api"];

$destination

The destination of a network activity, such as accepting a TCP connection.


    protected
        mixed
    $destination
     = null

In a multi hop network activity, the destination represents the receiver of the last hop.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer destination = 2 [json_name = "destination"];

$origin

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.


    protected
        mixed
    $origin
     = null

Generated from protobuf field .google.rpc.context.AttributeContext.Peer origin = 7 [json_name = "origin"];

$request

Represents a network request, such as an HTTP request.


    protected
        mixed
    $request
     = null

Generated from protobuf field .google.rpc.context.AttributeContext.Request request = 3 [json_name = "request"];

$resource

Represents a target resource that is involved with a network activity.


    protected
        mixed
    $resource
     = null

If multiple resources are involved with an activity, this must be the primary one.

Generated from protobuf field .google.rpc.context.AttributeContext.Resource resource = 5 [json_name = "resource"];

$response

Represents a network response, such as an HTTP response.


    protected
        mixed
    $response
     = null

Generated from protobuf field .google.rpc.context.AttributeContext.Response response = 4 [json_name = "response"];

$source

The source of a network activity, such as starting a TCP connection.


    protected
        mixed
    $source
     = null

In a multi hop network activity, the source represents the sender of the last hop.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer source = 1 [json_name = "source"];

$extensions

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


    private
        mixed
    $extensions

Generated from protobuf field repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];

__construct()

Constructor.


    public
                    __construct([array<string|int, mixed> $data = NULL ]) : mixed

Parameters

$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type \Google\Rpc\Context\AttributeContext\Peer $origin
      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.
@type \Google\Rpc\Context\AttributeContext\Peer $source
      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.
@type \Google\Rpc\Context\AttributeContext\Peer $destination
      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.
@type \Google\Rpc\Context\AttributeContext\Request $request
      Represents a network request, such as an HTTP request.
@type \Google\Rpc\Context\AttributeContext\Response $response
      Represents a network response, such as an HTTP response.
@type \Google\Rpc\Context\AttributeContext\Resource $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.
@type \Google\Rpc\Context\AttributeContext\Api $api
      Represents an API operation that is involved to a network activity.
@type array<\Google\Protobuf\Any>|\Google\Protobuf\Internal\RepeatedField $extensions
      Supports extensions for advanced use cases, such as logs and metrics.

}

clearApi()


    public
                    clearApi() : mixed

clearDestination()


    public
                    clearDestination() : mixed

clearOrigin()


    public
                    clearOrigin() : mixed

clearRequest()


    public
                    clearRequest() : mixed

clearResource()


    public
                    clearResource() : mixed

clearResponse()


    public
                    clearResponse() : mixed

clearSource()


    public
                    clearSource() : mixed

getApi()

Represents an API operation that is involved to a network activity.


    public
                    getApi() : Api|null

Generated from protobuf field .google.rpc.context.AttributeContext.Api api = 6 [json_name = "api"];

Return values

Api|null

getDestination()

The destination of a network activity, such as accepting a TCP connection.


    public
                    getDestination() : Peer|null

In a multi hop network activity, the destination represents the receiver of the last hop.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer destination = 2 [json_name = "destination"];

Return values

Peer|null

getExtensions()

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


    public
                    getExtensions() : RepeatedField

Generated from protobuf field repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];

Return values

RepeatedField

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.


    public
                    getOrigin() : Peer|null

Generated from protobuf field .google.rpc.context.AttributeContext.Peer origin = 7 [json_name = "origin"];

Return values

Peer|null

getRequest()

Represents a network request, such as an HTTP request.


    public
                    getRequest() : Request|null

Generated from protobuf field .google.rpc.context.AttributeContext.Request request = 3 [json_name = "request"];

Return values

Request|null

getResource()

Represents a target resource that is involved with a network activity.


    public
                    getResource() : Resource|null

If multiple resources are involved with an activity, this must be the primary one.

Generated from protobuf field .google.rpc.context.AttributeContext.Resource resource = 5 [json_name = "resource"];

Return values

Resource|null

getResponse()

Represents a network response, such as an HTTP response.


    public
                    getResponse() : Response|null

Generated from protobuf field .google.rpc.context.AttributeContext.Response response = 4 [json_name = "response"];

Return values

Response|null

getSource()

The source of a network activity, such as starting a TCP connection.


    public
                    getSource() : Peer|null

In a multi hop network activity, the source represents the sender of the last hop.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer source = 1 [json_name = "source"];

Return values

Peer|null

hasApi()


    public
                    hasApi() : mixed

hasDestination()


    public
                    hasDestination() : mixed

hasOrigin()


    public
                    hasOrigin() : mixed

hasRequest()


    public
                    hasRequest() : mixed

hasResource()


    public
                    hasResource() : mixed

hasResponse()


    public
                    hasResponse() : mixed

hasSource()


    public
                    hasSource() : mixed

setApi()

Represents an API operation that is involved to a network activity.


    public
                    setApi(Api $var) : $this

Generated from protobuf field .google.rpc.context.AttributeContext.Api api = 6 [json_name = "api"];

Parameters

$var : Api

Return values

$this

setDestination()

The destination of a network activity, such as accepting a TCP connection.


    public
                    setDestination(Peer $var) : $this

In a multi hop network activity, the destination represents the receiver of the last hop.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer destination = 2 [json_name = "destination"];

Parameters

$var : Peer

Return values

$this

setExtensions()

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


    public
                    setExtensions(array<string|int, Any>|RepeatedField $var) : $this

Generated from protobuf field repeated .google.protobuf.Any extensions = 8 [json_name = "extensions"];

Parameters

$var : array<string|int, Any>|RepeatedField

Return values

$this

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.


    public
                    setOrigin(Peer $var) : $this

Generated from protobuf field .google.rpc.context.AttributeContext.Peer origin = 7 [json_name = "origin"];

Parameters

$var : Peer

Return values

$this

setRequest()

Represents a network request, such as an HTTP request.


    public
                    setRequest(Request $var) : $this

Generated from protobuf field .google.rpc.context.AttributeContext.Request request = 3 [json_name = "request"];

Parameters

$var : Request

Return values

$this

setResource()

Represents a target resource that is involved with a network activity.


    public
                    setResource(Resource $var) : $this

If multiple resources are involved with an activity, this must be the primary one.

Generated from protobuf field .google.rpc.context.AttributeContext.Resource resource = 5 [json_name = "resource"];

Parameters

$var : Resource

Return values

$this

setResponse()

Represents a network response, such as an HTTP response.


    public
                    setResponse(Response $var) : $this

Generated from protobuf field .google.rpc.context.AttributeContext.Response response = 4 [json_name = "response"];

Parameters

$var : Response

Return values

$this

setSource()

The source of a network activity, such as starting a TCP connection.


    public
                    setSource(Peer $var) : $this

In a multi hop network activity, the source represents the sender of the last hop.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer source = 1 [json_name = "source"];

Parameters

$var : Peer

Return values

$this

AttributeContext extends Message in package Application

Table of Contents

Properties

Methods

Properties

$api

$destination

$origin

$request

$resource

$response

$source

$extensions

Methods

__construct()

Parameters

clearApi()

clearDestination()

clearOrigin()

clearRequest()

clearResource()

clearResponse()

clearSource()

getApi()

Return values

getDestination()

Return values

getExtensions()

Return values

getOrigin()

Return values

getRequest()

Return values

getResource()

Return values

getResponse()

Return values

getSource()

Return values

hasApi()

hasDestination()

hasOrigin()

hasRequest()

hasResource()

hasResponse()

hasSource()

setApi()

Parameters

Return values

setDestination()

Parameters

Return values

setExtensions()

Parameters

Return values

setOrigin()

Parameters

Return values

setRequest()

Parameters

Return values

setResource()

Parameters

Return values

setResponse()

Parameters

Return values

setSource()

Parameters

Return values

AttributeContext extends Message
in package

Application