types

package
v0.0.0-...-893f904 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2022 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	SortOrder_name = map[int32]string{
		0: "ASCENDING",
		1: "DESCENDING",
	}
	SortOrder_value = map[string]int32{
		"ASCENDING":  0,
		"DESCENDING": 1,
	}
)

Enum value maps for SortOrder.

View Source 
var (
	OperationType_name = map[int32]string{
		0: "CREATE",
		1: "UPDATE",
		2: "DELETE",
	}
	OperationType_value = map[string]int32{
		"CREATE": 0,
		"UPDATE": 1,
		"DELETE": 2,
	}
)

Enum value maps for OperationType.

View Source 
var File_api_spi_types_store_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Bool 

type Bool struct {
	Ok bool `protobuf:"varint,1,opt,name=ok,proto3" json:"ok,omitempty"`
	// contains filtered or unexported fields
}

func (*Bool) Descriptor deprecated 

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

Deprecated: Use Bool.ProtoReflect.Descriptor instead.

func (*Bool) GetOk 

func (x *Bool) GetOk() bool

func (*Bool) ProtoMessage 

func (*Bool) ProtoMessage()

func (*Bool) ProtoReflect 

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

func (*Bool) Reset 

func (x *Bool) Reset()

func (*Bool) String 

func (x *Bool) String() string

type Operation 

type Operation struct {
	Key           string        `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	Tags          []*Tag        `protobuf:"bytes,2,rep,name=tags,proto3" json:"tags,omitempty"`
	OperationType OperationType `protobuf:"varint,3,opt,name=operationType,proto3,enum=api.spi.types.OperationType" json:"operationType,omitempty"`
	Value         []byte        `protobuf:"bytes,4,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Operation represents an operation to be performed in the Batch method.

func (*Operation) Descriptor deprecated 

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

Deprecated: Use Operation.ProtoReflect.Descriptor instead.

func (*Operation) GetKey 

func (x *Operation) GetKey() string

func (*Operation) GetOperationType 

func (x *Operation) GetOperationType() OperationType

func (*Operation) GetTags 

func (x *Operation) GetTags() []*Tag

func (*Operation) GetValue 

func (x *Operation) GetValue() []byte

func (*Operation) ProtoMessage 

func (*Operation) ProtoMessage()

func (*Operation) ProtoReflect 

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

func (*Operation) Reset 

func (x *Operation) Reset()

func (*Operation) String 

func (x *Operation) String() string

type OperationType 

type OperationType int32

OperationType 

const (
	OperationType_CREATE OperationType = 0
	OperationType_UPDATE OperationType = 1
	OperationType_DELETE OperationType = 2
)

func (OperationType) Descriptor 

func (OperationType) Descriptor() protoreflect.EnumDescriptor

func (OperationType) Enum 

func (x OperationType) Enum() *OperationType

func (OperationType) EnumDescriptor deprecated 

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

Deprecated: Use OperationType.Descriptor instead.

func (OperationType) Number 

func (x OperationType) Number() protoreflect.EnumNumber

func (OperationType) String 

func (x OperationType) String() string

func (OperationType) Type 

func (OperationType) Type() protoreflect.EnumType

type QueryOptions 

type QueryOptions struct {

	// PageSize sets the page size used by the Store.Query method.
	PageSize int32 `protobuf:"varint,1,opt,name=pageSize,proto3" json:"pageSize,omitempty"`
	// InitialPageNum sets the page for the iterator returned from Store.Query to start from.
	PageNum int32 `protobuf:"varint,2,opt,name=pageNum,proto3" json:"pageNum,omitempty"`
	// SortOptions defines the sort order.
	SortedOptions *SortOptions `protobuf:"bytes,3,opt,name=sortedOptions,proto3" json:"sortedOptions,omitempty"`
	// contains filtered or unexported fields
}

QueryOptions represents various options for Query calls in a store.

func (*QueryOptions) Descriptor deprecated 

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

Deprecated: Use QueryOptions.ProtoReflect.Descriptor instead.

func (*QueryOptions) GetPageNum 

func (x *QueryOptions) GetPageNum() int32

func (*QueryOptions) GetPageSize 

func (x *QueryOptions) GetPageSize() int32

func (*QueryOptions) GetSortedOptions 

func (x *QueryOptions) GetSortedOptions() *SortOptions

func (*QueryOptions) ProtoMessage 

func (*QueryOptions) ProtoMessage()

func (*QueryOptions) ProtoReflect 

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

func (*QueryOptions) Reset 

func (x *QueryOptions) Reset()

func (*QueryOptions) String 

func (x *QueryOptions) String() string

type Record 

type Record struct {
	Id        string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name      string   `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Context   []string `protobuf:"bytes,3,rep,name=context,proto3" json:"context,omitempty"`
	Type      []string `protobuf:"bytes,4,rep,name=type,proto3" json:"type,omitempty"`
	SubjectId string   `protobuf:"bytes,5,opt,name=subjectId,proto3" json:"subjectId,omitempty"`
	// MyDID and TheirDID contains information about participants who were involved in the process
	// of issuing a credential or presentation.
	MyDid    string `protobuf:"bytes,6,opt,name=my_did,json=myDid,proto3" json:"my_did,omitempty"`
	TheirDid string `protobuf:"bytes,7,opt,name=their_did,json=theirDid,proto3" json:"their_did,omitempty"`
	// contains filtered or unexported fields
}

Record model containing name, ID and other fields of interest. swagger:model

func (*Record) Descriptor deprecated 

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

Deprecated: Use Record.ProtoReflect.Descriptor instead.

func (*Record) GetContext 

func (x *Record) GetContext() []string

func (*Record) GetId 

func (x *Record) GetId() string

func (*Record) GetMyDid 

func (x *Record) GetMyDid() string

func (*Record) GetName 

func (x *Record) GetName() string

func (*Record) GetSubjectId 

func (x *Record) GetSubjectId() string

func (*Record) GetTheirDid 

func (x *Record) GetTheirDid() string

func (*Record) GetType 

func (x *Record) GetType() []string

func (*Record) ProtoMessage 

func (*Record) ProtoMessage()

func (*Record) ProtoReflect 

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

func (*Record) Reset 

func (x *Record) Reset()

func (*Record) String 

func (x *Record) String() string

type SortOptions 

type SortOptions struct {
	Order   SortOrder `protobuf:"varint,1,opt,name=order,proto3,enum=api.spi.types.SortOrder" json:"order,omitempty"`
	TagName string    `protobuf:"bytes,2,opt,name=tagName,proto3" json:"tagName,omitempty"`
	// contains filtered or unexported fields
}

SortOptions sets the order that results from an Iterator will be returned in. Sorting is based on the tag values associated with the TagName chosen below. The TagName you use below can be the same as the one you're querying on, or it can be a different one. Depending on the storage implementation, you may need to ensure that the TagName set below is in the Store's StoreConfiguration before trying to use it for sorting (or it may be optional, but recommended). If tag value strings are decimal numbers, then the sorting must be based on their numerical value instead of the string representations of those numbers (i.e. numerical sorting, not lexicographic). TagName cannot be blank.

func (*SortOptions) Descriptor deprecated 

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

Deprecated: Use SortOptions.ProtoReflect.Descriptor instead.

func (*SortOptions) GetOrder 

func (x *SortOptions) GetOrder() SortOrder

func (*SortOptions) GetTagName 

func (x *SortOptions) GetTagName() string

func (*SortOptions) ProtoMessage 

func (*SortOptions) ProtoMessage()

func (*SortOptions) ProtoReflect 

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

func (*SortOptions) Reset 

func (x *SortOptions) Reset()

func (*SortOptions) String 

func (x *SortOptions) String() string

type SortOrder 

type SortOrder int32

SortOrder specifies the sort order of query results. 

const (
	SortOrder_ASCENDING  SortOrder = 0
	SortOrder_DESCENDING SortOrder = 1
)

func (SortOrder) Descriptor 

func (SortOrder) Descriptor() protoreflect.EnumDescriptor

func (SortOrder) Enum 

func (x SortOrder) Enum() *SortOrder

func (SortOrder) EnumDescriptor deprecated 

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

Deprecated: Use SortOrder.Descriptor instead.

func (SortOrder) Number 

func (x SortOrder) Number() protoreflect.EnumNumber

func (SortOrder) String 

func (x SortOrder) String() string

func (SortOrder) Type 

func (SortOrder) Type() protoreflect.EnumType

type StoreConfiguration 

type StoreConfiguration struct {
	Tags []*Tag `protobuf:"bytes,1,rep,name=tags,proto3" json:"tags,omitempty"`
	// contains filtered or unexported fields
}

StoreConfiguration represents the configuration of a store. Currently, it's only used for creating indexes in underlying storage databases.

func (*StoreConfiguration) Descriptor deprecated 

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

Deprecated: Use StoreConfiguration.ProtoReflect.Descriptor instead.

func (*StoreConfiguration) GetTags 

func (x *StoreConfiguration) GetTags() []*Tag

func (*StoreConfiguration) ProtoMessage 

func (*StoreConfiguration) ProtoMessage()

func (*StoreConfiguration) ProtoReflect 

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

func (*StoreConfiguration) Reset 

func (x *StoreConfiguration) Reset()

func (*StoreConfiguration) String 

func (x *StoreConfiguration) String() string

type Tag 

type Tag struct {

	// Name can be used to tag a given key + value pair as belonging to some sort of common
	// group. Example: Identifying a key+value pair as being a Verifiable Credential by storing it
	// with a tag Name called "VC". When used with the optional Value (see below), tag Name + Value can be used to
	// specify metadata for a given key + value pair. Example: Identifying a Verifiable Credential (stored as a
	// key+value pair) as belonging to a user account by using a tag Name called "UserAccount" and a tag Value called
	// "bob@example.com". Tag Names are intended to be static values that the store is configured with in order to build
	// indexes for queries (see TagNames in StoreConfiguration).
	// Tag Names cannot contain any ':' characters.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Value can optionally be used to indicate some metadata associated with a tag name for a given key + value pair.
	// See Name above for an example of how this can be used.
	// Tag Values are dynamic and are not specified in a StoreConfiguration.
	// Tag Values cannot contain any ':' characters.
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Tag represents a Name + Value pair that can be associated with a key + value pair for querying later. swagger:model

func (*Tag) Descriptor deprecated 

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

Deprecated: Use Tag.ProtoReflect.Descriptor instead.

func (*Tag) GetName 

func (x *Tag) GetName() string

func (*Tag) GetValue 

func (x *Tag) GetValue() string

func (*Tag) ProtoMessage 

func (*Tag) ProtoMessage()

func (*Tag) ProtoReflect 

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

func (*Tag) Reset 

func (x *Tag) Reset()

func (*Tag) String 

func (x *Tag) String() string

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.