pulumi/pkg/resource/resource_state.go
joeduffy 35aa6b7559 Rename pulumi/lumi to pulumi/pulumi-fabric
We are renaming Lumi to Pulumi Fabric.  This change simply renames the
pulumi/lumi repo to pulumi/pulumi-fabric, without the CLI tools and other
changes that will follow soon afterwards.
2017-08-02 09:25:22 -07:00

57 lines
2.4 KiB
Go

// Copyright 2016-2017, Pulumi Corporation. All rights reserved.
package resource
import (
"github.com/pulumi/pulumi-fabric/pkg/tokens"
"github.com/pulumi/pulumi-fabric/pkg/util/contract"
)
// State is a structure containing state associated with a resource. This resource may have been serialized and
// deserialized, or snapshotted from a live graph of resource objects. The value's state is not, however, associated
// with any runtime objects in memory that may be actively involved in ongoing computations.
type State struct {
T tokens.Type // the resource's type.
U URN // the resource's object urn, a human-friendly, unique name for the resource.
ID ID // the resource's unique ID, assigned by the resource provider (or blank if uncreated).
Inputs PropertyMap // the resource's input properties (as specified by the program).
Defaults PropertyMap // the resource's default property values (if any, given by the provider).
Outputs PropertyMap // the resource's complete output state (as returned by the resource provider).
}
var _ Resource = (*State)(nil)
// NewState creates a new resource value from existing resource state information.
func NewState(t tokens.Type, urn URN, id ID, inputs PropertyMap, defaults PropertyMap, outputs PropertyMap) *State {
contract.Assert(t != "")
contract.Assert(inputs != nil)
return &State{
T: t,
U: urn,
ID: id,
Inputs: inputs,
Defaults: defaults,
Outputs: outputs,
}
}
func (s *State) Type() tokens.Type { return s.T }
func (s *State) URN() URN { return s.U }
// All returns all resource state, including the inputs, defaults, and outputs, overlaid in that order.
func (s *State) All() PropertyMap {
return s.AllInputs().Merge(s.Outputs)
}
// AllInputs returns just the resource state's inputs plus any defaults supplied by the provider. This is to be used
// when diffing resource states that are entirely under the control of the developer, instead of a cloud provider.
func (s *State) AllInputs() PropertyMap {
return s.Defaults.Merge(s.Inputs)
}
// Synthesized returns all of the resource's "synthesized" state; this includes all properties that appeared in the
// default and output set, which may or may not override some or all of those that appeared in the input set.
func (s *State) Synthesized() PropertyMap {
return s.Defaults.Merge(s.Outputs)
}