Help us shape the future of Go! Take the 2026 Go Developer Survey

reference

package
v0.1.58 Latest Latest
Warning

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

Go to latest
Published: Oct 26, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source
const ReaderDatlyResourceNamespace = "datly_payload_reference_reader"

DatlyResourceNamespace identifies this package's generated resource filesystem.

Variables

View Source
var ReaderDatly = new(ReaderComponent)

The public value supports explicit component wiring.

View Source
var ReaderDatlyResources embed.FS

Functions

func ReaderDatlyType

func ReaderDatlyType() reflect.Type

ReaderDatlyType returns the public component type.

Types

type Input

type Input struct {
	CheckReferences bool       `parameter:"CheckReferences,kind=payloadaccess,in=checkReferences,dataType=bool,required=false"`
	TenantID        string     `parameter:"TenantID,kind=path,in=tenantId,dataType=string,required=false" predicate:"in,p,tenant_id"`
	Id              string     `parameter:"Id,kind=query,in=id,dataType=string,required=false" predicate:"in,p,id"`
	Ids             []string   `parameter:"Ids,kind=query,in=ids,dataType=[]string,required=false" predicate:"in,p,id"`
	Kind            string     `parameter:"Kind,kind=query,in=kind,dataType=string,required=false" predicate:"in,p,kind"`
	Digest          string     `parameter:"Digest,kind=query,in=digest,dataType=string,required=false" predicate:"in,p,digest"`
	Storage         string     `parameter:"Storage,kind=query,in=storage,dataType=string,required=false" predicate:"in,p,storage"`
	MimeType        string     `parameter:"MimeType,kind=query,in=mime_type,dataType=string,required=false" predicate:"in,p,mime_type"`
	Since           *time.Time `parameter:"Since,kind=query,in=since,dataType=*time.Time,required=false" predicate:"greater_or_equal,p,created_at"`
	Fields          []string   `` /* 133-byte string literal not displayed */
	OrderBy         string     `` /* 134-byte string literal not displayed */
	Limit           int        `parameter:"Limit,kind=query,in=_limit,dataType=int,required=false,cacheable=false" querySelector:"view=reader,property=limit"`
	Offset          int        `` /* 128-byte string literal not displayed */
	Page            int        `parameter:"Page,kind=query,in=_page,dataType=int,required=false,cacheable=false" querySelector:"view=reader,property=page"`
	Criteria        string     `` /* 137-byte string literal not displayed */
	Has             *InputHas  `setMarker:"true" typeName:"InputHas" json:"-" sqlx:"-"`
}

Input is the generated input scaffold for reader.

func (*Input) SetCheckReferences

func (input *Input) SetCheckReferences(value bool)

func (*Input) SetCriteria

func (input *Input) SetCriteria(value string)

func (*Input) SetDigest

func (input *Input) SetDigest(value string)

func (*Input) SetFields

func (input *Input) SetFields(value []string)

func (*Input) SetId

func (input *Input) SetId(value string)

func (*Input) SetIds

func (input *Input) SetIds(value []string)

func (*Input) SetKind

func (input *Input) SetKind(value string)

func (*Input) SetLimit

func (input *Input) SetLimit(value int)

func (*Input) SetMimeType

func (input *Input) SetMimeType(value string)

func (*Input) SetOffset

func (input *Input) SetOffset(value int)

func (*Input) SetOrderBy

func (input *Input) SetOrderBy(value string)

func (*Input) SetPage

func (input *Input) SetPage(value int)

func (*Input) SetSince

func (input *Input) SetSince(value *time.Time)

func (*Input) SetStorage

func (input *Input) SetStorage(value string)

func (*Input) SetTenantID

func (input *Input) SetTenantID(value string)

type InputHas

type InputHas struct {
	CheckReferences bool
	TenantID        bool
	Id              bool
	Ids             bool
	Kind            bool
	Digest          bool
	Storage         bool
	MimeType        bool
	Since           bool
	Fields          bool
	OrderBy         bool
	Limit           bool
	Offset          bool
	Page            bool
	Criteria        bool
}

type Output

type Output struct {
	response.Status `parameter:",kind=output,in=status"`
	Metrics         response.Metrics `parameter:",kind=output,in=metrics" json:"metrics"`
	Data            []*PayloadView   `` /* 370-byte string literal not displayed */
}

Output is the generated output scaffold for reader.

type PayloadView

type PayloadView struct {
	Referenced             bool       `internal:"true" json:"-" sqlx:"referenced"`
	Id                     string     `sqlx:"id,primaryKey=true" json:"id"`
	Kind                   string     `sqlx:"kind,required=true" json:"kind"`
	MimeType               string     `sqlx:"mime_type,required=true" json:"mimeType"`
	SizeBytes              int        `sqlx:"size_bytes,required=true" json:"sizeBytes"`
	Storage                string     `sqlx:"storage,required=true" json:"storage"`
	InlineBody             *[]byte    `sqlx:"inline_body" json:"inlineBody"`
	Compression            string     `sqlx:"compression,required=true" json:"compression"`
	TenantId               *string    `sqlx:"tenant_id" json:"tenantId"`
	Subtype                *string    `sqlx:"subtype" json:"subtype"`
	Digest                 *string    `sqlx:"digest" json:"digest"`
	Uri                    *string    `sqlx:"uri" json:"uri"`
	EncryptionKmsKeyId     *string    `sqlx:"encryption_kms_key_id" json:"encryptionKmsKeyId"`
	RedactionPolicyVersion *string    `sqlx:"redaction_policy_version" json:"redactionPolicyVersion"`
	Redacted               *int       `sqlx:"redacted,required=true" json:"redacted"`
	CreatedAt              *time.Time `sqlx:"created_at,required=true" json:"createdAt"`
	SchemaRef              *string    `sqlx:"schema_ref" json:"schemaRef"`
	RunId                  *string    `sqlx:"run_id,refTable=run,refColumn=id" json:"runId"`
	Sequence               *int       `sqlx:"sequence" json:"sequence"`
}

PayloadView is generated canonical view metadata for reader.

func (*PayloadView) OnFetch

func (p *PayloadView) OnFetch(ctx context.Context) error

OnFetch decodes storage compression without changing the payload bytes.

type ReaderComponent

type ReaderComponent struct {
	Contract xdatly.Component[Input, Output] "" /* 143-byte string literal not displayed */
}

Component is the generated component scaffold for reader.

func (ReaderComponent) EmbedFS

func (ReaderComponent) EmbedFS() *embed.FS

func (ReaderComponent) EmbedNamespace

func (ReaderComponent) EmbedNamespace() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL