filemd

type Metadata struct {
	// Sections within the data object.
	Sections []*SectionInfo `protobuf:"bytes,1,rep,name=sections,proto3" json:"sections,omitempty"`
	// A list of strings used to resolve type name references.
	Dictionary []string `protobuf:"bytes,2,rep,name=dictionary,proto3" json:"dictionary,omitempty"`
	// A list of types used by sections. The zero index is reserved for an
	// invalid type.
	Types []*SectionType `protobuf:"bytes,3,rep,name=types,proto3" json:"types,omitempty"`
}

type Region struct {
	// Byte offset of the region from the start of the data object.
	Offset uint64 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
	// Length of the region in bytes.
	Length uint64 `protobuf:"varint,2,opt,name=length,proto3" json:"length,omitempty"`
}

type SectionInfo struct {
	// The physical layout of the section within the data object. Setting
	// layout is mutually exclusive with specifying the metadata_offset and
	// metadata_size fields.
	//
	// For backwards compatibility with older versions of data objects where
	// layout isn't provided, implementations must assume that:
	//
	//   - A section has data, but its offset and length are unknown.
	//
	//   - Range reads of section data are done relative to the start of the
	//     data object.
	//
	// If the SectionLayout is specified for a section, range reads are instead
	// relative to the start of the data region. If the data region is undefined,
	// then the section has no data.
	//
	// Setting the layout is mutually exclusive with specifying the
	// metadata_offset and metadata_size fields, and readers must reject data
	// objects that set both.
	Layout *SectionLayout `protobuf:"bytes,4,opt,name=layout,proto3" json:"layout,omitempty"`
	// An index into Metadata.types specifying the type of this section.
	TypeRef uint32 `protobuf:"varint,5,opt,name=type_ref,json=typeRef,proto3" json:"type_ref,omitempty"`
	// Optional additional information about the section that sections can
	// provide.
	//
	// Because extension_data increases the size of the file metadata, sections
	// should only use this field for required information that must be stored
	// without loading the section.
	//
	// Sections implementations are recommended to use the version field of
	// [SectionType] to determine how to interpret the payload.
	ExtensionData []byte `protobuf:"bytes,6,opt,name=extension_data,json=extensionData,proto3" json:"extension_data,omitempty"`
	// An index into Metadata.dictionary specifying the owning tenant of this
	// section.
	//
	// Sections containing data wholly owned by a single tenant must specify the
	// owning tenant. If tenant_ref is 0, the section holds data owned by multiple
	// tenants, usually with some other mechanism to determine ownership (e.g., if
	// the section does not contain cross-tenant aggregated data).
	TenantRef uint32 `protobuf:"varint,7,opt,name=tenant_ref,json=tenantRef,proto3" json:"tenant_ref,omitempty"`
}

type SectionLayout struct {
	// The region covering the data of a section. If the data region is
	// undefined, implementations must assume that the section has no data.
	Data *Region `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// The region covering the metadata of a section. If the metadata region is
	// undefined, implementations must assume that the section has no metadata.
	Metadata *Region `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
}

type SectionType struct {
	// The reference to the type name.
	NameRef *SectionType_NameRef `protobuf:"bytes,1,opt,name=name_ref,json=nameRef,proto3" json:"name_ref,omitempty"`
	// An optional section-specified version of this type, used to inform section
	// implementations how to read the section.
	Version uint32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
}

type SectionType_NameRef struct {
	// An index into Metadata.dictionary specifying the namespace string of
	// this type (e.g., "github.com/grafana/loki").
	NamespaceRef uint32 `protobuf:"varint,1,opt,name=namespace_ref,json=namespaceRef,proto3" json:"namespace_ref,omitempty"`
	// An index into Metadata.dictionary specifying the kind of this type
	// (e.g., "logs").
	KindRef uint32 `protobuf:"varint,2,opt,name=kind_ref,json=kindRef,proto3" json:"kind_ref,omitempty"`
}