Google API Common Protos Client - Class ConfigChange (4.8.3)

Reference documentation and code samples for the Google API Common Protos Client class ConfigChange.

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

Namespace

Google \ Api

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ element
string

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]

↳ old_value
string

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

↳ new_value
string

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

↳ change_type
int

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

↳ advices
array< Advice >

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

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]
Returns
Type
Description
string

setElement

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]
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOldValue

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

Returns
Type
Description
string

setOldValue

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getNewValue

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

Returns
Type
Description
string

setNewValue

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getChangeType

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

Returns
Type
Description
int

setChangeType

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getAdvices

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

Returns
Type
Description

setAdvices

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

Parameter
Name
Description
var
array< Advice >
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: