ddbv1

Documentation

Index

• Variables
• type Encoding
  • func (Encoding) Descriptor() protoreflect.EnumDescriptor
  • func (x Encoding) Enum() *Encoding
  • func (Encoding) EnumDescriptor() ([]byte, []int)
  • func (x Encoding) Number() protoreflect.EnumNumber
  • func (x Encoding) String() string
  • func (Encoding) Type() protoreflect.EnumType
  • func (x *Encoding) UnmarshalJSON(b []byte) error
• type FieldOptions
  • func (*FieldOptions) Descriptor() ([]byte, []int)
  • func (x *FieldOptions) GetEmbed() Encoding
  • func (x *FieldOptions) GetName() string
  • func (x *FieldOptions) GetOmit() bool
  • func (x *FieldOptions) GetPk() bool
  • func (x *FieldOptions) GetSet() bool
  • func (x *FieldOptions) GetSk() bool
  • func (*FieldOptions) ProtoMessage()
  • func (x *FieldOptions) ProtoReflect() protoreflect.Message
  • func (x *FieldOptions) Reset()
  • func (x *FieldOptions) String() string

Variables

var (
	Encoding_name = map[int32]string{
		0: "ENCODING_UNSPECIFIED",
		1: "ENCODING_JSON",
		2: "ENCODING_DYNAMO",
	}
	Encoding_value = map[string]int32{
		"ENCODING_UNSPECIFIED": 0,
		"ENCODING_JSON":        1,
		"ENCODING_DYNAMO":      2,
	}
)

Enum value maps for Encoding.

var (
	// optional ddb.v1.FieldOptions field = 1098;
	E_Field = &file_ddb_v1_options_proto_extTypes[0]
)

Extension fields to descriptorpb.FieldOptions.

var File_ddb_v1_options_proto protoreflect.FileDescriptor

Types

type Encoding

type Encoding int32

encoding kinds

const (
	// unspecified encoding
	Encoding_ENCODING_UNSPECIFIED Encoding = 0
	// json encoding
	Encoding_ENCODING_JSON Encoding = 1
	// dynamo encoding
	Encoding_ENCODING_DYNAMO Encoding = 2
)

func (Encoding) Descriptor

func (Encoding) Descriptor() protoreflect.EnumDescriptor

func (Encoding) Enum

func (x Encoding) Enum() *Encoding

func (Encoding) EnumDescriptor

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

Deprecated: Use Encoding.Descriptor instead.

func (Encoding) Number

func (x Encoding) Number() protoreflect.EnumNumber

func (Encoding) String

func (x Encoding) String() string

func (Encoding) Type

func (Encoding) Type() protoreflect.EnumType

func (*Encoding) UnmarshalJSON

func (x *Encoding) UnmarshalJSON(b []byte) error

Deprecated: Do not use.

type FieldOptions

type FieldOptions struct {

	// specify the name of the DynamoDB attribute
	Name *string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	// indicate that the field represents the item's partition key
	Pk *bool `protobuf:"varint,2,opt,name=pk" json:"pk,omitempty"`
	// indicate that the field represents the item's sort key
	Sk *bool `protobuf:"varint,3,opt,name=sk" json:"sk,omitempty"`
	// indicate that the field should be ignored by Dynamo code generation
	Omit *bool `protobuf:"varint,4,opt,name=omit" json:"omit,omitempty"`
	// indicate that the field should be marshalled and unmarshalled from dynamo as a set
	Set *bool `protobuf:"varint,5,opt,name=set" json:"set,omitempty"`
	// allows for embedding the field's value as an encoded json or binary protobuf
	Embed *Encoding `protobuf:"varint,6,opt,name=embed,enum=ddb.v1.Encoding" json:"embed,omitempty"`
	// contains filtered or unexported fields
}

FieldOptions presents options to configure fields to interact with protobuf powered rpc

func (*FieldOptions) Descriptor

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

Deprecated: Use FieldOptions.ProtoReflect.Descriptor instead.

func (*FieldOptions) GetEmbed

func (x *FieldOptions) GetEmbed() Encoding

func (*FieldOptions) GetName

func (x *FieldOptions) GetName() string

func (*FieldOptions) GetOmit

func (x *FieldOptions) GetOmit() bool

func (*FieldOptions) GetPk

func (x *FieldOptions) GetPk() bool

func (*FieldOptions) GetSet

func (x *FieldOptions) GetSet() bool

func (*FieldOptions) GetSk

func (x *FieldOptions) GetSk() bool

func (*FieldOptions) ProtoMessage

func (*FieldOptions) ProtoMessage()

func (*FieldOptions) ProtoReflect

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

func (*FieldOptions) Reset

func (x *FieldOptions) Reset()

func (*FieldOptions) String

func (x *FieldOptions) String() string