resource

package

v0.36.1-alpha Latest Latest Go to latest Published: Nov 21, 2025 License: MPL-2.0 Imports: 7 Imported by: 0

Documentation ¶

Index ¶

func MutuallyExclusiveAttributes(attributePaths []path.Path, attributeNames []string) resource.ConfigValidator
type MutuallyExclusiveAttributesValidator

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func MutuallyExclusiveAttributes ¶

func MutuallyExclusiveAttributes(attributePaths []path.Path, attributeNames []string) resource.ConfigValidator

MutuallyExclusiveAttributes returns a resource validator which ensures that only one of the specified attributes can be configured at a time.

Example usage:

func (r *MyResource) ConfigValidators(ctx context.Context) []resource.ConfigValidator {
    return []resource.ConfigValidator{
        resource_level.MutuallyExclusiveAttributes(
            []path.Path{
                path.Root("encoded_setting_xml"),
                path.Root("settings"),
            },
            []string{
                "encoded_setting_xml",
                "settings",
            },
        ),
    }
}

Types ¶

type MutuallyExclusiveAttributesValidator ¶

type MutuallyExclusiveAttributesValidator struct {
	AttributePaths []path.Path
	AttributeNames []string
}

MutuallyExclusiveAttributesValidator validates that only one of the specified attributes is configured

func (MutuallyExclusiveAttributesValidator) Description ¶

func (v MutuallyExclusiveAttributesValidator) Description(_ context.Context) string

Description describes the validation in plain text formatting.

func (MutuallyExclusiveAttributesValidator) MarkdownDescription ¶

func (v MutuallyExclusiveAttributesValidator) MarkdownDescription(ctx context.Context) string

MarkdownDescription describes the validation in Markdown formatting.

func (MutuallyExclusiveAttributesValidator) ValidateResource ¶

func (v MutuallyExclusiveAttributesValidator) ValidateResource(ctx context.Context, req resource.ValidateConfigRequest, resp *resource.ValidateConfigResponse)

ValidateResource performs the validation.

Source Files ¶

View all Source files

mutually_exclusive.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL