PHPFUI/InstaDoc
 
Copied!

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.

Generated from protobuf message google.api.ConfigChange

CloneableInstantiable
Methods
public __construct( $data = NULL)
 

Constructor.

  • param array $data { Optional. Data for populating the Message object. 
    @type string $element
      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]
@type string $old_value
      Value of the changed object in the old Service configuration,
      in JSON format. This field will not be populated if ChangeType == ADDED.
@type string $new_value
      Value of the changed object in the new Service configuration,
      in JSON format. This field will not be populated if ChangeType == REMOVED.
@type int $change_type
      The type for this change, either ADDED, REMOVED, or MODIFIED.
@type array<\Google\Api\Advice>|\Google\Protobuf\Internal\RepeatedField $advices
      Collection of advice provided for this change, useful for determining the
      possible impact of this change.
    }
public Google\Protobuf\Internal\Message::__debugInfo()
public Google\Protobuf\Internal\Message::byteSize()
 
  • ignore
public Google\Protobuf\Internal\Message::clear()
 

Clear all containing fields.

  • return null
public Google\Protobuf\Internal\Message::discardUnknownFields()
 

Clear all unknown fields previously parsed.

  • return null
public getAdvices()
 

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

Generated from protobuf field repeated .google.api.Advice advices = 5;

  • return \Google\Protobuf\Internal\RepeatedField
public getChangeType()
 

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

Generated from protobuf field .google.api.ChangeType change_type = 4;

  • return int
public getElement()
 

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]

Generated from protobuf field string element = 1;

  • return string
public getNewValue()
 

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

Generated from protobuf field string new_value = 3;

  • return string
public getOldValue()
 

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

Generated from protobuf field string old_value = 2;

  • return string
public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)
 
  • ignore
public Google\Protobuf\Internal\Message::mergeFrom( $msg)
 

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

  • param object $msg Protobuf message to be merged from.
  • return null
public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)
 

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Json protobuf data.
  • param bool $ignore_unknown
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::mergeFromString( $data)
 

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

  • param string $data Binary protobuf data.
  • return null
  • throws \Exception Invalid data.
public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)
 
  • ignore
public Google\Protobuf\Internal\Message::parseFromStream( $input)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)
 

Serialize the message to json string.

  • return string Serialized json protobuf data.
public Google\Protobuf\Internal\Message::serializeToStream( $output)
 
  • ignore
public Google\Protobuf\Internal\Message::serializeToString()
 

Serialize the message to string.

  • return string Serialized binary protobuf data.
public setAdvices( $var)
 

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

Generated from protobuf field repeated .google.api.Advice advices = 5;

  • param \Google\Api\Advice[]|\Google\Protobuf\Internal\RepeatedField $var
  • return $this
public setChangeType( $var)
 

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

Generated from protobuf field .google.api.ChangeType change_type = 4;

  • param int $var
  • return $this
public setElement( $var)
 

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]

Generated from protobuf field string element = 1;

  • param string $var
  • return $this
public setNewValue( $var)
 

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

Generated from protobuf field string new_value = 3;

  • param string $var
  • return $this
public setOldValue( $var)
 

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

Generated from protobuf field string old_value = 2;

  • param string $var
  • return $this
Properties
protected $change_type = 0
 

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

Generated from protobuf field .google.api.ChangeType change_type = 4;

protected $element = ''
 

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]

Generated from protobuf field string element = 1;

protected $new_value = ''
 

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

Generated from protobuf field string new_value = 3;

protected $old_value = ''
 

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

Generated from protobuf field string old_value = 2;

Methods
protected Google\Protobuf\Internal\Message::hasOneof( $number)
protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
 

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

  • param array $array An array containing message properties and values.
  • return null
protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)
protected Google\Protobuf\Internal\Message::readOneof( $number)
protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
Properties
private $advices = NULL
 

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

Generated from protobuf field repeated .google.api.Advice advices = 5;

© 2025 Bruce Wells
Search Namespaces \ Classes
Configuration