1. class
  2. Google
  3. \
  4. Api
  5. \
  6. SystemParameter

SystemParameter

class SystemParameter extends Message

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

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

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

$this
setName(string $var)

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

string
getHttpHeader()

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

$this
setHttpHeader(string $var)

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

string
getUrlQueryParameter()

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

$this
setUrlQueryParameter(string $var)

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

Details

at line 57
__construct(array $data = NULL)

Constructor.

Parameters

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

@type string $name
      Define the name of the parameter, such as "api_key" . It is case sensitive.
@type string $http_header
      Define the HTTP header name to use for the parameter. It is case
      insensitive.
@type string $url_query_parameter
      Define the URL query parameter name to use for the parameter. It is case
      sensitive.

}

at line 68
string getName()

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

Generated from protobuf field string name = 1;

Return Value

string

at line 80
$this setName(string $var)

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

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 95
string getHttpHeader()

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

Generated from protobuf field string http_header = 2;

Return Value

string

at line 108
$this setHttpHeader(string $var)

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

Generated from protobuf field string http_header = 2;

Parameters

string $var

Return Value

$this

at line 123
string getUrlQueryParameter()

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

Generated from protobuf field string url_query_parameter = 3;

Return Value

string

at line 136
$this setUrlQueryParameter(string $var)

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

Generated from protobuf field string url_query_parameter = 3;

Parameters

string $var

Return Value

$this