configchange

Documentation

Overview

Package configchange is a generated protocol buffer package.

It is generated from these files:

google/api/config_change.proto

It has these top-level messages:

ConfigChange
Advice

Index

• Variables
• type Advice
  • func (*Advice) Descriptor() ([]byte, []int)
  • func (m *Advice) GetDescription() string
  • func (*Advice) ProtoMessage()
  • func (m *Advice) Reset()
  • func (m *Advice) String() string
• type ChangeType
  • func (ChangeType) EnumDescriptor() ([]byte, []int)
  • func (x ChangeType) String() string
• type ConfigChange
  • func (*ConfigChange) Descriptor() ([]byte, []int)
  • func (m *ConfigChange) GetAdvices() []*Advice
  • func (m *ConfigChange) GetChangeType() ChangeType
  • func (m *ConfigChange) GetElement() string
  • func (m *ConfigChange) GetNewValue() string
  • func (m *ConfigChange) GetOldValue() string
  • func (*ConfigChange) ProtoMessage()
  • func (m *ConfigChange) Reset()
  • func (m *ConfigChange) String() string

Variables

var ChangeType_name = map[int32]string{
	0: "CHANGE_TYPE_UNSPECIFIED",
	1: "ADDED",
	2: "REMOVED",
	3: "MODIFIED",
}

var ChangeType_value = map[string]int32{
	"CHANGE_TYPE_UNSPECIFIED": 0,
	"ADDED":                   1,
	"REMOVED":                 2,
	"MODIFIED":                3,
}

Types

type Advice

type Advice struct {
	// Useful description for why this advice was applied and what actions should
	// be taken to mitigate any implied risks.
	Description string `protobuf:"bytes,2,opt,name=description" json:"description,omitempty"`
}

Generated advice about this change, used for providing more information about how a change will affect the existing service.

func (*Advice) Descriptor

func (*Advice) Descriptor() ([]byte, []int)

func (*Advice) GetDescription

func (m *Advice) GetDescription() string

func (*Advice) ProtoMessage

func (*Advice) ProtoMessage()

func (*Advice) Reset

func (m *Advice) Reset()

func (*Advice) String

func (m *Advice) String() string

type ChangeType

type ChangeType int32

Classifies set of possible modifications to an object in the service configuration.

const (
	// No value was provided.
	ChangeType_CHANGE_TYPE_UNSPECIFIED ChangeType = 0
	// The changed object exists in the 'new' service configuration, but not
	// in the 'old' service configuration.
	ChangeType_ADDED ChangeType = 1
	// The changed object exists in the 'old' service configuration, but not
	// in the 'new' service configuration.
	ChangeType_REMOVED ChangeType = 2
	// The changed object exists in both service configurations, but its value
	// is different.
	ChangeType_MODIFIED ChangeType = 3
)

func (ChangeType) EnumDescriptor

func (ChangeType) EnumDescriptor() ([]byte, []int)

func (ChangeType) String

func (x ChangeType) String() string

type ConfigChange

type ConfigChange struct {
	// 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]
	Element string `protobuf:"bytes,1,opt,name=element" json:"element,omitempty"`
	// Value of the changed object in the old Service configuration,
	// in JSON format. This field will not be populated if ChangeType == ADDED.
	OldValue string `protobuf:"bytes,2,opt,name=old_value,json=oldValue" json:"old_value,omitempty"`
	// Value of the changed object in the new Service configuration,
	// in JSON format. This field will not be populated if ChangeType == REMOVED.
	NewValue string `protobuf:"bytes,3,opt,name=new_value,json=newValue" json:"new_value,omitempty"`
	// The type for this change, either ADDED, REMOVED, or MODIFIED.
	ChangeType ChangeType `protobuf:"varint,4,opt,name=change_type,json=changeType,enum=google.api.ChangeType" json:"change_type,omitempty"`
	// Collection of advice provided for this change, useful for determining the
	// possible impact of this change.
	Advices []*Advice `protobuf:"bytes,5,rep,name=advices" json:"advices,omitempty"`
}

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.

func (*ConfigChange) Descriptor

func (*ConfigChange) Descriptor() ([]byte, []int)

func (*ConfigChange) GetAdvices

func (m *ConfigChange) GetAdvices() []*Advice

func (*ConfigChange) GetChangeType

func (m *ConfigChange) GetChangeType() ChangeType

func (*ConfigChange) GetElement

func (m *ConfigChange) GetElement() string

func (*ConfigChange) GetNewValue

func (m *ConfigChange) GetNewValue() string

func (*ConfigChange) GetOldValue

func (m *ConfigChange) GetOldValue() string

func (*ConfigChange) ProtoMessage

func (*ConfigChange) ProtoMessage()

func (*ConfigChange) Reset

func (m *ConfigChange) Reset()

func (*ConfigChange) String

func (m *ConfigChange) String() string