pulumi/pkg/codegen/pcl/output.go

72 lines
2.2 KiB
Go

// Copyright 2016-2020, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package pcl
import (
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclsyntax"
"github.com/pulumi/pulumi/pkg/v3/codegen/hcl2/model"
)
// OutputVariable represents a program- or component-scoped output variable.
type OutputVariable struct {
node
syntax *hclsyntax.Block
typ model.Type
// The name visible to API calls related to the output. Used as the Name argument in stack output
// constructors (typically a method called "export"), and through those calls to
// RegisterResourceOutputs. Must not be modified during code generation to ensure that stack
// outputs are not renamed, breaking stack references.
logicalName string
// The definition of the output.
Definition *model.Block
// The value of the output.
Value model.Expression
}
// SyntaxNode returns the syntax node associated with the output variable.
func (ov *OutputVariable) SyntaxNode() hclsyntax.Node {
return ov.syntax
}
func (ov *OutputVariable) Traverse(traverser hcl.Traverser) (model.Traversable, hcl.Diagnostics) {
return ov.typ.Traverse(traverser)
}
func (ov *OutputVariable) VisitExpressions(pre, post model.ExpressionVisitor) hcl.Diagnostics {
return model.VisitExpressions(ov.Definition, pre, post)
}
func (ov *OutputVariable) Name() string {
return ov.Definition.Labels[0]
}
// Returns the ID of the output, if the output has an ID it is returned surrounded by double
// quotes, otherwise the defaultValue is returned as is.
func (ov *OutputVariable) LogicalName() string {
if ov.logicalName != "" {
return ov.logicalName
}
return ov.Name()
}
// Type returns the type of the output variable.
func (ov *OutputVariable) Type() model.Type {
return ov.typ
}