schema

package
v0.4.2 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Report_Status_name = map[int32]string{
		0: "UNKNOWN",
		1: "PENDING",
		2: "RUNNING",
		3: "COMPLETED",
		4: "FAILED",
	}
	Report_Status_value = map[string]int32{
		"UNKNOWN":   0,
		"PENDING":   1,
		"RUNNING":   2,
		"COMPLETED": 3,
		"FAILED":    4,
	}
)

Enum value maps for Report_Status.

View Source 
var File_cdx_proto protoreflect.FileDescriptor
View Source 
var File_fileinfo_proto protoreflect.FileDescriptor
View Source 
var File_report_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Cdx 

type Cdx struct {

	// uri (required) - The value should be the non-transformed URI used for the searchable URI (first sortable field).
	Uri string `protobuf:"bytes,1,opt,name=uri,proto3" json:"uri,omitempty"`
	// sha (recommended) - A Base32 encoded SHA-1 digest of the payload that this record refers to. Omit if the URI has
	// no intrinsic payload. For revisit records, this is the digest of the original payload. The algorithm prefix
	// (e.g. sha-1) is not included in this field. See dig for alternative hashing algorithms.
	Sha string `protobuf:"bytes,2,opt,name=sha,proto3" json:"sha,omitempty"`
	// dig - A Base32 encoded output of a hashing algorithm applied to the URI’s payload. This should include a prefix
	// indicating the algorithm.
	Dig string `protobuf:"bytes,3,opt,name=dig,proto3" json:"dig,omitempty"`
	// hsc - HTTP Status Code. Applicable for response records for HTTP(S) URIs.
	Hsc int32 `protobuf:"varint,4,opt,name=hsc,proto3" json:"hsc,omitempty"`
	// mct - Media Content Type (MIME type). For HTTP(S) response records this is typically the “Content-Type” from
	// the HTTP header. This field, however, does not specify the origin of the information. It may be used to include
	// content type that was derived from content analysis or other sources.
	Mct string `protobuf:"bytes,5,opt,name=mct,proto3" json:"mct,omitempty"`
	// ref (required) - A URI that resolves to the resource that this record refers to. This can be any well defined
	// URI scheme. For the most common web archive use case of warc filename plus offset, see Appendix C. For other
	// use cases, existing schemes can be used or new ones devised.
	Ref string `protobuf:"bytes,6,opt,name=ref,proto3" json:"ref,omitempty"`
	// rid (recommended) - Record ID. Typically WARC-Record-ID or equivalent if not using WARCs. In a mixed environment,
	// you should ensure that record ID is unique.
	Rid string `protobuf:"bytes,7,opt,name=rid,proto3" json:"rid,omitempty"`
	// cle - Content Length. The length of the content (uncompressed), ignoring WARC headers, but including any
	// HTTP headers or similar.
	Cle int64 `protobuf:"varint,8,opt,name=cle,proto3" json:"cle,omitempty"`
	// ple - Payload Length. The length of the payload (uncompressed). The exact meaning will vary by content type,
	// but the common case is the length of the document, excluding any HTTP headers in a HTTP response record.
	Ple int64 `protobuf:"varint,9,opt,name=ple,proto3" json:"ple,omitempty"`
	// rle - Record Length. The length of the record that this line refers to. This is the entire record
	// (including e.g. WARC headers) as written on disk (compressed if stored compressed).
	Rle int64 `protobuf:"varint,10,opt,name=rle,proto3" json:"rle,omitempty"`
	// rct - Record Concurrant To. The record ID of another record that the current record is considered to be
	// ‘concurrant’ to. See further WARC chapter 5.7 (WARC-Concurrent-To).
	Rct string `protobuf:"bytes,11,opt,name=rct,proto3" json:"rct,omitempty"`
	// rou (recommended) - Revisit Original URI. Only valid for records of type revisit. Contains the URI of
	// the record that this record is considered a revisit of.
	Rou string `protobuf:"bytes,12,opt,name=rou,proto3" json:"rou,omitempty"`
	// rod (recommended) - Revisit Original Date. Only valid for records of type revisit. Contains the
	// timestamp (equivalent to sortable field #2) of the record that this record is considered a revisit of.
	Rod *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=rod,proto3" json:"rod,omitempty"`
	// roi - Revisit Original record ID. Only valid for records of type revisit. Contains the record ID of
	// the record that this record is considered a revisit of.
	Roi string `protobuf:"bytes,14,opt,name=roi,proto3" json:"roi,omitempty"`
	// Searchable URI - ssu (sortable searchable URI)
	Ssu string `protobuf:"bytes,15,opt,name=ssu,proto3" json:"ssu,omitempty"`
	// Timestamp - sts (sortable timestamp)
	Sts *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=sts,proto3" json:"sts,omitempty"`
	// Record Type - srt (sortable record type)
	Srt string `protobuf:"bytes,17,opt,name=srt,proto3" json:"srt,omitempty"`
	// contains filtered or unexported fields
}

func (*Cdx) Descriptor deprecated 

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

Deprecated: Use Cdx.ProtoReflect.Descriptor instead.

func (*Cdx) GetCle 

func (x *Cdx) GetCle() int64

func (*Cdx) GetDig 

func (x *Cdx) GetDig() string

func (*Cdx) GetHsc 

func (x *Cdx) GetHsc() int32

func (*Cdx) GetMct 

func (x *Cdx) GetMct() string

func (*Cdx) GetPle 

func (x *Cdx) GetPle() int64

func (*Cdx) GetRct 

func (x *Cdx) GetRct() string

func (*Cdx) GetRef 

func (x *Cdx) GetRef() string

func (*Cdx) GetRid 

func (x *Cdx) GetRid() string

func (*Cdx) GetRle 

func (x *Cdx) GetRle() int64

func (*Cdx) GetRod 

func (x *Cdx) GetRod() *timestamppb.Timestamp

func (*Cdx) GetRoi 

func (x *Cdx) GetRoi() string

func (*Cdx) GetRou 

func (x *Cdx) GetRou() string

func (*Cdx) GetSha 

func (x *Cdx) GetSha() string

func (*Cdx) GetSrt 

func (x *Cdx) GetSrt() string

func (*Cdx) GetSsu 

func (x *Cdx) GetSsu() string

func (*Cdx) GetSts 

func (x *Cdx) GetSts() *timestamppb.Timestamp

func (*Cdx) GetUri 

func (x *Cdx) GetUri() string

func (*Cdx) ProtoMessage 

func (*Cdx) ProtoMessage()

func (*Cdx) ProtoReflect 

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

func (*Cdx) Reset 

func (x *Cdx) Reset()

func (*Cdx) String 

func (x *Cdx) String() string

type FileInfo added in v0.4.0 

type FileInfo struct {

	// Filename
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Full path
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// Last modified
	LastModified *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=last_modified,json=lastModified,proto3" json:"last_modified,omitempty"`
	// File size
	Size int64 `protobuf:"varint,4,opt,name=size,proto3" json:"size,omitempty"`
	// contains filtered or unexported fields
}

func (*FileInfo) Descriptor deprecated added in v0.4.0 

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

Deprecated: Use FileInfo.ProtoReflect.Descriptor instead.

func (*FileInfo) GetLastModified added in v0.4.0 

func (x *FileInfo) GetLastModified() *timestamppb.Timestamp

func (*FileInfo) GetName added in v0.4.0 

func (x *FileInfo) GetName() string

func (*FileInfo) GetPath added in v0.4.0 

func (x *FileInfo) GetPath() string

func (*FileInfo) GetSize added in v0.4.0 

func (x *FileInfo) GetSize() int64

func (*FileInfo) ProtoMessage added in v0.4.0 

func (*FileInfo) ProtoMessage()

func (*FileInfo) ProtoReflect added in v0.4.0 

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

func (*FileInfo) Reset added in v0.4.0 

func (x *FileInfo) Reset()

func (*FileInfo) String added in v0.4.0 

func (x *FileInfo) String() string

type Report added in v0.4.0 

type Report struct {
	Id        string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	StartTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	Duration  *durationpb.Duration   `protobuf:"bytes,3,opt,name=duration,proto3" json:"duration,omitempty"`
	EndTime   *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	Error     string                 `protobuf:"bytes,5,opt,name=error,proto3" json:"error,omitempty"`
	Query     *structpb.Struct       `protobuf:"bytes,6,opt,name=query,proto3" json:"query,omitempty"`
	Status    Report_Status          `protobuf:"varint,7,opt,name=status,proto3,enum=gowarcserver.schema.Report_Status" json:"status,omitempty"`
	Progress  string                 `protobuf:"bytes,8,opt,name=progress,proto3" json:"progress,omitempty"`
	Data      *ReportData            `protobuf:"bytes,9,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*Report) Descriptor deprecated added in v0.4.0 

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

Deprecated: Use Report.ProtoReflect.Descriptor instead.

func (*Report) GetData added in v0.4.0 

func (x *Report) GetData() *ReportData

func (*Report) GetDuration added in v0.4.0 

func (x *Report) GetDuration() *durationpb.Duration

func (*Report) GetEndTime added in v0.4.0 

func (x *Report) GetEndTime() *timestamppb.Timestamp

func (*Report) GetError added in v0.4.0 

func (x *Report) GetError() string

func (*Report) GetId added in v0.4.0 

func (x *Report) GetId() string

func (*Report) GetProgress added in v0.4.0 

func (x *Report) GetProgress() string

func (*Report) GetQuery added in v0.4.0 

func (x *Report) GetQuery() *structpb.Struct

func (*Report) GetStartTime added in v0.4.0 

func (x *Report) GetStartTime() *timestamppb.Timestamp

func (*Report) GetStatus added in v0.4.0 

func (x *Report) GetStatus() Report_Status

func (*Report) ProtoMessage added in v0.4.0 

func (*Report) ProtoMessage()

func (*Report) ProtoReflect added in v0.4.0 

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

func (*Report) Reset added in v0.4.0 

func (x *Report) Reset()

func (*Report) String added in v0.4.0 

func (x *Report) String() string

type ReportData added in v0.4.0 

type ReportData struct {
	NrOfRecords        uint64            `protobuf:"varint,1,opt,name=nr_of_records,json=nrOfRecords,proto3" json:"nr_of_records,omitempty"`
	NrOfTargets        uint64            `protobuf:"varint,2,opt,name=nr_of_targets,json=nrOfTargets,proto3" json:"nr_of_targets,omitempty"`
	NrOfTargetCaptures uint64            `protobuf:"varint,3,opt,name=nr_of_target_captures,json=nrOfTargetCaptures,proto3" json:"nr_of_target_captures,omitempty"`
	NrOfDomains        uint64            `protobuf:"varint,4,opt,name=nr_of_domains,json=nrOfDomains,proto3" json:"nr_of_domains,omitempty"`
	NrOfUrls           uint64            `protobuf:"varint,5,opt,name=nr_of_urls,json=nrOfUrls,proto3" json:"nr_of_urls,omitempty"`
	CountByStatusCode  map[string]uint64 `` /* 205-byte string literal not displayed */
	CountByRecordType  map[string]uint64 `` /* 205-byte string literal not displayed */
	CountByContentType map[string]uint64 `` /* 208-byte string literal not displayed */
	CountByScheme      map[string]uint64 `` /* 191-byte string literal not displayed */
	ContentLength      uint64            `protobuf:"varint,10,opt,name=content_length,json=contentLength,proto3" json:"content_length,omitempty"`
	PayloadLength      uint64            `protobuf:"varint,11,opt,name=payload_length,json=payloadLength,proto3" json:"payload_length,omitempty"`
	RecordLength       uint64            `protobuf:"varint,12,opt,name=record_length,json=recordLength,proto3" json:"record_length,omitempty"`
	// contains filtered or unexported fields
}

func (*ReportData) Descriptor deprecated added in v0.4.0 

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

Deprecated: Use ReportData.ProtoReflect.Descriptor instead.

func (*ReportData) GetContentLength added in v0.4.0 

func (x *ReportData) GetContentLength() uint64

func (*ReportData) GetCountByContentType added in v0.4.0 

func (x *ReportData) GetCountByContentType() map[string]uint64

func (*ReportData) GetCountByRecordType added in v0.4.0 

func (x *ReportData) GetCountByRecordType() map[string]uint64

func (*ReportData) GetCountByScheme added in v0.4.0 

func (x *ReportData) GetCountByScheme() map[string]uint64

func (*ReportData) GetCountByStatusCode added in v0.4.0 

func (x *ReportData) GetCountByStatusCode() map[string]uint64

func (*ReportData) GetNrOfDomains added in v0.4.0 

func (x *ReportData) GetNrOfDomains() uint64

func (*ReportData) GetNrOfRecords added in v0.4.0 

func (x *ReportData) GetNrOfRecords() uint64

func (*ReportData) GetNrOfTargetCaptures added in v0.4.0 

func (x *ReportData) GetNrOfTargetCaptures() uint64

func (*ReportData) GetNrOfTargets added in v0.4.0 

func (x *ReportData) GetNrOfTargets() uint64

func (*ReportData) GetNrOfUrls added in v0.4.0 

func (x *ReportData) GetNrOfUrls() uint64

func (*ReportData) GetPayloadLength added in v0.4.0 

func (x *ReportData) GetPayloadLength() uint64

func (*ReportData) GetRecordLength added in v0.4.0 

func (x *ReportData) GetRecordLength() uint64

func (*ReportData) ProtoMessage added in v0.4.0 

func (*ReportData) ProtoMessage()

func (*ReportData) ProtoReflect added in v0.4.0 

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

func (*ReportData) Reset added in v0.4.0 

func (x *ReportData) Reset()

func (*ReportData) String added in v0.4.0 

func (x *ReportData) String() string

type Report_Status added in v0.4.0 

type Report_Status int32
const (
	Report_UNKNOWN   Report_Status = 0
	Report_PENDING   Report_Status = 1
	Report_RUNNING   Report_Status = 2
	Report_COMPLETED Report_Status = 3
	Report_FAILED    Report_Status = 4
)

func (Report_Status) Descriptor added in v0.4.0 

func (Report_Status) Descriptor() protoreflect.EnumDescriptor

func (Report_Status) Enum added in v0.4.0 

func (x Report_Status) Enum() *Report_Status

func (Report_Status) EnumDescriptor deprecated added in v0.4.0 

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

Deprecated: Use Report_Status.Descriptor instead.

func (Report_Status) Number added in v0.4.0 

func (x Report_Status) Number() protoreflect.EnumNumber

func (Report_Status) String added in v0.4.0 

func (x Report_Status) String() string

func (Report_Status) Type added in v0.4.0 

func (Report_Status) Type() protoreflect.EnumType

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.