resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

helper/schema: Correct some comments 

Removed some outdated comments for SetNew, and normalized the computed
key note for SetNew, SetNewComputed, and SetDiff.
This commit is contained in:
Chris Marchesi 2017-05-30 21:50:31 -07:00 committed by Martin Atkins
parent 8a7c9a6f02
commit ad98471559
1 changed files with 2 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
helper/schema/resource_diff.go
View File

@ -260,10 +260,6 @@ func (d *ResourceDiff) diffChange(key string) (interface{}, interface{}, bool, b
// sets). The original value from the state is used as the old value.
//
// This function is only allowed on computed attributes.
//
// It is an unsupported operation to set invalid values with this function -
// doing so will taint any existing diff for this key and will remove it from
// the catalog.
func (d *ResourceDiff) SetNew(key string, value interface{}) error {
return d.SetDiff(key, d.get(strings.Split(key, "."), "state").Value, value, false)
}
@ -271,7 +267,7 @@ func (d *ResourceDiff) SetNew(key string, value interface{}) error {
// SetNewComputed functions like SetNew, except that it blanks out a new value
// and marks it as computed.
//
// This function is only allowed on computed keys.
// This function is only allowed on computed attributes.
func (d *ResourceDiff) SetNewComputed(key string) error {
return d.SetDiff(key, d.get(strings.Split(key, "."), "state").Value, nil, true)
}
@ -282,7 +278,7 @@ func (d *ResourceDiff) SetNewComputed(key string) error {
// ClearAll to construct a compleletely new diff based off of provider logic
// alone.
//
// This function is only allowed on computed keys.
// This function is only allowed on computed attributes.
func (d *ResourceDiff) SetDiff(key string, old, new interface{}, computed bool) error {
if !d.schema[key].Computed {
return fmt.Errorf("SetNew, SetNewComputed, and SetDiff are allowed on computed attributes only - %s is not one", key)