validators

Documentation

Overview

Package validators contains general purpose validation functions for the Redpanda provider.

Index

• func CloudProviders() []validator.String
• func ClusterTypes() []validator.String
• func ConnectionTypes() []validator.String
• type AlsoRequiresOneOfValidator
  • func AlsoRequiresOneOf(expressions ...path.Expression) AlsoRequiresOneOfValidator
  • func (v AlsoRequiresOneOfValidator) Description(ctx context.Context) string
  • func (v AlsoRequiresOneOfValidator) MarkdownDescription(_ context.Context) string
  • func (v AlsoRequiresOneOfValidator) ValidateString(ctx context.Context, req validator.StringRequest, ...)
• type CloudProviderDependentValidator
  • func (v CloudProviderDependentValidator) Description(_ context.Context) string
  • func (v CloudProviderDependentValidator) MarkdownDescription(_ context.Context) string
  • func (v CloudProviderDependentValidator) ValidateObject(ctx context.Context, req validator.ObjectRequest, ...)
• type NotUnknownValidator
  • func NotUnknown() NotUnknownValidator
  • func (v NotUnknownValidator) Description(ctx context.Context) string
  • func (NotUnknownValidator) MarkdownDescription(_ context.Context) string
  • func (NotUnknownValidator) ValidateString(_ context.Context, req validator.StringRequest, resp *validator.StringResponse)

Functions

func CloudProviders

func CloudProviders() []validator.String

CloudProviders returns a list of cloud providers that the Redpanda provider supports.

func ClusterTypes

func ClusterTypes() []validator.String

ClusterTypes returns a list of cluster types that the Redpanda provider supports.

func ConnectionTypes

func ConnectionTypes() []validator.String

ConnectionTypes returns a list of connection types that the Redpanda provider supports.

Types

type AlsoRequiresOneOfValidator

type AlsoRequiresOneOfValidator struct {
	Expressions []path.Expression
}

AlsoRequiresOneOfValidator checks that at least one of a set of path.Expression has a non-null value, if the current attribute also has a non-null value.

func AlsoRequiresOneOf

func AlsoRequiresOneOf(expressions ...path.Expression) AlsoRequiresOneOfValidator

AlsoRequiresOneOf returns an AlsoRequiresOneOfValidator

func (AlsoRequiresOneOfValidator) Description

func (v AlsoRequiresOneOfValidator) Description(ctx context.Context) string

Description provides a description of the validator

func (AlsoRequiresOneOfValidator) MarkdownDescription

func (v AlsoRequiresOneOfValidator) MarkdownDescription(_ context.Context) string

MarkdownDescription provides a description of the validator in markdown format

func (AlsoRequiresOneOfValidator) ValidateString

func (v AlsoRequiresOneOfValidator) ValidateString(ctx context.Context, req validator.StringRequest, resp *validator.StringResponse)

ValidateString validates a string

type CloudProviderDependentValidator

type CloudProviderDependentValidator struct {
	AttributeName string
	CloudProvider string
}

CloudProviderDependentValidator is a custom validator to ensure that an attribute is only set when cloud_provider is a specific value For example when using this on aws_private_link it will ensure that the HCL fails validation unless cloud_provider is set to "aws" AttributeName should be the name of the attribute that is being validated CloudProvider should be the value of cloud_provider that the attribute is dependent on

func (CloudProviderDependentValidator) Description

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

Description provides a description of the validator

func (CloudProviderDependentValidator) MarkdownDescription

func (v CloudProviderDependentValidator) MarkdownDescription(_ context.Context) string

MarkdownDescription provides a description of the validator in markdown format

func (CloudProviderDependentValidator) ValidateObject

func (v CloudProviderDependentValidator) ValidateObject(ctx context.Context, req validator.ObjectRequest, resp *validator.ObjectResponse)

ValidateObject validates an object

type NotUnknownValidator

type NotUnknownValidator struct{}

NotUnknownValidator is a custom validator to ensure that an attribute is not unknown at the validation stage.

func NotUnknown

func NotUnknown() NotUnknownValidator

NotUnknown returns a NotUnknownValidator

func (NotUnknownValidator) Description

func (v NotUnknownValidator) Description(ctx context.Context) string

Description provides a description of the validator

func (NotUnknownValidator) MarkdownDescription

func (NotUnknownValidator) MarkdownDescription(_ context.Context) string

MarkdownDescription provides a description of the validator in markdown format

func (NotUnknownValidator) ValidateString

func (NotUnknownValidator) ValidateString(_ context.Context, req validator.StringRequest, resp *validator.StringResponse)

ValidateString validates a string