Class ConfigChange (2.15.0) 

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

Output generated from semantically comparing two versions of a service configuration.

Includes detailed information about a field that have changed with applicable advice about potential consequences for the change, such as backwards-incompatibility.

Inheritance

object > ConfigChange

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

ConfigChange()

public ConfigChange()

ConfigChange(ConfigChange)

public ConfigChange(ConfigChange other)
Parameter
Name Description
other ConfigChange

Fields

AdvicesFieldNumber

public const int AdvicesFieldNumber = 5

Field number for the "advices" field.

Field Value
Type Description
int

ChangeTypeFieldNumber

public const int ChangeTypeFieldNumber = 4

Field number for the "change_type" field.

Field Value
Type Description
int

ElementFieldNumber

public const int ElementFieldNumber = 1

Field number for the "element" field.

Field Value
Type Description
int

NewValueFieldNumber

public const int NewValueFieldNumber = 3

Field number for the "new_value" field.

Field Value
Type Description
int

OldValueFieldNumber

public const int OldValueFieldNumber = 2

Field number for the "old_value" field.

Field Value
Type Description
int

Properties

Advices

public RepeatedField<Advice> Advices { get; }

Collection of advice provided for this change, useful for determining the possible impact of this change.

Property Value
Type Description
RepeatedFieldAdvice

ChangeType

public ChangeType ChangeType { get; set; }

The type for this change, either ADDED, REMOVED, or MODIFIED.

Property Value
Type Description
ChangeType

Descriptor

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

Element

public string Element { get; set; }

Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector, name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used. Examples:

  • visibility.rules[selector=="google.LibraryService.ListBooks"].restriction
  • quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value
  • logging.producer_destinations[0]
Property Value
Type Description
string

NewValue

public string NewValue { get; set; }

Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED.

Property Value
Type Description
string

OldValue

public string OldValue { get; set; }

Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED.

Property Value
Type Description
string

Parser

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

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

Creates a deep clone of this object.

Returns
Type Description
ConfigChange

A deep clone of this object.

Equals(ConfigChange)

public bool Equals(ConfigChange other)
Parameter
Name Description
other ConfigChange
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(ConfigChange)

public void MergeFrom(ConfigChange other)

Merges the given message into this one.

Parameter
Name Description
other ConfigChange
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

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.