1. class
  2. Google
  3. \
  4. Api
  5. \
  6. ConfigChange

ConfigChange

class ConfigChange extends Message

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

Methods

__construct(array $data = NULL)

Constructor.

string
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.

$this
setElement(string $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.

string
getOldValue()

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

$this
setOldValue(string $var)

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

string
getNewValue()

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

$this
setNewValue(string $var)

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

int
getChangeType()

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

$this
setChangeType(int $var)

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

RepeatedField
getAdvices()

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

$this
setAdvices(Advice[]|RepeatedField $var)

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

Details

at line 93
__construct(array $data = NULL)

Constructor.

Parameters

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.CreateBook"].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 \Google\Api\Advice[]|\Google\Protobuf\Internal\RepeatedField $advices
      Collection of advice provided for this change, useful for determining the
      possible impact of this change.

}

at line 112
string 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.CreateBook"].restriction - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value - logging.producer_destinations[0]

Generated from protobuf field string element = 1;

Return Value

string

at line 132
$this setElement(string $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.CreateBook"].restriction - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value - logging.producer_destinations[0]

Generated from protobuf field string element = 1;

Parameters

string $var

Return Value

$this

at line 147
string 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 Value

string

at line 160
$this setOldValue(string $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;

Parameters

string $var

Return Value

$this

at line 175
string 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 Value

string

at line 188
$this setNewValue(string $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;

Parameters

string $var

Return Value

$this

at line 202
int getChangeType()

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

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

Return Value

int

at line 214
$this setChangeType(int $var)

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

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

Parameters

int $var

Return Value

$this

at line 229
RepeatedField 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 Value

RepeatedField

at line 242
$this setAdvices(Advice[]|RepeatedField $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;

Parameters

Advice[]|RepeatedField $var

Return Value

$this