Class Property (2.15.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

Implements

IMessage Property, IEquatable Property, IDeepCloneable Property, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

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()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
`int`	The number of bytes required to write this message to a coded output stream.

Clone()

public Property Clone()

Creates a deep clone of this object.

Returns
Type	Description
`Property`	A deep clone of this object.

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

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(Property)

public void MergeFrom(Property other)

Merges the given message into this one.

Parameter
Name	Description
`other`	`Property`

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
`input`	`CodedInputStream`

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
`output`	`CodedOutputStream` Coded output stream to write the data to. Must not be null.