PHPFUI/InstaDoc

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

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { 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.

}

public Google\Protobuf\Internal\Message::__debugInfo()

public Google\Protobuf\Internal\Message::byteSize()

ignore

public Google\Protobuf\Internal\Message::clear()

Clear all containing fields.

return null

public clearApi()

public clearDestination()

public clearOrigin()

public clearRequest()

public clearResource()

public clearResponse()

public clearSource()

public Google\Protobuf\Internal\Message::discardUnknownFields()

Clear all unknown fields previously parsed.

return null

public getApi()

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

Generated from protobuf field .google.rpc.context.AttributeContext.Api api = 6;

return \Google\Rpc\Context\AttributeContext\Api|null

public 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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer destination = 2;

return \Google\Rpc\Context\AttributeContext\Peer|null

public getExtensions()

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

Generated from protobuf field repeated .google.protobuf.Any extensions = 8;

return \Google\Protobuf\Internal\RepeatedField

public 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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer origin = 7;

return \Google\Rpc\Context\AttributeContext\Peer|null

public getRequest()

Represents a network request, such as an HTTP request.

Generated from protobuf field .google.rpc.context.AttributeContext.Request request = 3;

return \Google\Rpc\Context\AttributeContext\Request|null

public 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.

Generated from protobuf field .google.rpc.context.AttributeContext.Resource resource = 5;

return \Google\Rpc\Context\AttributeContext\Resource|null

public getResponse()

Represents a network response, such as an HTTP response.

Generated from protobuf field .google.rpc.context.AttributeContext.Response response = 4;

return \Google\Rpc\Context\AttributeContext\Response|null

public 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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer source = 1;

return \Google\Rpc\Context\AttributeContext\Peer|null

public hasApi()

public hasDestination()

public hasOrigin()

public hasRequest()

public hasResource()

public hasResponse()

public hasSource()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

public Google\Protobuf\Internal\Message::parseFromStream( $input)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

Serialize the message to json string.

return string Serialized json protobuf data.

public Google\Protobuf\Internal\Message::serializeToStream( $output)

ignore

public Google\Protobuf\Internal\Message::serializeToString()

Serialize the message to string.

return string Serialized binary protobuf data.

public setApi( $var)

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

Generated from protobuf field .google.rpc.context.AttributeContext.Api api = 6;

param \Google\Rpc\Context\AttributeContext\Api $var
return $this

public setDestination( $var)

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer destination = 2;

param \Google\Rpc\Context\AttributeContext\Peer $var
return $this

public setExtensions( $var)

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

Generated from protobuf field repeated .google.protobuf.Any extensions = 8;

param \Google\Protobuf\Any[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

public setOrigin( $var)

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer origin = 7;

param \Google\Rpc\Context\AttributeContext\Peer $var
return $this

public setRequest( $var)

Represents a network request, such as an HTTP request.

Generated from protobuf field .google.rpc.context.AttributeContext.Request request = 3;

param \Google\Rpc\Context\AttributeContext\Request $var
return $this

public setResource( $var)

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Resource resource = 5;

param \Google\Rpc\Context\AttributeContext\Resource $var
return $this

public setResponse( $var)

Represents a network response, such as an HTTP response.

Generated from protobuf field .google.rpc.context.AttributeContext.Response response = 4;

param \Google\Rpc\Context\AttributeContext\Response $var
return $this

public setSource( $var)

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer source = 1;

param \Google\Rpc\Context\AttributeContext\Peer $var
return $this

Properties

protected $api = NULL

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

Generated from protobuf field .google.rpc.context.AttributeContext.Api api = 6;

protected $destination = NULL

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer destination = 2;

protected $origin = 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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer origin = 7;

protected $request = NULL

Represents a network request, such as an HTTP request.

Generated from protobuf field .google.rpc.context.AttributeContext.Request request = 3;

protected $resource = NULL

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Resource resource = 5;

protected $response = NULL

Represents a network response, such as an HTTP response.

Generated from protobuf field .google.rpc.context.AttributeContext.Response response = 4;

protected $source = NULL

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.

Generated from protobuf field .google.rpc.context.AttributeContext.Peer source = 1;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

protected Google\Protobuf\Internal\Message::readOneof( $number)

protected Google\Protobuf\Internal\Message::readWrapperValue( $member)

protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)

protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)

protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)

Properties

private $extensions = NULL

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

Generated from protobuf field repeated .google.protobuf.Any extensions = 8;