resource

Dec 14, 2024

Changes in this version

type OwnerRefFlag

+ func WithUnsetOnDelete() OwnerRefFlag

Nov 14, 2024

Changes in this version

type BatchGetOption

+ func WithBatchGetSkipCache() BatchGetOption

type BatchGetOptions

+ GetSkipCache func() bool

+ type GetOption func(*getOptions)

+ func WithGetSkipCache() GetOption

+ type GetOptions interface

+ GetSkipCache func() bool

+ func MakeGetOptions(opts []GetOption) GetOptions

+ type QueryOption func(*queryOptions)

+ func WithQuerySkipCache() QueryOption

+ type QueryOptions interface

+ GetSkipCache func() bool

+ func MakeQueryOptions(opts []QueryOption) QueryOptions

Nov 1, 2024

Changes in this version

type Descriptor

+ SupportsDbConstraints func() bool

Oct 9, 2024

Changes in this version

+ const RegionScopeAttribute

+ func FindMultiRegionPolicyFieldPath(resDescriptor Descriptor) object.FieldPath

+ func GetSyncingOpts(descriptor Descriptor) *mrann.SyncingOpts

+ func IsRegionalResource(descriptor Descriptor) bool

Feb 29, 2024

Changes in this version

+ func AddUniqueMetaOwnerReference(res Resource, ownerRef *meta.OwnerReference) bool

+ func FindMetaOwnerByDescriptor(res Resource, descriptor Descriptor) (mref *meta.OwnerReference)

+ func GetCount(ctx context.Context, desc Descriptor, access Access, filter Filter) (int32, error)

+ func MakeMetaOwnerReference(owner Resource, flags ...OwnerRefFlag) *meta.OwnerReference

+ func MakeMetaOwnerReferenceFromNameAndRegion(ownerName Name, ownerRegionId string, flags ...OwnerRefFlag) *meta.OwnerReference

+ func UnsetReferenceFromResource(res Resource, refFp object.FieldPath, refToUnset Reference) bool

type Descriptor

+ CanBeParentless func() bool

+ GetParentResDescriptors func() []Descriptor

+ SupportsMetadata func() bool

type ListQuery

+ func MakeCountQuery(desc Descriptor, filter Filter) ListQuery

+ type OwnerRefFlag func(o *meta.OwnerReference)

+ func WithController() OwnerRefFlag

+ func WithRequiresOwnerReference() OwnerRefFlag

type Resource

+ EnsureMetadata func() *meta.Meta

+ GetMetadata func() *meta.Meta

Aug 8, 2023

Changes in this version

+ func GenerateResourceIdFromElements(elements ...string) string

Apr 1, 2023

Changes in this version

type BatchGetOption

+ func WithBatchGetFieldMask(desc Descriptor, mask object.FieldMask) BatchGetOption

type BatchGetOptions

+ GetFieldMask func(Descriptor) object.FieldMask

+ GetFieldMasks func() map[Descriptor]object.FieldMask

Jan 26, 2023

Changes in this version

+ func SortedResourceIdRefNameSegments(descriptor Descriptor) []string

Jan 18, 2023

Changes in this version

type ListQuery

+ GetWithPagingInfo func() bool

+ SetWithPagingInfo func(bool)

type QueryResultSnapshot

+ GetPagingInfo func() (totalCount, offset int32)

+ SetPagingInfo func(totalCount, offset int32)

Oct 29, 2022

Changes in this version

type Descriptor

+ NewResourcePager func() PagerQuery

type WatchQuery

+ GetStartingTime func() *timestamppb.Timestamp

+ SetStartingTime func(*timestamppb.Timestamp)

Oct 27, 2022

Changes in this version

+ const InConditionsMaxArgs

+ func IterateListQuery(ctx context.Context, query ListQuery, access Access, ...) error

type Name

+ GetIParentName func() Name

+ GetIUnderlyingParentName func() Name

type PagerQuery

+ SetCursor func(Cursor)

+ SetLimit func(int)

+ SetOrderBy func(OrderBy)

+ SetPageDirection func(PageDirection)

+ SetPeekForward func(bool)

Jul 5, 2022

Changes in this version

type ResourceChange

+ GetRawResource func() Resource

May 9, 2022

Changes in this version

+ func MakeSQLListString(query ListQuery) string

+ func MakeSQLSearchString(query SearchQuery) string

+ func MakeSQLWatchString(query WatchQuery) string

+ func MarshalQueryResultChange(qres QueryResultChange) ([]byte, error)

+ func MarshalSearchQueryResultSnapshot(qres SearchQueryResultSnapshot) ([]byte, error)

+ func UnmarshalQueryResultChange(qres QueryResultChange, descriptor Descriptor, data []byte) error

+ func UnmarshalSearchQueryResultSnapshot(qres SearchQueryResultSnapshot, descriptor Descriptor, data []byte) error

Feb 22, 2022

Changes in this version

type Descriptor

+ NewResourceFieldMask func() object.FieldMask

+ NewResourceFilter func() Filter

+ NewResourceOrderBy func() OrderBy

+ type Registry struct

+ func GetRegistry() *Registry

+ func (r *Registry) FindResourceDescriptor(fullyQualifiedName, version string) Descriptor

+ func (r *Registry) RegisterDescriptor(descriptor Descriptor)

type SaveOption

+ func WithCompareAndSwap(state Resource, mask object.FieldMask) SaveOption

+ func WithCreateModeOnly() SaveOption

+ func WithUpdateMask(mask object.FieldMask) SaveOption

+ func WithUpdateModeOnly() SaveOption

type SaveOptions

+ GetCAS func() (object.FieldMask, Resource)

+ GetUpdateMask func() object.FieldMask

+ OnlyCreate func() bool

+ OnlyUpdate func() bool

type TypeName

+ func (rtn *TypeName) ServiceDomain() string

+ func (rtn *TypeName) Version() string

Feb 1, 2022

Changes in this version

+ const ConditionContainsTypeAll

+ const ConditionContainsTypeAny

+ const ConditionContainsTypeUnspecified

+ const ConditionContainsTypeValue

+ const DefaultMaximumQueryChunkSize

+ const WildcardId

+ func ApplyPagerToViewUsingOffset(pager PagerQuery, view ResourceList) (pagedView ResourceList, nextPageCursor, prevPageCursor Cursor)

+ func ApplyPagerToViewUsingSnapshot(pager PagerQuery, view ResourceList) (pagedView ResourceList, nextPageCursor, prevPageCursor Cursor)

+ func GenerateResourceId(res Resource) string

+ func HasForwardCursor(pager PagerQuery, view ResourceList) bool

+ func MakeSQLGetString(mask object.FieldMask, name Name) string

+ func MakeSQLString(mask object.FieldMask, filter Filter, pager PagerQuery, searchPhrase string) string

+ func MarshalQueryResultSnapshot(qres QueryResultSnapshot) ([]byte, error)

+ func NewUnknownConditionContainsType(ct ConditionContainsType) error

+ func UnmarshalQueryResultSnapshot(qres QueryResultSnapshot, descriptor Descriptor, data []byte) error

+ type Access interface

+ BatchGet func(ctx context.Context, toGet []Reference, opts ...BatchGetOption) error

+ Delete func(ctx context.Context, ref Reference, opts ...DeleteOption) error

+ Get func(ctx context.Context, q GetQuery) (Resource, error)

+ GetResourceDescriptors func() []Descriptor

+ Query func(ctx context.Context, q ListQuery) (QueryResultSnapshot, error)

+ Save func(ctx context.Context, res Resource, opts ...SaveOption) error

+ Search func(ctx context.Context, q SearchQuery) (SearchQueryResultSnapshot, error)

+ Watch func(ctx context.Context, q GetQuery, cb func(ch ResourceChange) error) error

+ WatchQuery func(ctx context.Context, q WatchQuery, cb func(ch QueryResultChange) error) error

+ func NewCompositeAccess(accesses ...Access) Access

+ type BatchGetOption func(*batchGetOptions)

+ func WithMustResolveAll() BatchGetOption

+ type BatchGetOptions interface

+ MustResolveAll func() bool

+ func MakeBatchGetOptions(opts []BatchGetOption) BatchGetOptions

+ type ChangesWatchPager struct

+ func NewChangesWatchPager(pager PagerQuery, descriptor Descriptor) *ChangesWatchPager

+ func (wp *ChangesWatchPager) ProcessChanges(changes ResourceChangeList) (Cursor, Cursor, bool)

+ type ConditionCompare interface

+ ConditionCompare func()

+ GetOperator func() filterParser.CompareOperator

+ GetRawFieldPathValue func() object.FieldPathValue

+ type ConditionComposite interface

+ ConditionComposite func()

+ GetOperator func() filterParser.CompositeOperator

+ GetSubConditions func() []FilterCondition

+ type ConditionContains interface

+ ConditionContainsType func() ConditionContainsType

+ GetRawFieldPathItemValue func() object.FieldPathArrayItemValue

+ GetRawFieldPathItemValues func() []object.FieldPathArrayItemValue

+ type ConditionContainsType int

+ func ConditionContainsTypeFromParser(contains *filterParser.Contains) ConditionContainsType

+ func (cct ConditionContainsType) IsAll() bool

+ func (cct ConditionContainsType) IsAny() bool

+ func (cct ConditionContainsType) IsValue() bool

+ func (cct ConditionContainsType) String() string

+ type ConditionIn interface

+ ConditionIn func()

+ GetRawFieldPathArrayOfValues func() object.FieldPathArrayOfValues

+ type ConditionIsNaN interface

+ ConditionIsNaN func()

+ GetRawFieldPath func() object.FieldPath

+ type ConditionIsNull interface

+ ConditionIsNull func()

+ GetRawFieldPath func() object.FieldPath

+ NotNull func() bool

+ type ConditionNot interface

+ ConditionNot func()

+ GetSubCondition func() FilterCondition

+ type ConditionNotIn interface

+ ConditionNotIn func()

+ GetRawFieldPathArrayOfValues func() object.FieldPathArrayOfValues

+ type Cursor interface

+ GetInclusion func() CursorInclusion

+ GetPageDirection func() PageDirection

+ GetValue func() CursorValue

+ IsEmpty func() bool

+ SetCursorValue func(CursorValue)

+ SetInclusion func(CursorInclusion)

+ SetPageDirection func(PageDirection)

+ type CursorInclusion string

+ const CursorExclusive

+ const CursorInclusive

+ func CursorInclusionFromString(str string) (result CursorInclusion, err error)

+ func (ci CursorInclusion) IsExclusive() bool

+ func (ci CursorInclusion) IsInclusive() bool

+ func (ci CursorInclusion) Reverse() CursorInclusion

+ type CursorValue interface

+ GetValueType func() CursorValueType

+ type CursorValueType string

+ const CustomCursorValueType

+ const OffsetCursorValueType

+ const SnapshotCursorValueType

+ const UnIdentifiedCursorValue

+ type CustomCursorValue struct

+ Params map[string]string

+ func NewCustomCursorValue() *CustomCursorValue

+ func ParseCustomCursorValue(strValue string) (*CustomCursorValue, error)

+ func (occ *CustomCursorValue) GetValueType() CursorValueType

+ func (occ *CustomCursorValue) String() string

+ type DeleteOption func(*deleteOptions)

+ func WithCurrentResource(current Resource) DeleteOption

+ type DeleteOptions interface

+ GetDeletedResource func() Resource

+ func MakeDeleteOptions(opts []DeleteOption) DeleteOptions

+ type Descriptor interface

+ GetNameDescriptor func() *NameDescriptor

+ GetResourceTypeName func() *TypeName

+ NewGetQuery func() GetQuery

+ NewListQuery func() ListQuery

+ NewNameList func(size, reserved int) NameList

+ NewParentNameList func(size, reserved int) ParentNameList

+ NewParentReferenceList func(size, reserved int) ParentReferenceList

+ NewQueryResultChange func() QueryResultChange

+ NewQueryResultSnapshot func() QueryResultSnapshot

+ NewReferenceList func(size, reserved int) ReferenceList

+ NewResource func() Resource

+ NewResourceChange func() ResourceChange

+ NewResourceChangeList func(size, reserved int) ResourceChangeList

+ NewResourceChangeMap func(reserved int) ResourceChangeMap

+ NewResourceCursor func() Cursor

+ NewResourceList func(size, reserved int) ResourceList

+ NewResourceMap func(reserved int) ResourceMap

+ NewResourceName func() Name

+ NewSearchQuery func() SearchQuery

+ NewSearchQueryResultSnapshot func() SearchQueryResultSnapshot

+ NewWatchQuery func() WatchQuery

+ ParseFieldPath func(raw string) (object.FieldPath, error)

+ ParseResourceName func(raw string) (Name, error)

+ type DisplayableResource interface

+ GetDisplayName func() string

+ type FieldPathCondition interface

+ GetRawFieldPath func() object.FieldPath

+ type Filter interface

+ EvaluateRaw func(Resource) bool

+ GetRawCondition func() FilterCondition

+ type FilterCondition interface

+ EvaluateRaw func(Resource) bool

+ SatisfiesRaw func(FilterCondition) bool

+ SpecifiesRawFieldPath func(object.FieldPath) bool

+ type GetQuery interface

+ GetFieldMask func() object.FieldMask

+ GetReference func() Reference

+ SetFieldMask func(object.FieldMask)

+ SetReference func(Reference)

+ type ListQuery interface

+ GetFieldMask func() object.FieldMask

+ GetFilter func() Filter

+ GetPager func() PagerQuery

+ SetFieldMask func(object.FieldMask)

+ SetFilter func(Filter)

+ SetPager func(PagerQuery)

+ type Name interface

+ AsRawReference func() Reference

+ FullyQualifiedName func() (string, error)

+ GetIdParts func() map[string]string

+ GetPattern func() NamePattern

+ GetResourceDescriptor func() Descriptor

+ GetSegments func() NameSegments

+ GotenEqual func(other interface{}) bool

+ IsFullyQualified func() bool

+ IsSpecified func() bool

+ Matches func(other interface{}) bool

+ SetFromSegments func(segments NameSegments) error

+ type NameDescriptor struct

+ func NewNameDescriptor(fp object.FieldPath, patternFieldName, idFieldName string, ...) *NameDescriptor

+ func (d *NameDescriptor) GetAllSegmentIdFieldNames() []string

+ func (d *NameDescriptor) GetFieldPath() object.FieldPath

+ func (d *NameDescriptor) GetIdFieldName() string

+ func (d *NameDescriptor) GetNamePatterns() []NamePattern

+ func (d *NameDescriptor) GetParentIdFieldNames() []string

+ func (d *NameDescriptor) GetPatternFieldName() string

+ type NameList interface

+ Append func(res Name) NameList

+ AppendList func(list NameList) NameList

+ At func(idx int) Name

+ Length func() int

+ Set func(idx int, name Name)

+ Slice func(first, second int) NameList

+ type NamePattern string

+ func (np NamePattern) IsPrefixOf(other NamePattern) bool

+ func (np NamePattern) SegmentPatterns() NameSegmentPatterns

+ func (np NamePattern) SegmentsCount() int

+ func (np NamePattern) String() string

+ type NameSegment struct

+ CollectionLowerJson string

+ Id string

+ func (ns NameSegment) String() string

+ type NameSegmentPattern struct

+ CollectionLowerJson string

+ SingularLowerJson string

+ func (ns NameSegmentPattern) IdFieldName() string

+ func (ns NameSegmentPattern) MakeSegment(idValue string) NameSegment

+ func (ns NameSegmentPattern) String() string

+ type NameSegmentPatterns []NameSegmentPattern

+ func (nsp NameSegmentPatterns) String() string

+ type NameSegments []NameSegment

+ func (ns NameSegments) String() string

+ type OffsetCursorValue struct

+ Offset int32

+ func NewOffsetCursorValue(offset int32) *OffsetCursorValue

+ func ParseOffsetCursorValue(strValue string) (*OffsetCursorValue, error)

+ func (ocp *OffsetCursorValue) GetOffset() int32

+ func (ocp *OffsetCursorValue) GetValueType() CursorValueType

+ func (ocp *OffsetCursorValue) MakeBackwardValue(direction PageDirection, advanceBy int32) *OffsetCursorValue

+ func (ocp *OffsetCursorValue) MakeForwardValue(direction PageDirection, advanceBy int32) *OffsetCursorValue

+ func (ocp *OffsetCursorValue) String() string

+ type OrderBy interface

+ CompareRaw func(Resource, Resource) int

+ GetOrderByFields func() []OrderByField

+ GetRawFieldMask func() object.FieldMask

+ InsertSortedRaw func(ResourceList, Resource) (ResourceList, int)

+ SortRaw func(ResourceList)

+ type OrderByField interface

+ GetDirection func() OrderDirection

+ GetFieldPath func() object.FieldPath

+ type OrderDirection string

+ const DirectionASC

+ const DirectionDESC

+ func OrderDirectionFromString(str string) (result OrderDirection, err error)

+ func (od OrderDirection) Reverse() OrderDirection

+ type PageDirection string

+ const PageLeft

+ const PageRight

+ func PageDirectionFromString(str string) (result PageDirection, err error)

+ func (pd PageDirection) IsLeft() bool

+ func (pd PageDirection) IsRight() bool

+ func (pd PageDirection) Reverse() PageDirection

+ type PagerQuery interface

+ GetCursor func() Cursor

+ GetLimit func() int

+ GetOrderBy func() OrderBy

+ GetPeekForward func() bool

+ GetResourceDescriptor func() Descriptor

+ PageDirection func() PageDirection

+ type ParentNameList interface

+ Append func(res Name) ParentNameList

+ AppendList func(list ParentNameList) ParentNameList

+ At func(idx int) Name

+ Length func() int

+ Set func(idx int, name Name)

+ Slice func(first, second int) ParentNameList

+ type ParentReferenceList interface

+ Append func(ref Reference) ParentReferenceList

+ AppendList func(list ParentReferenceList) ParentReferenceList

+ At func(idx int) Reference

+ Length func() int

+ Set func(idx int, ref Reference)

+ Slice func(first, second int) ParentReferenceList

+ type Query interface

+ GetResourceDescriptor func() Descriptor

+ GotenQuery func()

+ type QueryResultChange interface

+ GetIsCurrent func() bool

+ GetIsHardReset func() bool

+ GetIsSoftReset func() bool

+ GetNextPageCursor func() Cursor

+ GetPrevPageCursor func() Cursor

+ GetResults func() ResourceChangeList

+ GetResumeToken func() string

+ GetSnapshotSize func() int64

+ SetCursors func(Cursor, Cursor)

+ SetIsCurrent func()

+ SetIsHardReset func()

+ SetIsSoftReset func()

+ SetResults func(ResourceChangeList)

+ SetResumeToken func(string)

+ SetSnapshotSize func(int64)

+ type QueryResultSnapshot interface

+ GetNextPageCursor func() Cursor

+ GetPrevPageCursor func() Cursor

+ GetResults func() ResourceList

+ SetCursors func(Cursor, Cursor)

+ SetResults func(ResourceList)

+ type Reference interface

+ ClearCached func()

+ GetRawResource func() Resource

+ ResolveRaw func(Resource) error

+ Resolved func() bool

+ type ReferenceList interface

+ Append func(ref Reference) ReferenceList

+ AppendList func(list ReferenceList) ReferenceList

+ At func(idx int) Reference

+ Length func() int

+ Set func(idx int, ref Reference)

+ Slice func(first, second int) ReferenceList

+ type Resource interface

+ GetRawName func() Name

+ GetResourceDescriptor func() Descriptor

+ type ResourceChange interface

+ GetCurrentViewIndex func() int32

+ GetPreviousViewIndex func() int32

+ GetRawName func() Name

+ GetResource func() Resource

+ IsAdd func() bool

+ IsCurrent func() bool

+ IsDelete func() bool

+ IsModify func() bool

+ SetAddedRaw func(Resource, int)

+ SetCurrentRaw func(Resource)

+ SetDeletedRaw func(Name, int)

+ SetModifiedRaw func(Name, Resource, int, int)

+ type ResourceChangeList interface

+ Append func(change ResourceChange) ResourceChangeList

+ AppendList func(list ResourceChangeList) ResourceChangeList

+ At func(idx int) ResourceChange

+ Length func() int

+ Set func(idx int, change ResourceChange)

+ Slice func(first, second int) ResourceChangeList

+ type ResourceChangeMap interface

+ Delete func(name Name)

+ ForEach func(cb func(Name, ResourceChange) bool)

+ Get func(name Name) ResourceChange

+ Length func() int

+ Set func(change ResourceChange)

+ type ResourceList interface

+ Append func(res Resource) ResourceList

+ AppendList func(list ResourceList) ResourceList

+ At func(idx int) Resource

+ Length func() int

+ Set func(idx int, res Resource)

+ Slice func(first, second int) ResourceList

+ type ResourceMap interface

+ Delete func(name Name)

+ ForEach func(cb func(Name, Resource) bool)

+ Get func(name Name) Resource

+ Length func() int

+ Set func(change Resource)

+ type SaveOption func(*saveOptions)

+ func WithPreviousResource(previous Resource) SaveOption

+ type SaveOptions interface

+ GetPreviousResource func() Resource

+ func MakeSaveOptions(opts []SaveOption) SaveOptions

+ type SearchQuery interface

+ GetPhrase func() string

+ SetPhrase func(string)

+ type SearchQueryResultSnapshot interface

+ GetPagingInfo func() (totalCount, offset int32)

+ SetPagingInfo func(totalCount, offset int32)

+ type SnapshotCursorValue struct

+ Snapshot Resource

+ func NewSnapshotCursorValue(snapshot Resource) *SnapshotCursorValue

+ func ParseSnapshotCursorValue(descriptor Descriptor, strValue string) (*SnapshotCursorValue, error)

+ func (scp *SnapshotCursorValue) GetSnapshot() Resource

+ func (scp *SnapshotCursorValue) GetValueType() CursorValueType

+ func (scp *SnapshotCursorValue) String() string

+ type TypeName struct

+ func NewTypeName(singular, plural, domain string) *TypeName

+ func (rtn *TypeName) FullyQualifiedTypeName() string

+ func (rtn *TypeName) JSONPlural() string

+ func (rtn *TypeName) JSONSingular() string

+ func (rtn *TypeName) Plural() string

+ func (rtn *TypeName) Singular() string

+ type UnknownConditionContainsType struct

+ Type ConditionContainsType

+ func (ucct *UnknownConditionContainsType) Error() string

+ type WatchQuery interface

+ GetMaximumChunkSize func() int

+ GetResumeToken func() string

+ GetWatchType func() watch_type.WatchType

+ SetMaximumChunkSize func(int)

+ SetResumeToken func(string)

+ SetWatchType func(watch_type.WatchType)