Google API Common Protos Client - Class SystemParameter (4.8.1)

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

Define a parameter's name and location. The parameter may be passed as either an HTTP header or a URL query parameter, and if both are passed the behavior is implementation-dependent.

Generated from protobuf message google.api.SystemParameter

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Define the name of the parameter, such as "api_key" . It is case sensitive.

↳ http_header string

Define the HTTP header name to use for the parameter. It is case insensitive.

↳ url_query_parameter string

Define the URL query parameter name to use for the parameter. It is case sensitive.

getName

Define the name of the parameter, such as "api_key" . It is case sensitive.

Returns
Type Description
string

setName

Define the name of the parameter, such as "api_key" . It is case sensitive.

Parameter
Name Description
var string
Returns
Type Description
$this

getHttpHeader

Define the HTTP header name to use for the parameter. It is case insensitive.

Returns
Type Description
string

setHttpHeader

Define the HTTP header name to use for the parameter. It is case insensitive.

Parameter
Name Description
var string
Returns
Type Description
$this

getUrlQueryParameter

Define the URL query parameter name to use for the parameter. It is case sensitive.

Returns
Type Description
string

setUrlQueryParameter

Define the URL query parameter name to use for the parameter. It is case sensitive.

Parameter
Name Description
var string
Returns
Type Description
$this