Class Property (2.17.0) 

public sealed class Property : IMessage<Property>, IEquatable<Property>, IDeepCloneable<Property>, IBufferMessage, IMessage

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.

Inheritance

object > Property

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Property()

public Property()

Property(Property)

public Property(Property other)
Parameter
Name Description
other Property

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
Type Description
int

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
Type Description
int

TypeFieldNumber

public const int TypeFieldNumber = 2

Field number for the "type" field.

Field Value
Type Description
int

Properties

Description

public string Description { get; set; }

The description of the property

Property Value
Type Description
string

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
Type Description
MessageDescriptor

Name

public string Name { get; set; }

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

Property Value
Type Description
string

Parser

public static MessageParser<Property> Parser { get; }
Property Value
Type Description
MessageParserProperty

Type

public Property.Types.PropertyType Type { get; set; }

The type of this property.

Property Value
Type Description
PropertyTypesPropertyType

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
int

Clone()

public Property Clone()
Returns
Type Description
Property

Equals(Property)

public bool Equals(Property other)
Parameter
Name Description
other Property
Returns
Type Description
bool

Equals(object)

public override bool Equals(object other)
Parameter
Name Description
other object
Returns
Type Description
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
Type Description
int
Overrides

MergeFrom(Property)

public void MergeFrom(Property other)
Parameter
Name Description
other Property

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream