Class: Google::Api::ConfigChange

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/api/config_change.rb

Overview

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.

Instance Attribute Summary collapse

Instance Attribute Details

#advices ⇒ ::Array<::Google::Api::Advice>

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

Returns:

  • (::Array<::Google::Api::Advice>) —

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



54
55
56
57
 
# File 'proto_docs/google/api/config_change.rb', line 54

class ConfigChange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#change_type ⇒ ::Google::Api::ChangeType

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

Returns:



54
55
56
57
 
# File 'proto_docs/google/api/config_change.rb', line 54

class ConfigChange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#element ⇒ ::String

Returns 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:

  • (::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]


54
55
56
57
 
# File 'proto_docs/google/api/config_change.rb', line 54

class ConfigChange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#new_value ⇒ ::String

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

Returns:

  • (::String) —

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



54
55
56
57
 
# File 'proto_docs/google/api/config_change.rb', line 54

class ConfigChange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#old_value ⇒ ::String

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

Returns:

  • (::String) —

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



54
55
56
57
 
# File 'proto_docs/google/api/config_change.rb', line 54

class ConfigChange
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end