Documentation

Http extends Message
in package

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

Generated from protobuf message google.api.Http

Table of Contents

Properties

$fully_decode_reserved_expansion  : mixed
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.
$rules  : mixed
A list of HTTP configuration rules that apply to individual API methods.

Methods

__construct()  : mixed
Constructor.
getFullyDecodeReservedExpansion()  : 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.
getRules()  : RepeatedField
A list of HTTP configuration rules that apply to individual API methods.
setFullyDecodeReservedExpansion()  : $this
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.
setRules()  : $this
A list of HTTP configuration rules that apply to individual API methods.

Properties

$fully_decode_reserved_expansion

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.

protected mixed $fully_decode_reserved_expansion = false

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

Generated from protobuf field bool fully_decode_reserved_expansion = 2;

$rules

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

private mixed $rules

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

Generated from protobuf field repeated .google.api.HttpRule rules = 1;

Methods

__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\Api\HttpRule[]|\Google\Protobuf\Internal\RepeatedField $rules
      A list of HTTP configuration rules that apply to individual API methods.
      **NOTE:** All service configuration rules follow "last one wins" order.
@type bool $fully_decode_reserved_expansion
      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.

}

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.

public getFullyDecodeReservedExpansion() : bool

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

Generated from protobuf field bool fully_decode_reserved_expansion = 2;

Return values
bool

getRules()

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

public getRules() : RepeatedField

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

Generated from protobuf field repeated .google.api.HttpRule rules = 1;

Return values
RepeatedField

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.

public setFullyDecodeReservedExpansion(bool $var) : $this

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

Generated from protobuf field bool fully_decode_reserved_expansion = 2;

Parameters
$var : bool
Return values
$this

setRules()

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

public setRules(array<string|int, HttpRule>|RepeatedField $var) : $this

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

Generated from protobuf field repeated .google.api.HttpRule rules = 1;

Parameters
$var : array<string|int, HttpRule>|RepeatedField
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results