# automatically generated by the FlatBuffers compiler, do not modify
# namespace: xbr
import flatbuffers
from flatbuffers.compat import import_numpy
# XBR data service APIs published to (part of) catalogs.
[docs]
class Api(object):
@classmethod
[docs]
def GetRootAs(cls, buf, offset=0):
n = flatbuffers.encode.Get(flatbuffers.packer.uoffset, buf, offset)
x = Api()
x.Init(buf, n + offset)
return x
@classmethod
[docs]
def GetRootAsApi(cls, buf, offset=0):
"""This method is deprecated. Please switch to GetRootAs."""
return cls.GetRootAs(buf, offset)
# Api
[docs]
def Init(self, buf, pos):
self._tab = flatbuffers.table.Table(buf, pos)
# The unique ID of the API.
# Api
[docs]
def Oid(self, j):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
if o != 0:
a = self._tab.Vector(o)
return self._tab.Get(
flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
)
return 0
# Api
[docs]
def OidAsNumpy(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
if o != 0:
return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
return 0
# Api
[docs]
def OidLength(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
if o != 0:
return self._tab.VectorLen(o)
return 0
# Api
[docs]
def OidIsNone(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(4))
return o == 0
# The ID of the catalog this API is part of (was published to).
# Api
[docs]
def CatalogOid(self, j):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(6))
if o != 0:
a = self._tab.Vector(o)
return self._tab.Get(
flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
)
return 0
# Api
[docs]
def CatalogOidAsNumpy(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(6))
if o != 0:
return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
return 0
# Api
[docs]
def CatalogOidLength(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(6))
if o != 0:
return self._tab.VectorLen(o)
return 0
# Api
[docs]
def CatalogOidIsNone(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(6))
return o == 0
# Database transaction time (epoch time in ns).
# Api
[docs]
def Timestamp(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(8))
if o != 0:
return self._tab.Get(flatbuffers.number_types.Uint64Flags, o + self._tab.Pos)
return 0
# Block number when the catalog was created.
# Api
[docs]
def Published(self, j):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
if o != 0:
a = self._tab.Vector(o)
return self._tab.Get(
flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
)
return 0
# Api
[docs]
def PublishedAsNumpy(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
if o != 0:
return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
return 0
# Api
[docs]
def PublishedLength(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
if o != 0:
return self._tab.VectorLen(o)
return 0
# Api
[docs]
def PublishedIsNone(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(10))
return o == 0
# Multihash of API Flatbuffers schema (required).
# Api
[docs]
def Schema(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(12))
if o != 0:
return self._tab.String(o + self._tab.Pos)
return None
# Multihash of API meta-data (optional).
# Api
# Transaction hash of the transaction this change was committed to the blockchain under.
# Api
[docs]
def Tid(self, j):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(16))
if o != 0:
a = self._tab.Vector(o)
return self._tab.Get(
flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
)
return 0
# Api
[docs]
def TidAsNumpy(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(16))
if o != 0:
return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
return 0
# Api
[docs]
def TidLength(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(16))
if o != 0:
return self._tab.VectorLen(o)
return 0
# Api
[docs]
def TidIsNone(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(16))
return o == 0
# When signed off-chain and submitted via ``XBRCatalog.publishApiFor``.
# Api
[docs]
def Signature(self, j):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(18))
if o != 0:
a = self._tab.Vector(o)
return self._tab.Get(
flatbuffers.number_types.Uint8Flags, a + flatbuffers.number_types.UOffsetTFlags.py_type(j * 1)
)
return 0
# Api
[docs]
def SignatureAsNumpy(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(18))
if o != 0:
return self._tab.GetVectorAsNumpy(flatbuffers.number_types.Uint8Flags, o)
return 0
# Api
[docs]
def SignatureLength(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(18))
if o != 0:
return self._tab.VectorLen(o)
return 0
# Api
[docs]
def SignatureIsNone(self):
o = flatbuffers.number_types.UOffsetTFlags.py_type(self._tab.Offset(18))
return o == 0
[docs]
def ApiStart(builder):
builder.StartObject(8)
[docs]
def Start(builder):
ApiStart(builder)
[docs]
def ApiAddOid(builder, oid):
builder.PrependUOffsetTRelativeSlot(0, flatbuffers.number_types.UOffsetTFlags.py_type(oid), 0)
[docs]
def AddOid(builder, oid):
ApiAddOid(builder, oid)
[docs]
def ApiStartOidVector(builder, numElems):
return builder.StartVector(1, numElems, 1)
[docs]
def StartOidVector(builder, numElems: int) -> int:
return ApiStartOidVector(builder, numElems)
[docs]
def ApiAddCatalogOid(builder, catalogOid):
builder.PrependUOffsetTRelativeSlot(1, flatbuffers.number_types.UOffsetTFlags.py_type(catalogOid), 0)
[docs]
def AddCatalogOid(builder, catalogOid):
ApiAddCatalogOid(builder, catalogOid)
[docs]
def ApiStartCatalogOidVector(builder, numElems):
return builder.StartVector(1, numElems, 1)
[docs]
def StartCatalogOidVector(builder, numElems: int) -> int:
return ApiStartCatalogOidVector(builder, numElems)
[docs]
def ApiAddTimestamp(builder, timestamp):
builder.PrependUint64Slot(2, timestamp, 0)
[docs]
def AddTimestamp(builder, timestamp):
ApiAddTimestamp(builder, timestamp)
[docs]
def ApiAddPublished(builder, published):
builder.PrependUOffsetTRelativeSlot(3, flatbuffers.number_types.UOffsetTFlags.py_type(published), 0)
[docs]
def AddPublished(builder, published):
ApiAddPublished(builder, published)
[docs]
def ApiStartPublishedVector(builder, numElems):
return builder.StartVector(1, numElems, 1)
[docs]
def StartPublishedVector(builder, numElems: int) -> int:
return ApiStartPublishedVector(builder, numElems)
[docs]
def ApiAddSchema(builder, schema):
builder.PrependUOffsetTRelativeSlot(4, flatbuffers.number_types.UOffsetTFlags.py_type(schema), 0)
[docs]
def AddSchema(builder, schema):
ApiAddSchema(builder, schema)
[docs]
def ApiAddTid(builder, tid):
builder.PrependUOffsetTRelativeSlot(6, flatbuffers.number_types.UOffsetTFlags.py_type(tid), 0)
[docs]
def AddTid(builder, tid):
ApiAddTid(builder, tid)
[docs]
def ApiStartTidVector(builder, numElems):
return builder.StartVector(1, numElems, 1)
[docs]
def StartTidVector(builder, numElems: int) -> int:
return ApiStartTidVector(builder, numElems)
[docs]
def ApiAddSignature(builder, signature):
builder.PrependUOffsetTRelativeSlot(7, flatbuffers.number_types.UOffsetTFlags.py_type(signature), 0)
[docs]
def AddSignature(builder, signature):
ApiAddSignature(builder, signature)
[docs]
def ApiStartSignatureVector(builder, numElems):
return builder.StartVector(1, numElems, 1)
[docs]
def StartSignatureVector(builder, numElems: int) -> int:
return ApiStartSignatureVector(builder, numElems)
[docs]
def ApiEnd(builder):
return builder.EndObject()
[docs]
def End(builder):
return ApiEnd(builder)