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

Property

class Property extends Message

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.

Protobuf type Google\Api\Property

Methods

__construct()

No description

string
getName()

The name of the property (a.k.a key).

setName(string $var)

The name of the property (a.k.a key).

int
getType()

The type of this property.

setType(int $var)

The type of this property.

string
getDescription()

The description of the property

setDescription(string $var)

The description of the property

Details

at line 44
__construct()

at line 55
string getName()

The name of the property (a.k.a key).

Generated from protobuf field string name = 1;

Return Value

string

at line 66
setName(string $var)

The name of the property (a.k.a key).

Generated from protobuf field string name = 1;

Parameters

string $var

at line 78
int getType()

The type of this property.

Generated from protobuf field .google.api.Property.PropertyType type = 2;

Return Value

int

at line 89
setType(int $var)

The type of this property.

Generated from protobuf field .google.api.Property.PropertyType type = 2;

Parameters

int $var

at line 101
string getDescription()

The description of the property

Generated from protobuf field string description = 3;

Return Value

string

at line 112
setDescription(string $var)

The description of the property

Generated from protobuf field string description = 3;

Parameters

string $var