PHPFUI/InstaDoc

This message defines attributes for a typical network response. It generally models semantics of an HTTP response.

Generated from protobuf message google.rpc.context.AttributeContext.Response

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

param array $data { Optional. Data for populating the Message object.

@type int|string $code
      The HTTP response status code, such as `200` and `404`.
@type int|string $size
      The HTTP response size in bytes. If unknown, it must be -1.
@type array|\Google\Protobuf\Internal\MapField $headers
      The HTTP response headers. If multiple headers share the same key, they
      must be merged according to HTTP spec. All header keys must be
      lowercased, because HTTP header keys are case-insensitive.
@type \Google\Protobuf\Timestamp $time
      The timestamp when the `destination` service sends the last byte of
      the response.
@type \Google\Protobuf\Duration $backend_latency
      The amount of time it takes the backend service to fully respond to a
      request. Measured from when the destination service starts to send the
      request to the backend until when the destination service receives the
      complete response from the backend.

}

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 clearBackendLatency()

public clearTime()

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

Clear all unknown fields previously parsed.

return null

public getBackendLatency()

The amount of time it takes the backend service to fully respond to a request. Measured from when the destination service starts to send the request to the backend until when the destination service receives the complete response from the backend.

Generated from protobuf field .google.protobuf.Duration backend_latency = 5;

return \Google\Protobuf\Duration|null

public getCode()

The HTTP response status code, such as 200 and 404.

Generated from protobuf field int64 code = 1;

return int|string

public getHeaders()

The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Generated from protobuf field map<string, string> headers = 3;

return \Google\Protobuf\Internal\MapField

public getSize()

The HTTP response size in bytes. If unknown, it must be -1.

Generated from protobuf field int64 size = 2;

return int|string

public getTime()

The timestamp when the destination service sends the last byte of the response.

Generated from protobuf field .google.protobuf.Timestamp time = 4;

return \Google\Protobuf\Timestamp|null

public hasBackendLatency()

public hasTime()

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 setBackendLatency( $var)

Generated from protobuf field .google.protobuf.Duration backend_latency = 5;

param \Google\Protobuf\Duration $var
return $this

public setCode( $var)

The HTTP response status code, such as 200 and 404.

Generated from protobuf field int64 code = 1;

param int|string $var
return $this

public setHeaders( $var)

The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Generated from protobuf field map<string, string> headers = 3;

param array|\Google\Protobuf\Internal\MapField $var
return $this

public setSize( $var)

The HTTP response size in bytes. If unknown, it must be -1.

Generated from protobuf field int64 size = 2;

param int|string $var
return $this

public setTime( $var)

The timestamp when the destination service sends the last byte of the response.

Generated from protobuf field .google.protobuf.Timestamp time = 4;

param \Google\Protobuf\Timestamp $var
return $this

Properties

protected $backend_latency = NULL

Generated from protobuf field .google.protobuf.Duration backend_latency = 5;

protected $code = 0

The HTTP response status code, such as 200 and 404.

Generated from protobuf field int64 code = 1;

protected $size = 0

The HTTP response size in bytes. If unknown, it must be -1.

Generated from protobuf field int64 size = 2;

protected $time = NULL

The timestamp when the destination service sends the last byte of the response.

Generated from protobuf field .google.protobuf.Timestamp time = 4;

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 $headers = NULL

The HTTP response headers. If multiple headers share the same key, they must be merged according to HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

Generated from protobuf field map<string, string> headers = 3;