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.

Generated from protobuf message google.api.Property

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

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

$this
setName(string $var)

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

int
getType()

The type of this property.

$this
setType(int $var)

The type of this property.

string
getDescription()

The description of the property

$this
setDescription(string $var)

The description of the property

Details

at line 58
__construct(array $data = NULL)

Constructor.

Parameters

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

@type string $name
      The name of the property (a.k.a key).
@type int $type
      The type of this property.
@type string $description
      The description of the property

}

at line 69
string getName()

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

Generated from protobuf field string name = 1;

Return Value

string

at line 81
$this setName(string $var)

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

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 95
int getType()

The type of this property.

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

Return Value

int

at line 107
$this setType(int $var)

The type of this property.

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

Parameters

int $var

Return Value

$this

at line 121
string getDescription()

The description of the property

Generated from protobuf field string description = 3;

Return Value

string

at line 133
$this setDescription(string $var)

The description of the property

Generated from protobuf field string description = 3;

Parameters

string $var

Return Value

$this