api

package
v6.64.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 6, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AnyAlias added in v6.8.0 

type AnyAlias interface{}

type AnyValue added in v6.6.0 

type AnyValue struct {
	Value interface{} `json:"value"`
}

func (AnyValue) MarshalYAML added in v6.6.0 

func (o AnyValue) MarshalYAML() (interface{}, error)

func (*AnyValue) UnmarshalYAML added in v6.6.0 

func (o *AnyValue) UnmarshalYAML(unmarshal func(interface{}) error) error

type Basic 

type Basic struct {
	/*
	   A docs string with
	   newline and "quotes".
	*/
	Data string `conjure-docs:"A docs string with\nnewline and \"quotes\"." json:"data"`
}

func (Basic) MarshalYAML 

func (o Basic) MarshalYAML() (interface{}, error)

func (*Basic) UnmarshalYAML 

func (o *Basic) UnmarshalYAML(unmarshal func(interface{}) error) error

type BinaryAlias 

type BinaryAlias []byte

func (BinaryAlias) MarshalText added in v6.6.0 

func (a BinaryAlias) MarshalText() ([]byte, error)

func (BinaryAlias) MarshalYAML added in v6.6.0 

func (a BinaryAlias) MarshalYAML() (interface{}, error)

func (BinaryAlias) String added in v6.6.0 

func (a BinaryAlias) String() string

func (*BinaryAlias) UnmarshalText added in v6.6.0 

func (a *BinaryAlias) UnmarshalText(data []byte) error

func (*BinaryAlias) UnmarshalYAML added in v6.6.0 

func (a *BinaryAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type BinaryMap 

type BinaryMap struct {
	Map map[binary.Binary][]byte `json:"map"`
}

func (BinaryMap) MarshalJSON 

func (o BinaryMap) MarshalJSON() ([]byte, error)

func (BinaryMap) MarshalYAML 

func (o BinaryMap) MarshalYAML() (interface{}, error)

func (*BinaryMap) UnmarshalJSON 

func (o *BinaryMap) UnmarshalJSON(data []byte) error

func (*BinaryMap) UnmarshalYAML 

func (o *BinaryMap) UnmarshalYAML(unmarshal func(interface{}) error) error

type BooleanIntegerMap 

type BooleanIntegerMap struct {
	Map map[boolean.Boolean]int `json:"map"`
}

func (BooleanIntegerMap) MarshalJSON 

func (o BooleanIntegerMap) MarshalJSON() ([]byte, error)

func (BooleanIntegerMap) MarshalYAML 

func (o BooleanIntegerMap) MarshalYAML() (interface{}, error)

func (*BooleanIntegerMap) UnmarshalJSON 

func (o *BooleanIntegerMap) UnmarshalJSON(data []byte) error

func (*BooleanIntegerMap) UnmarshalYAML 

func (o *BooleanIntegerMap) UnmarshalYAML(unmarshal func(interface{}) error) error

type Collections 

type Collections struct {
	/*
	   field docs

	   Deprecated: do not use this field
	*/
	MapVar   map[string][]int   `conjure-docs:"field docs" json:"mapVar"`
	ListVar  []string           `json:"listVar"`
	MultiDim [][]map[string]int `json:"multiDim"`
}

func (Collections) MarshalJSON 

func (o Collections) MarshalJSON() ([]byte, error)

func (Collections) MarshalYAML 

func (o Collections) MarshalYAML() (interface{}, error)

func (*Collections) UnmarshalJSON 

func (o *Collections) UnmarshalJSON(data []byte) error

func (*Collections) UnmarshalYAML 

func (o *Collections) UnmarshalYAML(unmarshal func(interface{}) error) error

type Compound 

type Compound struct {
	Obj Collections `json:"obj"`
}

func (Compound) MarshalYAML 

func (o Compound) MarshalYAML() (interface{}, error)

func (*Compound) UnmarshalYAML 

func (o *Compound) UnmarshalYAML(unmarshal func(interface{}) error) error

type Days 

type Days struct {
	// contains filtered or unexported fields
}

func New_Days 

func New_Days(value Days_Value) Days

func (Days) IsUnknown 

func (e Days) IsUnknown() bool

IsUnknown returns false for all known variants of Days and true otherwise.

func (Days) MarshalText 

func (e Days) MarshalText() ([]byte, error)

func (Days) String 

func (e Days) String() string

func (*Days) UnmarshalText 

func (e *Days) UnmarshalText(data []byte) error

func (Days) Value 

func (e Days) Value() Days_Value

type Days_Value 

type Days_Value string
const (
	Days_FRIDAY   Days_Value = "FRIDAY"
	Days_SATURDAY Days_Value = "SATURDAY"
	Days_UNKNOWN  Days_Value = "UNKNOWN"
)

func Days_Values 

func Days_Values() []Days_Value

Days_Values returns all known variants of Days.

type EmptyValuesEnum added in v6.11.0 

type EmptyValuesEnum struct {
	// contains filtered or unexported fields
}

func New_EmptyValuesEnum added in v6.11.0 

func New_EmptyValuesEnum(value EmptyValuesEnum_Value) EmptyValuesEnum

func (EmptyValuesEnum) IsUnknown added in v6.11.0 

func (e EmptyValuesEnum) IsUnknown() bool

IsUnknown returns false for all known variants of EmptyValuesEnum and true otherwise.

func (EmptyValuesEnum) MarshalText added in v6.11.0 

func (e EmptyValuesEnum) MarshalText() ([]byte, error)

func (EmptyValuesEnum) String added in v6.11.0 

func (e EmptyValuesEnum) String() string

func (*EmptyValuesEnum) UnmarshalText added in v6.11.0 

func (e *EmptyValuesEnum) UnmarshalText(data []byte) error

func (EmptyValuesEnum) Value added in v6.11.0 

func (e EmptyValuesEnum) Value() EmptyValuesEnum_Value

type EmptyValuesEnum_Value added in v6.11.0 

type EmptyValuesEnum_Value string
const (
	EmptyValuesEnum_UNKNOWN EmptyValuesEnum_Value = "UNKNOWN"
)

func EmptyValuesEnum_Values added in v6.11.0 

func EmptyValuesEnum_Values() []EmptyValuesEnum_Value

EmptyValuesEnum_Values returns all known variants of EmptyValuesEnum.

type Enum 

type Enum struct {
	// contains filtered or unexported fields
}

this is an enum

func New_Enum 

func New_Enum(value Enum_Value) Enum

func (Enum) IsUnknown 

func (e Enum) IsUnknown() bool

IsUnknown returns false for all known variants of Enum and true otherwise.

func (Enum) MarshalText 

func (e Enum) MarshalText() ([]byte, error)

func (Enum) String 

func (e Enum) String() string

func (*Enum) UnmarshalText 

func (e *Enum) UnmarshalText(data []byte) error

func (Enum) Value 

func (e Enum) Value() Enum_Value

type Enum_Value 

type Enum_Value string
const (
	Enum_VALUE      Enum_Value = "VALUE"
	Enum_VALUES     Enum_Value = "VALUES"
	Enum_VALUES_1   Enum_Value = "VALUES_1"
	Enum_VALUES_1_1 Enum_Value = "VALUES_1_1"
	Enum_VALUE1     Enum_Value = "VALUE1"
	/*
	   Docs for an enum value

	   Deprecated: Do not use this value
	*/
	Enum_VALUE2  Enum_Value = "VALUE2"
	Enum_UNKNOWN Enum_Value = "UNKNOWN"
)

func Enum_Values 

func Enum_Values() []Enum_Value

Enum_Values returns all known variants of Enum.

type ExampleUnion 

type ExampleUnion struct {
	// contains filtered or unexported fields
}

func NewExampleUnionFromOther 

func NewExampleUnionFromOther(v int) ExampleUnion

func NewExampleUnionFromStr 

func NewExampleUnionFromStr(v string) ExampleUnion

func NewExampleUnionFromStrOptional 

func NewExampleUnionFromStrOptional(v *string) ExampleUnion

func (*ExampleUnion) Accept 

func (u *ExampleUnion) Accept(v ExampleUnionVisitor) error

func (*ExampleUnion) AcceptFuncs added in v6.2.0 

func (u *ExampleUnion) AcceptFuncs(strFunc func(string) error, strOptionalFunc func(*string) error, otherFunc func(int) error, unknownFunc func(string) error) error

func (*ExampleUnion) AcceptWithContext 

func (u *ExampleUnion) AcceptWithContext(ctx context.Context, v ExampleUnionVisitorWithContext) error

func (*ExampleUnion) ErrorOnUnknown added in v6.5.0 

func (u *ExampleUnion) ErrorOnUnknown(typeName string) error

func (ExampleUnion) MarshalJSON 

func (u ExampleUnion) MarshalJSON() ([]byte, error)

func (ExampleUnion) MarshalYAML 

func (u ExampleUnion) MarshalYAML() (interface{}, error)

func (*ExampleUnion) OtherNoopSuccess added in v6.5.0 

func (u *ExampleUnion) OtherNoopSuccess(int) error

func (*ExampleUnion) StrNoopSuccess added in v6.5.0 

func (u *ExampleUnion) StrNoopSuccess(string) error

func (*ExampleUnion) StrOptionalNoopSuccess added in v6.5.0 

func (u *ExampleUnion) StrOptionalNoopSuccess(*string) error

func (*ExampleUnion) UnmarshalJSON 

func (u *ExampleUnion) UnmarshalJSON(data []byte) error

func (*ExampleUnion) UnmarshalYAML 

func (u *ExampleUnion) UnmarshalYAML(unmarshal func(interface{}) error) error

type ExampleUnionVisitor 

type ExampleUnionVisitor interface {
	VisitStr(v string) error
	VisitStrOptional(v *string) error
	VisitOther(v int) error
	VisitUnknown(typeName string) error
}

type ExampleUnionVisitorWithContext 

type ExampleUnionVisitorWithContext interface {
	VisitStrWithContext(ctx context.Context, v string) error
	VisitStrOptionalWithContext(ctx context.Context, v *string) error
	VisitOtherWithContext(ctx context.Context, v int) error
	VisitUnknownWithContext(ctx context.Context, typeName string) error
}

type ExampleUnionVisitorWithT added in v6.18.0 

type ExampleUnionVisitorWithT[T any] interface {
	VisitStr(ctx context.Context, v string) (T, error)
	VisitStrOptional(ctx context.Context, v *string) (T, error)
	VisitOther(ctx context.Context, v int) (T, error)
	VisitUnknown(ctx context.Context, typ string) (T, error)
}

type ExampleUnionWithT added in v6.18.0 

type ExampleUnionWithT[T any] ExampleUnion

func (*ExampleUnionWithT[T]) Accept added in v6.18.0 

func (u *ExampleUnionWithT[T]) Accept(ctx context.Context, v ExampleUnionVisitorWithT[T]) (T, error)

type ExampleUuid 

type ExampleUuid struct {
	Uid uuid.UUID `json:"uid"`
}

func (ExampleUuid) MarshalYAML 

func (o ExampleUuid) MarshalYAML() (interface{}, error)

func (*ExampleUuid) UnmarshalYAML 

func (o *ExampleUuid) UnmarshalYAML(unmarshal func(interface{}) error) error

type ListLongAlias added in v6.15.0 

type ListLongAlias []interface{}

type LongAlias added in v6.15.0 

type LongAlias interface{}

type MapLongAlias added in v6.15.0 

type MapLongAlias map[string]interface{}

type MapOptional added in v6.6.0 

type MapOptional struct {
	Map map[string]OptionalUuidAlias `json:"map"`
}

func (MapOptional) MarshalJSON added in v6.6.0 

func (o MapOptional) MarshalJSON() ([]byte, error)

func (MapOptional) MarshalYAML added in v6.6.0 

func (o MapOptional) MarshalYAML() (interface{}, error)

func (*MapOptional) UnmarshalJSON added in v6.6.0 

func (o *MapOptional) UnmarshalJSON(data []byte) error

func (*MapOptional) UnmarshalYAML added in v6.6.0 

func (o *MapOptional) UnmarshalYAML(unmarshal func(interface{}) error) error

type MapStringAny added in v6.8.0 

type MapStringAny map[string]interface{}

type MapStringAnyAlias added in v6.8.0 

type MapStringAnyAlias map[string]AnyAlias

type MapStringAnyObject added in v6.8.0 

type MapStringAnyObject struct {
	MapStringAny      MapStringAny      `json:"mapStringAny"`
	MapStringAnyAlias MapStringAnyAlias `json:"mapStringAnyAlias"`
}

func (MapStringAnyObject) MarshalJSON added in v6.8.0 

func (o MapStringAnyObject) MarshalJSON() ([]byte, error)

func (MapStringAnyObject) MarshalYAML added in v6.8.0 

func (o MapStringAnyObject) MarshalYAML() (interface{}, error)

func (*MapStringAnyObject) UnmarshalJSON added in v6.8.0 

func (o *MapStringAnyObject) UnmarshalJSON(data []byte) error

func (*MapStringAnyObject) UnmarshalYAML added in v6.8.0 

func (o *MapStringAnyObject) UnmarshalYAML(unmarshal func(interface{}) error) error

type MapUuidLongAlias added in v6.15.0 

type MapUuidLongAlias map[uuid.UUID]interface{}

func (MapUuidLongAlias) MarshalJSON added in v6.15.0 

func (a MapUuidLongAlias) MarshalJSON() ([]byte, error)

func (MapUuidLongAlias) MarshalYAML added in v6.15.0 

func (a MapUuidLongAlias) MarshalYAML() (interface{}, error)

func (*MapUuidLongAlias) UnmarshalJSON added in v6.15.0 

func (a *MapUuidLongAlias) UnmarshalJSON(data []byte) error

func (*MapUuidLongAlias) UnmarshalYAML added in v6.15.0 

func (a *MapUuidLongAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type NestedAlias1 added in v6.6.0 

type NestedAlias1 NestedAlias2

type NestedAlias2 added in v6.6.0 

type NestedAlias2 NestedAlias3

type NestedAlias3 added in v6.6.0 

type NestedAlias3 struct {
	Value *string
}

func (NestedAlias3) MarshalJSON added in v6.16.0 

func (a NestedAlias3) MarshalJSON() ([]byte, error)

func (NestedAlias3) MarshalText added in v6.6.0 

func (a NestedAlias3) MarshalText() ([]byte, error)

func (NestedAlias3) MarshalYAML added in v6.6.0 

func (a NestedAlias3) MarshalYAML() (interface{}, error)

func (*NestedAlias3) UnmarshalText added in v6.6.0 

func (a *NestedAlias3) UnmarshalText(data []byte) error

func (*NestedAlias3) UnmarshalYAML added in v6.6.0 

func (a *NestedAlias3) UnmarshalYAML(unmarshal func(interface{}) error) error

type OptionalFields added in v6.6.0 

type OptionalFields struct {
	Opt1 *string           `json:"opt1"`
	Opt2 *string           `json:"opt2"`
	Reqd string            `json:"reqd"`
	Opt3 OptionalUuidAlias `json:"opt3"`
}

func (OptionalFields) MarshalYAML added in v6.6.0 

func (o OptionalFields) MarshalYAML() (interface{}, error)

func (*OptionalFields) UnmarshalYAML added in v6.6.0 

func (o *OptionalFields) UnmarshalYAML(unmarshal func(interface{}) error) error

type OptionalStructAlias added in v6.16.0 

type OptionalStructAlias struct {
	Value *Basic
}

func (OptionalStructAlias) MarshalJSON added in v6.16.0 

func (a OptionalStructAlias) MarshalJSON() ([]byte, error)

func (OptionalStructAlias) MarshalYAML added in v6.16.0 

func (a OptionalStructAlias) MarshalYAML() (interface{}, error)

func (*OptionalStructAlias) UnmarshalJSON added in v6.16.0 

func (a *OptionalStructAlias) UnmarshalJSON(data []byte) error

func (*OptionalStructAlias) UnmarshalYAML added in v6.16.0 

func (a *OptionalStructAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type OptionalUuidAlias 

type OptionalUuidAlias struct {
	Value *uuid.UUID
}

func (OptionalUuidAlias) MarshalJSON added in v6.16.0 

func (a OptionalUuidAlias) MarshalJSON() ([]byte, error)

func (OptionalUuidAlias) MarshalText 

func (a OptionalUuidAlias) MarshalText() ([]byte, error)

func (OptionalUuidAlias) MarshalYAML 

func (a OptionalUuidAlias) MarshalYAML() (interface{}, error)

func (*OptionalUuidAlias) UnmarshalText 

func (a *OptionalUuidAlias) UnmarshalText(data []byte) error

func (*OptionalUuidAlias) UnmarshalYAML 

func (a *OptionalUuidAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type RidAlias 

type RidAlias rid.ResourceIdentifier

func (RidAlias) MarshalText 

func (a RidAlias) MarshalText() ([]byte, error)

func (RidAlias) MarshalYAML 

func (a RidAlias) MarshalYAML() (interface{}, error)

func (RidAlias) String 

func (a RidAlias) String() string

func (*RidAlias) UnmarshalText 

func (a *RidAlias) UnmarshalText(data []byte) error

func (*RidAlias) UnmarshalYAML 

func (a *RidAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type StringAlias added in v6.16.0 

type StringAlias string

type StringAliasAlias added in v6.16.0 

type StringAliasAlias StringAlias

type Type 

type Type struct {
	Type []string          `json:"type"`
	Chan map[string]string `json:"chan"`
}

A type using go keywords

func (Type) MarshalJSON 

func (o Type) MarshalJSON() ([]byte, error)

func (Type) MarshalYAML 

func (o Type) MarshalYAML() (interface{}, error)

func (*Type) UnmarshalJSON 

func (o *Type) UnmarshalJSON(data []byte) error

func (*Type) UnmarshalYAML 

func (o *Type) UnmarshalYAML(unmarshal func(interface{}) error) error

type UuidAlias 

type UuidAlias uuid.UUID

func (UuidAlias) MarshalText 

func (a UuidAlias) MarshalText() ([]byte, error)

func (UuidAlias) MarshalYAML 

func (a UuidAlias) MarshalYAML() (interface{}, error)

func (UuidAlias) String 

func (a UuidAlias) String() string

func (*UuidAlias) UnmarshalText 

func (a *UuidAlias) UnmarshalText(data []byte) error

func (*UuidAlias) UnmarshalYAML 

func (a *UuidAlias) UnmarshalYAML(unmarshal func(interface{}) error) error

type UuidAlias2 

type UuidAlias2 Compound

func (UuidAlias2) MarshalJSON 

func (a UuidAlias2) MarshalJSON() ([]byte, error)

func (UuidAlias2) MarshalYAML 

func (a UuidAlias2) MarshalYAML() (interface{}, error)

func (*UuidAlias2) UnmarshalJSON 

func (a *UuidAlias2) UnmarshalJSON(data []byte) error

func (*UuidAlias2) UnmarshalYAML 

func (a *UuidAlias2) UnmarshalYAML(unmarshal func(interface{}) error) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.