Google API Common Protos Client - Class Http (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class Http.

Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods.

Generated from protobuf message google.api.Http

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ rules array<Google\Api\HttpRule>

A list of HTTP configuration rules that apply to individual API methods. NOTE: All service configuration rules follow "last one wins" order.

↳ fully_decode_reserved_expansion bool

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

getRules

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRules

A list of HTTP configuration rules that apply to individual API methods.

NOTE: All service configuration rules follow "last one wins" order.

Parameter
Name Description
var array<Google\Api\HttpRule>
Returns
Type Description
$this

getFullyDecodeReservedExpansion

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.

The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Returns
Type Description
bool

setFullyDecodeReservedExpansion

When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded.

The default behavior is to not decode RFC 6570 reserved characters in multi segment matches.

Parameter
Name Description
var bool
Returns
Type Description
$this