Package diag implements diagnostic functionality, which is a practitioner feedback mechanism for providers. It is designed for display in Terraform user interfaces, rather than logging based feedback, which is generally saved to a file for later inspection and troubleshooting.
Practitioner feedback for provider defined functions is provided by the [function.FuncError] type, rather than the diag.Diagnostic type.
This section is empty.
This section is empty.
This section is empty.
Diagnostic is an interface for providing enhanced feedback.
These are typically practitioner facing, however it is possible for functionality, such as validation, to use these to change behaviors or otherwise have these be manipulated or removed before being presented.
See the ErrorDiagnostic and WarningDiagnostic concrete types for generic implementations.
To add path information to an existing diagnostic, see the WithPath() function.
DiagnosticWithPath is a diagnostic associated with an attribute path.
This attribute information is used to display contextual source configuration to practitioners.
NewAttributeErrorDiagnostic returns a new error severity diagnostic with the given summary, detail, and path.
NewAttributeWarningDiagnostic returns a new warning severity diagnostic with the given summary, detail, and path.
WithPath wraps a diagnostic with path information or overwrites the path.
Diagnostics represents a collection of diagnostics.
While this collection is ordered, the order is not guaranteed as reliable or consistent.
AddAttributeError adds a generic attribute error diagnostic to the collection.
AddAttributeWarning adds a generic attribute warning diagnostic to the collection.
AddError adds a generic error diagnostic to the collection.
AddWarning adds a generic warning diagnostic to the collection.
Append adds non-empty and non-duplicate diagnostics to the collection.
Contains returns true if the collection contains an equal Diagnostic.
Equal returns true if all given diagnostics are equivalent in order and content, based on the underlying (Diagnostic).Equal() method of each.
Errors returns all the Diagnostic in Diagnostics that are SeverityError.
ErrorsCount returns the number of Diagnostic in Diagnostics that are SeverityError.
HasError returns true if the collection has an error severity Diagnostic.
Warnings returns all the Diagnostic in Diagnostics that are SeverityWarning.
WarningsCount returns the number of Diagnostic in Diagnostics that are SeverityWarning.
type ErrorDiagnostic struct {
}
ErrorDiagnostic is a generic diagnostic with error severity.
NewErrorDiagnostic returns a new error severity diagnostic with the given summary and detail.
Detail returns the diagnostic detail.
Equal returns true if the other diagnostic is wholly equivalent.
Severity returns the diagnostic severity.
Summary returns the diagnostic summary.
Severity represents the level of feedback for a diagnostic.
Each severity implies behavior changes for the feedback and potentially the further execution of logic.
String returns a textual representation of the severity.
type WarningDiagnostic struct {
}
WarningDiagnostic is a generic diagnostic with warning severity.
NewErrorDiagnostic returns a new warning severity diagnostic with the given summary and detail.
Detail returns the diagnostic detail.
Equal returns true if the other diagnostic is wholly equivalent.
Severity returns the diagnostic severity.
Summary returns the diagnostic summary.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4