configv1

Documentation

Index

• Variables
• type Parameter
  • func (*Parameter) Descriptor() ([]byte, []int)
  • func (x *Parameter) GetDefault() string
  • func (x *Parameter) GetDescription() string
  • func (x *Parameter) GetType() Parameter_Type
  • func (x *Parameter) GetValidations() []*Validation
  • func (*Parameter) ProtoMessage()
  • func (x *Parameter) ProtoReflect() protoreflect.Message
  • func (x *Parameter) Reset()
  • func (x *Parameter) String() string
• type Parameter_Type
  • func (Parameter_Type) Descriptor() protoreflect.EnumDescriptor
  • func (x Parameter_Type) Enum() *Parameter_Type
  • func (Parameter_Type) EnumDescriptor() ([]byte, []int)
  • func (x Parameter_Type) Number() protoreflect.EnumNumber
  • func (x Parameter_Type) String() string
  • func (Parameter_Type) Type() protoreflect.EnumType
• type Validation
  • func (*Validation) Descriptor() ([]byte, []int)
  • func (x *Validation) GetType() Validation_Type
  • func (x *Validation) GetValue() string
  • func (*Validation) ProtoMessage()
  • func (x *Validation) ProtoReflect() protoreflect.Message
  • func (x *Validation) Reset()
  • func (x *Validation) String() string
• type Validation_Type
  • func (Validation_Type) Descriptor() protoreflect.EnumDescriptor
  • func (x Validation_Type) Enum() *Validation_Type
  • func (Validation_Type) EnumDescriptor() ([]byte, []int)
  • func (x Validation_Type) Number() protoreflect.EnumNumber
  • func (x Validation_Type) String() string
  • func (Validation_Type) Type() protoreflect.EnumType

Variables

var (
	Parameter_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_STRING",
		2: "TYPE_INT",
		3: "TYPE_FLOAT",
		4: "TYPE_BOOL",
		5: "TYPE_FILE",
		6: "TYPE_DURATION",
	}
	Parameter_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"TYPE_STRING":      1,
		"TYPE_INT":         2,
		"TYPE_FLOAT":       3,
		"TYPE_BOOL":        4,
		"TYPE_FILE":        5,
		"TYPE_DURATION":    6,
	}
)

Enum value maps for Parameter_Type.

var (
	Validation_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "TYPE_REQUIRED",
		2: "TYPE_GREATER_THAN",
		3: "TYPE_LESS_THAN",
		4: "TYPE_INCLUSION",
		5: "TYPE_EXCLUSION",
		6: "TYPE_REGEX",
	}
	Validation_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":  0,
		"TYPE_REQUIRED":     1,
		"TYPE_GREATER_THAN": 2,
		"TYPE_LESS_THAN":    3,
		"TYPE_INCLUSION":    4,
		"TYPE_EXCLUSION":    5,
		"TYPE_REGEX":        6,
	}
)

Enum value maps for Validation_Type.

var File_config_v1_parameter_proto protoreflect.FileDescriptor

Types

type Parameter

type Parameter struct {

	// Default is the default value of the parameter. If there is no default
	// value use an empty string.
	Default string `protobuf:"bytes,1,opt,name=default,proto3" json:"default,omitempty"`
	// Description explains what the parameter does and how to configure it.
	Description string `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// Type defines the parameter data type.
	Type Parameter_Type `protobuf:"varint,3,opt,name=type,proto3,enum=config.v1.Parameter_Type" json:"type,omitempty"`
	// Validations are validations to be made on the parameter.
	Validations []*Validation `protobuf:"bytes,4,rep,name=validations,proto3" json:"validations,omitempty"`
	// contains filtered or unexported fields
}

Parameter describes a single config parameter.

func (*Parameter) Descriptor

func (*Parameter) Descriptor() ([]byte, []int)

Deprecated: Use Parameter.ProtoReflect.Descriptor instead.

func (*Parameter) GetDefault

func (x *Parameter) GetDefault() string

func (*Parameter) GetDescription

func (x *Parameter) GetDescription() string

func (*Parameter) GetType

func (x *Parameter) GetType() Parameter_Type

func (*Parameter) GetValidations

func (x *Parameter) GetValidations() []*Validation

func (*Parameter) ProtoMessage

func (*Parameter) ProtoMessage()

func (*Parameter) ProtoReflect

func (x *Parameter) ProtoReflect() protoreflect.Message

func (*Parameter) Reset

func (x *Parameter) Reset()

func (*Parameter) String

func (x *Parameter) String() string

type Parameter_Type

type Parameter_Type int32

Type shows the parameter type.

const (
	Parameter_TYPE_UNSPECIFIED Parameter_Type = 0
	// Parameter is a string.
	Parameter_TYPE_STRING Parameter_Type = 1
	// Parameter is an integer.
	Parameter_TYPE_INT Parameter_Type = 2
	// Parameter is a float.
	Parameter_TYPE_FLOAT Parameter_Type = 3
	// Parameter is a boolean.
	Parameter_TYPE_BOOL Parameter_Type = 4
	// Parameter is a file.
	Parameter_TYPE_FILE Parameter_Type = 5
	// Parameter is a duration.
	Parameter_TYPE_DURATION Parameter_Type = 6
)

func (Parameter_Type) Descriptor

func (Parameter_Type) Descriptor() protoreflect.EnumDescriptor

func (Parameter_Type) Enum

func (x Parameter_Type) Enum() *Parameter_Type

func (Parameter_Type) EnumDescriptor

func (Parameter_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Parameter_Type.Descriptor instead.

func (Parameter_Type) Number

func (x Parameter_Type) Number() protoreflect.EnumNumber

func (Parameter_Type) String

func (x Parameter_Type) String() string

func (Parameter_Type) Type

func (Parameter_Type) Type() protoreflect.EnumType

type Validation

type Validation struct {
	Type Validation_Type `protobuf:"varint,1,opt,name=type,proto3,enum=config.v1.Validation_Type" json:"type,omitempty"`
	// The value to be compared with the parameter,
	// or a comma separated list in case of Validation.TYPE_INCLUSION or Validation.TYPE_EXCLUSION.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Validation to be made on the parameter.

func (*Validation) Descriptor

func (*Validation) Descriptor() ([]byte, []int)

Deprecated: Use Validation.ProtoReflect.Descriptor instead.

func (*Validation) GetType

func (x *Validation) GetType() Validation_Type

func (*Validation) GetValue

func (x *Validation) GetValue() string

func (*Validation) ProtoMessage

func (*Validation) ProtoMessage()

func (*Validation) ProtoReflect

func (x *Validation) ProtoReflect() protoreflect.Message

func (*Validation) Reset

func (x *Validation) Reset()

func (*Validation) String

func (x *Validation) String() string

type Validation_Type

type Validation_Type int32

const (
	Validation_TYPE_UNSPECIFIED Validation_Type = 0
	// Parameter must be present.
	Validation_TYPE_REQUIRED Validation_Type = 1
	// Parameter must be greater than {value}.
	Validation_TYPE_GREATER_THAN Validation_Type = 2
	// Parameter must be less than {value}.
	Validation_TYPE_LESS_THAN Validation_Type = 3
	// Parameter must be included in the comma separated list {value}.
	Validation_TYPE_INCLUSION Validation_Type = 4
	// Parameter must not be included in the comma separated list {value}.
	Validation_TYPE_EXCLUSION Validation_Type = 5
	// Parameter must match the regex {value}.
	Validation_TYPE_REGEX Validation_Type = 6
)

func (Validation_Type) Descriptor

func (Validation_Type) Descriptor() protoreflect.EnumDescriptor

func (Validation_Type) Enum

func (x Validation_Type) Enum() *Validation_Type

func (Validation_Type) EnumDescriptor

func (Validation_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Validation_Type.Descriptor instead.

func (Validation_Type) Number

func (x Validation_Type) Number() protoreflect.EnumNumber

func (Validation_Type) String

func (x Validation_Type) String() string

func (Validation_Type) Type

func (Validation_Type) Type() protoreflect.EnumType