Documentation ¶
Index ¶
- Variables
- type Address
- func (*Address) Descriptor() ([]byte, []int)deprecated
- func (x *Address) GetContainerId() *ContainerID
- func (x *Address) GetObjectId() *ObjectID
- func (*Address) ProtoMessage()
- func (x *Address) ProtoReflect() protoreflect.Message
- func (x *Address) Reset()
- func (m *Address) SetContainerId(v *ContainerID)
- func (m *Address) SetObjectId(v *ObjectID)
- func (x *Address) String() string
- type Checksum
- func (*Checksum) Descriptor() ([]byte, []int)deprecated
- func (x *Checksum) GetSum() []byte
- func (x *Checksum) GetType() ChecksumType
- func (*Checksum) ProtoMessage()
- func (x *Checksum) ProtoReflect() protoreflect.Message
- func (x *Checksum) Reset()
- func (m *Checksum) SetChecksumType(v ChecksumType)
- func (m *Checksum) SetSum(v []byte)
- func (x *Checksum) String() string
- type ChecksumType
- func (ChecksumType) Descriptor() protoreflect.EnumDescriptor
- func (x ChecksumType) Enum() *ChecksumType
- func (ChecksumType) EnumDescriptor() ([]byte, []int)deprecated
- func (x ChecksumType) Number() protoreflect.EnumNumber
- func (x ChecksumType) String() string
- func (ChecksumType) Type() protoreflect.EnumType
- type ContainerID
- func (*ContainerID) Descriptor() ([]byte, []int)deprecated
- func (x *ContainerID) GetValue() []byte
- func (*ContainerID) ProtoMessage()
- func (x *ContainerID) ProtoReflect() protoreflect.Message
- func (x *ContainerID) Reset()
- func (m *ContainerID) SetValue(v []byte)
- func (x *ContainerID) String() string
- type ObjectID
- type OwnerID
- type Signature
- func (*Signature) Descriptor() ([]byte, []int)deprecated
- func (x *Signature) GetKey() []byte
- func (x *Signature) GetSign() []byte
- func (*Signature) ProtoMessage()
- func (x *Signature) ProtoReflect() protoreflect.Message
- func (x *Signature) Reset()
- func (m *Signature) SetKey(v []byte)
- func (m *Signature) SetSign(v []byte)
- func (x *Signature) String() string
- type Version
- func (*Version) Descriptor() ([]byte, []int)deprecated
- func (x *Version) GetMajor() uint32
- func (x *Version) GetMinor() uint32
- func (*Version) ProtoMessage()
- func (x *Version) ProtoReflect() protoreflect.Message
- func (x *Version) Reset()
- func (m *Version) SetMajor(v uint32)
- func (m *Version) SetMinor(v uint32)
- func (x *Version) String() string
Constants ¶
This section is empty.
Variables ¶
var ( ChecksumType_name = map[int32]string{ 0: "CHECKSUM_TYPE_UNSPECIFIED", 1: "TZ", 2: "SHA256", } ChecksumType_value = map[string]int32{ "CHECKSUM_TYPE_UNSPECIFIED": 0, "TZ": 1, "SHA256": 2, } )
Enum value maps for ChecksumType.
var File_v2_refs_grpc_types_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Address ¶
type Address struct { // Container identifier ContainerId *ContainerID `protobuf:"bytes,1,opt,name=container_id,json=containerID,proto3" json:"container_id,omitempty"` // Object identifier ObjectId *ObjectID `protobuf:"bytes,2,opt,name=object_id,json=objectID,proto3" json:"object_id,omitempty"` // contains filtered or unexported fields }
Object in NeoFS can be addressed by it's ContainerID and ObjectID. In string format there MUST be a '/' delimeter between them.
func (*Address) Descriptor
deprecated
func (*Address) GetContainerId ¶
func (x *Address) GetContainerId() *ContainerID
func (*Address) GetObjectId ¶
func (*Address) ProtoMessage ¶
func (*Address) ProtoMessage()
func (*Address) ProtoReflect ¶
func (x *Address) ProtoReflect() protoreflect.Message
func (*Address) SetContainerId ¶
func (m *Address) SetContainerId(v *ContainerID)
SetContainerId sets container identifier of the address.
func (*Address) SetObjectId ¶
SetObjectId sets object identifier of the address.
type Checksum ¶
type Checksum struct { // Checksum algorithm type Type ChecksumType `protobuf:"varint,1,opt,name=type,proto3,enum=neo.fs.v2.refs.ChecksumType" json:"type,omitempty"` // Checksum itself Sum []byte `protobuf:"bytes,2,opt,name=sum,proto3" json:"sum,omitempty"` // contains filtered or unexported fields }
Checksum message.
func (*Checksum) Descriptor
deprecated
func (*Checksum) GetType ¶
func (x *Checksum) GetType() ChecksumType
func (*Checksum) ProtoMessage ¶
func (*Checksum) ProtoMessage()
func (*Checksum) ProtoReflect ¶
func (x *Checksum) ProtoReflect() protoreflect.Message
func (*Checksum) SetChecksumType ¶
func (m *Checksum) SetChecksumType(v ChecksumType)
SetChecksumType in generic checksum structure.
type ChecksumType ¶
type ChecksumType int32
Checksum algorithm type.
const ( // Unknown. Not used ChecksumType_CHECKSUM_TYPE_UNSPECIFIED ChecksumType = 0 // Tillich-Zemor homomorphic hash function ChecksumType_TZ ChecksumType = 1 // SHA-256 ChecksumType_SHA256 ChecksumType = 2 )
func (ChecksumType) Descriptor ¶
func (ChecksumType) Descriptor() protoreflect.EnumDescriptor
func (ChecksumType) Enum ¶
func (x ChecksumType) Enum() *ChecksumType
func (ChecksumType) EnumDescriptor
deprecated
func (ChecksumType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ChecksumType.Descriptor instead.
func (ChecksumType) Number ¶
func (x ChecksumType) Number() protoreflect.EnumNumber
func (ChecksumType) String ¶
func (x ChecksumType) String() string
func (ChecksumType) Type ¶
func (ChecksumType) Type() protoreflect.EnumType
type ContainerID ¶
type ContainerID struct { // Container identifier in a binary format. Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
NeoFS container identifier. Container structures are immutable and content-addressed. `ContainerID` is a 32 byte long SHA256 hash of stable-marshalled container message.
func (*ContainerID) Descriptor
deprecated
func (*ContainerID) Descriptor() ([]byte, []int)
Deprecated: Use ContainerID.ProtoReflect.Descriptor instead.
func (*ContainerID) GetValue ¶
func (x *ContainerID) GetValue() []byte
func (*ContainerID) ProtoMessage ¶
func (*ContainerID) ProtoMessage()
func (*ContainerID) ProtoReflect ¶
func (x *ContainerID) ProtoReflect() protoreflect.Message
func (*ContainerID) Reset ¶
func (x *ContainerID) Reset()
func (*ContainerID) SetValue ¶
func (m *ContainerID) SetValue(v []byte)
SetValue sets container identifier in a binary format.
func (*ContainerID) String ¶
func (x *ContainerID) String() string
type ObjectID ¶
type ObjectID struct { // Object identifier in a binary format Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
NeoFS Object unique identifier. Objects are immutable and content-addressed. It means `ObjectID` will change if `header` or `payload` changes. `ObjectID` is calculated as a hash of `header` field, which contains hash of object's payload.
func (*ObjectID) Descriptor
deprecated
func (*ObjectID) ProtoMessage ¶
func (*ObjectID) ProtoMessage()
func (*ObjectID) ProtoReflect ¶
func (x *ObjectID) ProtoReflect() protoreflect.Message
type OwnerID ¶
type OwnerID struct { // Identifier of the container owner in a binary format Value []byte `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
OwnerID is a derivative of a user's main public key. The transformation algorithm is the same as for Neo3 wallet addresses. Neo3 wallet address can be directly used as `OwnerID`.
func (*OwnerID) Descriptor
deprecated
func (*OwnerID) ProtoMessage ¶
func (*OwnerID) ProtoMessage()
func (*OwnerID) ProtoReflect ¶
func (x *OwnerID) ProtoReflect() protoreflect.Message
type Signature ¶
type Signature struct { // Public key used for signing Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` // Signature Sign []byte `protobuf:"bytes,2,opt,name=sign,json=signature,proto3" json:"sign,omitempty"` // contains filtered or unexported fields }
Signature of something in NeoFS.
func (*Signature) Descriptor
deprecated
func (*Signature) ProtoMessage ¶
func (*Signature) ProtoMessage()
func (*Signature) ProtoReflect ¶
func (x *Signature) ProtoReflect() protoreflect.Message
type Version ¶
type Version struct { // Major API version Major uint32 `protobuf:"varint,1,opt,name=major,proto3" json:"major,omitempty"` // Minor API version Minor uint32 `protobuf:"varint,2,opt,name=minor,proto3" json:"minor,omitempty"` // contains filtered or unexported fields }
API version used by a node.
func (*Version) Descriptor
deprecated
func (*Version) ProtoMessage ¶
func (*Version) ProtoMessage()
func (*Version) ProtoReflect ¶
func (x *Version) ProtoReflect() protoreflect.Message