Class Property (2.2.0)

public sealed class Property : Protobuf.IMessage<Property>, Protobuf.IBufferMessage

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
NameDescription
otherProperty

Fields

DescriptionFieldNumber

public const int DescriptionFieldNumber = 3

Field number for the "description" field.

Field Value
TypeDescription
Int32

NameFieldNumber

public const int NameFieldNumber = 1

Field number for the "name" field.

Field Value
TypeDescription
Int32

TypeFieldNumber

public const int TypeFieldNumber = 2

Field number for the "type" field.

Field Value
TypeDescription
Int32

Properties

Description

public string Description { get; set; }

The description of the property

Property Value
TypeDescription
String

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
Protobuf.Reflection.MessageDescriptor

Name

public string Name { get; set; }

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

Property Value
TypeDescription
String

Parser

public static Protobuf.MessageParser<Property> Parser { get; }
Property Value
TypeDescription
Protobuf.MessageParser<Property>

Type

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

The type of this property.

Property Value
TypeDescription
Property.Types.PropertyType

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
Int32

Clone()

public Property Clone()
Returns
TypeDescription
Property

Equals(Property)

public bool Equals(Property other)
Parameter
NameDescription
otherProperty
Returns
TypeDescription
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
NameDescription
otherObject
Returns
TypeDescription
Boolean

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
Int32

MergeFrom(Property)

public void MergeFrom(Property other)
Parameter
NameDescription
otherProperty

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
NameDescription
inputProtobuf.CodedInputStream

ToString()

public override string ToString()
Returns
TypeDescription
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
NameDescription
outputProtobuf.CodedOutputStream