Class Property

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
System.Object
Property
Implements
System.IEquatable<Property>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Google.Api
Assembly: Google.Api.CommonProtos.dll
Syntax
public sealed class Property : IMessage<Property>, IMessage, IEquatable<Property>, IDeepCloneable<Property>

Constructors

Property()

Declaration
public Property()

Property(Property)

Declaration
public Property(Property other)
Parameters
Type Name Description
Property other

Fields

DescriptionFieldNumber

Field number for the "description" field.

Declaration
public const int DescriptionFieldNumber = 3
Field Value
Type Description
System.Int32

NameFieldNumber

Field number for the "name" field.

Declaration
public const int NameFieldNumber = 1
Field Value
Type Description
System.Int32

TypeFieldNumber

Field number for the "type" field.

Declaration
public const int TypeFieldNumber = 2
Field Value
Type Description
System.Int32

Properties

Description

The description of the property

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

Descriptor

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

Name

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

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

Parser

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

Type

The type of this property.

Declaration
public Property.Types.PropertyType Type { get; set; }
Property Value
Type Description
Property.Types.PropertyType

Methods

CalculateSize()

Declaration
public int CalculateSize()
Returns
Type Description
System.Int32
Implements

Clone()

Declaration
public Property Clone()
Returns
Type Description
Property
Implements

Equals(Property)

Declaration
public bool Equals(Property other)
Parameters
Type Name Description
Property other
Returns
Type Description
System.Boolean
Implements
System.IEquatable<T>.Equals(T)

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

MergeFrom(Property)

Declaration
public void MergeFrom(Property other)
Parameters
Type Name Description
Property other
Implements

MergeFrom(CodedInputStream)

Declaration
public void MergeFrom(CodedInputStream input)
Parameters
Type Name Description
CodedInputStream input
Implements

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

WriteTo(CodedOutputStream)

Declaration
public void WriteTo(CodedOutputStream output)
Parameters
Type Name Description
CodedOutputStream output
Implements

Explicit Interface Implementations

IMessage.Descriptor

Declaration
MessageDescriptor IMessage.Descriptor { get; }
Returns
Type Description
MessageDescriptor
Implements