Reference documentation and code samples for the Google API Common Protos Client class Property.
Defines project properties.
API services can define properties that can be assigned to consumer projects so that backends can perform response customization without having to make additional calls or maintain additional storage. For example, Maps API defines properties that controls map tile cache period, or whether to embed a watermark in a result. These values can be set via API producer console. Only API providers can define and set these properties.
Generated from protobuf message google.api.Property
Namespace
Google \ ApiMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the property (a.k.a key). |
↳ type |
int
The type of this property. |
↳ description |
string
The description of the property |
getName
The name of the property (a.k.a key).
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
The name of the property (a.k.a key).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getType
The type of this property.
| Returns | |
|---|---|
| Type | Description |
int |
|
setType
The type of this property.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
The description of the property
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
The description of the property
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|