object

package
v2.12.1 Latest Latest
Warning

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

 Go to latest Published: Mar 15, 2022 License: Apache-2.0 Imports: 12 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	StatusCommon_name = map[int32]string{
		0: "ACCESS_DENIED",
	}
	StatusCommon_value = map[string]int32{
		"ACCESS_DENIED": 0,
	}
)

Enum value maps for StatusCommon.

View Source 
var (
	StatusPut_name = map[int32]string{
		0: "STATUS_PUT_INCOMPLETE",
	}
	StatusPut_value = map[string]int32{
		"STATUS_PUT_INCOMPLETE": 0,
	}
)

Enum value maps for StatusPut.

View Source 
var (
	ObjectType_name = map[int32]string{
		0: "REGULAR",
		1: "TOMBSTONE",
		2: "STORAGE_GROUP",
		3: "LOCK",
	}
	ObjectType_value = map[string]int32{
		"REGULAR":       0,
		"TOMBSTONE":     1,
		"STORAGE_GROUP": 2,
		"LOCK":          3,
	}
)

Enum value maps for ObjectType.

View Source 
var (
	MatchType_name = map[int32]string{
		0: "MATCH_TYPE_UNSPECIFIED",
		1: "STRING_EQUAL",
		2: "STRING_NOT_EQUAL",
		3: "NOT_PRESENT",
		4: "COMMON_PREFIX",
	}
	MatchType_value = map[string]int32{
		"MATCH_TYPE_UNSPECIFIED": 0,
		"STRING_EQUAL":           1,
		"STRING_NOT_EQUAL":       2,
		"NOT_PRESENT":            3,
		"COMMON_PREFIX":          4,
	}
)

Enum value maps for MatchType.

View Source 
var ErrNilObjectServiceClient = errors.New("object gRPC client is nil")

ErrNilObjectServiceClient is returned by functions that expect a non-nil ObjectServiceClient, but received nil.

View Source 
var File_object_grpc_service_proto protoreflect.FileDescriptor
View Source 
var File_object_grpc_types_proto protoreflect.FileDescriptor
View Source 
var File_v2_object_grpc_status_proto protoreflect.FileDescriptor
View Source 
var ObjectService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "neo.fs.v2.object.ObjectService",
	HandlerType: (*ObjectServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Delete",
			Handler:    _ObjectService_Delete_Handler,
		},
		{
			MethodName: "Head",
			Handler:    _ObjectService_Head_Handler,
		},
		{
			MethodName: "GetRangeHash",
			Handler:    _ObjectService_GetRangeHash_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Get",
			Handler:       _ObjectService_Get_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "Put",
			Handler:       _ObjectService_Put_Handler,
			ClientStreams: true,
		},
		{
			StreamName:    "Search",
			Handler:       _ObjectService_Search_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "GetRange",
			Handler:       _ObjectService_GetRange_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "object/grpc/service.proto",
}

ObjectService_ServiceDesc is the grpc.ServiceDesc for ObjectService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterObjectServiceServer 

func RegisterObjectServiceServer(s grpc.ServiceRegistrar, srv ObjectServiceServer)

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client wraps ObjectServiceClient with pre-defined configurations.

func NewClient 

func NewClient(c ObjectServiceClient, opts ...Option) (*Client, error)

NewClient creates, initializes and returns a new Client instance.

Options are applied one by one in order.

func (*Client) Delete 

func (c *Client) Delete(ctx context.Context, req *DeleteRequest) (*DeleteResponse, error)

func (*Client) Get 

func (c *Client) Get(ctx context.Context, req *GetRequest) (ObjectService_GetClient, error)

func (*Client) GetRange 

func (c *Client) GetRange(ctx context.Context, req *GetRangeRequest) (ObjectService_GetRangeClient, error)

func (*Client) GetRangeHash 

func (c *Client) GetRangeHash(ctx context.Context, req *GetRangeHashRequest) (*GetRangeHashResponse, error)

func (*Client) Head 

func (c *Client) Head(ctx context.Context, req *HeadRequest) (*HeadResponse, error)

func (*Client) Put 

func (c *Client) Put(ctx context.Context) (ObjectService_PutClient, error)

func (*Client) Search 

func (c *Client) Search(ctx context.Context, req *SearchRequest) (ObjectService_SearchClient, error)

type DeleteRequest 

type DeleteRequest struct {

	// Body of delete object request message.
	Body *DeleteRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Object DELETE request

func (*DeleteRequest) Descriptor deprecated 

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

Deprecated: Use DeleteRequest.ProtoReflect.Descriptor instead.

func (*DeleteRequest) GetBody 

func (x *DeleteRequest) GetBody() *DeleteRequest_Body

func (*DeleteRequest) GetMetaHeader 

func (x *DeleteRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*DeleteRequest) GetVerifyHeader 

func (x *DeleteRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*DeleteRequest) ProtoMessage 

func (*DeleteRequest) ProtoMessage()

func (*DeleteRequest) ProtoReflect 

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

func (*DeleteRequest) Reset 

func (x *DeleteRequest) Reset()

func (*DeleteRequest) SetBody 

func (m *DeleteRequest) SetBody(v *DeleteRequest_Body)

SetBody sets body of the request.

func (*DeleteRequest) SetMetaHeader 

func (m *DeleteRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*DeleteRequest) SetVerifyHeader 

func (m *DeleteRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*DeleteRequest) String 

func (x *DeleteRequest) String() string

type DeleteRequest_Body 

type DeleteRequest_Body struct {

	// Address of the object to be deleted
	Address *grpc1.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// contains filtered or unexported fields
}

Object DELETE request body

func (*DeleteRequest_Body) Descriptor deprecated 

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

Deprecated: Use DeleteRequest_Body.ProtoReflect.Descriptor instead.

func (*DeleteRequest_Body) GetAddress 

func (x *DeleteRequest_Body) GetAddress() *grpc1.Address

func (*DeleteRequest_Body) ProtoMessage 

func (*DeleteRequest_Body) ProtoMessage()

func (*DeleteRequest_Body) ProtoReflect 

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

func (*DeleteRequest_Body) Reset 

func (x *DeleteRequest_Body) Reset()

func (*DeleteRequest_Body) SetAddress 

func (m *DeleteRequest_Body) SetAddress(v *refs.Address)

SetAddress sets address of the object to delete.

func (*DeleteRequest_Body) String 

func (x *DeleteRequest_Body) String() string

type DeleteResponse 

type DeleteResponse struct {

	// Body of delete object response message.
	Body *DeleteResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

DeleteResponse body is empty because we cannot guarantee permanent object removal in distributed system.

func (*DeleteResponse) Descriptor deprecated 

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

Deprecated: Use DeleteResponse.ProtoReflect.Descriptor instead.

func (*DeleteResponse) GetBody 

func (x *DeleteResponse) GetBody() *DeleteResponse_Body

func (*DeleteResponse) GetMetaHeader 

func (x *DeleteResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*DeleteResponse) GetVerifyHeader 

func (x *DeleteResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*DeleteResponse) ProtoMessage 

func (*DeleteResponse) ProtoMessage()

func (*DeleteResponse) ProtoReflect 

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

func (*DeleteResponse) Reset 

func (x *DeleteResponse) Reset()

func (*DeleteResponse) SetBody 

func (m *DeleteResponse) SetBody(v *DeleteResponse_Body)

SetBody sets body of the response.

func (*DeleteResponse) SetMetaHeader 

func (m *DeleteResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*DeleteResponse) SetVerifyHeader 

func (m *DeleteResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*DeleteResponse) String 

func (x *DeleteResponse) String() string

type DeleteResponse_Body 

type DeleteResponse_Body struct {

	// Address of the tombstone created for the deleted object
	Tombstone *grpc1.Address `protobuf:"bytes,1,opt,name=tombstone,proto3" json:"tombstone,omitempty"`
	// contains filtered or unexported fields
}

Object DELETE Response has an empty body.

func (*DeleteResponse_Body) Descriptor deprecated 

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

Deprecated: Use DeleteResponse_Body.ProtoReflect.Descriptor instead.

func (*DeleteResponse_Body) GetTombstone 

func (x *DeleteResponse_Body) GetTombstone() *grpc1.Address

func (*DeleteResponse_Body) ProtoMessage 

func (*DeleteResponse_Body) ProtoMessage()

func (*DeleteResponse_Body) ProtoReflect 

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

func (*DeleteResponse_Body) Reset 

func (x *DeleteResponse_Body) Reset()

func (*DeleteResponse_Body) SetTombstone 

func (x *DeleteResponse_Body) SetTombstone(v *refs.Address)

SetTombstone sets tombstone address.

func (*DeleteResponse_Body) String 

func (x *DeleteResponse_Body) String() string

type GetRangeHashRequest 

type GetRangeHashRequest struct {

	// Body of get range hash object request message.
	Body *GetRangeHashRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Get hash of object's payload part

func (*GetRangeHashRequest) Descriptor deprecated 

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

Deprecated: Use GetRangeHashRequest.ProtoReflect.Descriptor instead.

func (*GetRangeHashRequest) GetBody 

func (x *GetRangeHashRequest) GetBody() *GetRangeHashRequest_Body

func (*GetRangeHashRequest) GetMetaHeader 

func (x *GetRangeHashRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*GetRangeHashRequest) GetVerifyHeader 

func (x *GetRangeHashRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*GetRangeHashRequest) ProtoMessage 

func (*GetRangeHashRequest) ProtoMessage()

func (*GetRangeHashRequest) ProtoReflect 

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

func (*GetRangeHashRequest) Reset 

func (x *GetRangeHashRequest) Reset()

func (*GetRangeHashRequest) SetBody 

func (m *GetRangeHashRequest) SetBody(v *GetRangeHashRequest_Body)

SetBody sets body of the request.

func (*GetRangeHashRequest) SetMetaHeader 

func (m *GetRangeHashRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*GetRangeHashRequest) SetVerifyHeader 

func (m *GetRangeHashRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*GetRangeHashRequest) String 

func (x *GetRangeHashRequest) String() string

type GetRangeHashRequest_Body 

type GetRangeHashRequest_Body struct {

	// Address of the object that containing the requested payload range
	Address *grpc1.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// List of object's payload ranges to calculate homomorphic hash
	Ranges []*Range `protobuf:"bytes,2,rep,name=ranges,proto3" json:"ranges,omitempty"`
	// Binary salt to XOR object's payload ranges before hash calculation
	Salt []byte `protobuf:"bytes,3,opt,name=salt,proto3" json:"salt,omitempty"`
	// Checksum algorithm type
	Type grpc1.ChecksumType `protobuf:"varint,4,opt,name=type,proto3,enum=neo.fs.v2.refs.ChecksumType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

Get hash of object's payload part request body.

func (*GetRangeHashRequest_Body) Descriptor deprecated 

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

Deprecated: Use GetRangeHashRequest_Body.ProtoReflect.Descriptor instead.

func (*GetRangeHashRequest_Body) GetAddress 

func (x *GetRangeHashRequest_Body) GetAddress() *grpc1.Address

func (*GetRangeHashRequest_Body) GetRanges 

func (x *GetRangeHashRequest_Body) GetRanges() []*Range

func (*GetRangeHashRequest_Body) GetSalt 

func (x *GetRangeHashRequest_Body) GetSalt() []byte

func (*GetRangeHashRequest_Body) GetType 

func (x *GetRangeHashRequest_Body) GetType() grpc1.ChecksumType

func (*GetRangeHashRequest_Body) ProtoMessage 

func (*GetRangeHashRequest_Body) ProtoMessage()

func (*GetRangeHashRequest_Body) ProtoReflect 

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

func (*GetRangeHashRequest_Body) Reset 

func (x *GetRangeHashRequest_Body) Reset()

func (*GetRangeHashRequest_Body) SetAddress 

func (m *GetRangeHashRequest_Body) SetAddress(v *refs.Address)

SetAddress sets address of the object with the request payload range.

func (*GetRangeHashRequest_Body) SetRanges 

func (m *GetRangeHashRequest_Body) SetRanges(v []*Range)

SetRanges sets list of the ranges of the object payload.

func (*GetRangeHashRequest_Body) SetSalt 

func (m *GetRangeHashRequest_Body) SetSalt(v []byte)

SetSalt sets salt for the object payload ranges.

func (*GetRangeHashRequest_Body) SetType 

func (m *GetRangeHashRequest_Body) SetType(v refs.ChecksumType)

Set sets salt for the object payload ranges.

func (*GetRangeHashRequest_Body) String 

func (x *GetRangeHashRequest_Body) String() string

type GetRangeHashResponse 

type GetRangeHashResponse struct {

	// Body of get range hash object response message.
	Body *GetRangeHashResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Get hash of object's payload part

func (*GetRangeHashResponse) Descriptor deprecated 

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

Deprecated: Use GetRangeHashResponse.ProtoReflect.Descriptor instead.

func (*GetRangeHashResponse) GetBody 

func (x *GetRangeHashResponse) GetBody() *GetRangeHashResponse_Body

func (*GetRangeHashResponse) GetMetaHeader 

func (x *GetRangeHashResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*GetRangeHashResponse) GetVerifyHeader 

func (x *GetRangeHashResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*GetRangeHashResponse) ProtoMessage 

func (*GetRangeHashResponse) ProtoMessage()

func (*GetRangeHashResponse) ProtoReflect 

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

func (*GetRangeHashResponse) Reset 

func (x *GetRangeHashResponse) Reset()

func (*GetRangeHashResponse) SetBody 

func (m *GetRangeHashResponse) SetBody(v *GetRangeHashResponse_Body)

SetBody sets body of the response.

func (*GetRangeHashResponse) SetMetaHeader 

func (m *GetRangeHashResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*GetRangeHashResponse) SetVerifyHeader 

func (m *GetRangeHashResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*GetRangeHashResponse) String 

func (x *GetRangeHashResponse) String() string

type GetRangeHashResponse_Body 

type GetRangeHashResponse_Body struct {

	// Checksum algorithm type
	Type grpc1.ChecksumType `protobuf:"varint,1,opt,name=type,proto3,enum=neo.fs.v2.refs.ChecksumType" json:"type,omitempty"`
	// List of range hashes in a binary format
	HashList [][]byte `protobuf:"bytes,2,rep,name=hash_list,json=hashList,proto3" json:"hash_list,omitempty"`
	// contains filtered or unexported fields
}

Get hash of object's payload part response body.

func (*GetRangeHashResponse_Body) Descriptor deprecated 

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

Deprecated: Use GetRangeHashResponse_Body.ProtoReflect.Descriptor instead.

func (*GetRangeHashResponse_Body) GetHashList 

func (x *GetRangeHashResponse_Body) GetHashList() [][]byte

func (*GetRangeHashResponse_Body) GetType 

func (x *GetRangeHashResponse_Body) GetType() grpc1.ChecksumType

func (*GetRangeHashResponse_Body) ProtoMessage 

func (*GetRangeHashResponse_Body) ProtoMessage()

func (*GetRangeHashResponse_Body) ProtoReflect 

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

func (*GetRangeHashResponse_Body) Reset 

func (x *GetRangeHashResponse_Body) Reset()

func (*GetRangeHashResponse_Body) SetHashList 

func (m *GetRangeHashResponse_Body) SetHashList(v [][]byte)

SetHashList returns list of the range hashes.

func (*GetRangeHashResponse_Body) SetType 

func (m *GetRangeHashResponse_Body) SetType(v refs.ChecksumType)

SetHashList returns list of the range hashes.

func (*GetRangeHashResponse_Body) String 

func (x *GetRangeHashResponse_Body) String() string

type GetRangeRequest 

type GetRangeRequest struct {

	// Body of get range object request message.
	Body *GetRangeRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Request part of object's payload

func (*GetRangeRequest) Descriptor deprecated 

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

Deprecated: Use GetRangeRequest.ProtoReflect.Descriptor instead.

func (*GetRangeRequest) GetBody 

func (x *GetRangeRequest) GetBody() *GetRangeRequest_Body

func (*GetRangeRequest) GetMetaHeader 

func (x *GetRangeRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*GetRangeRequest) GetVerifyHeader 

func (x *GetRangeRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*GetRangeRequest) ProtoMessage 

func (*GetRangeRequest) ProtoMessage()

func (*GetRangeRequest) ProtoReflect 

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

func (*GetRangeRequest) Reset 

func (x *GetRangeRequest) Reset()

func (*GetRangeRequest) SetBody 

func (m *GetRangeRequest) SetBody(v *GetRangeRequest_Body)

SetBody sets body of the request.

func (*GetRangeRequest) SetMetaHeader 

func (m *GetRangeRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*GetRangeRequest) SetVerifyHeader 

func (m *GetRangeRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*GetRangeRequest) String 

func (x *GetRangeRequest) String() string

type GetRangeRequest_Body 

type GetRangeRequest_Body struct {

	// Address of the object containing the requested payload range
	Address *grpc1.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// Requested payload range
	Range *Range `protobuf:"bytes,2,opt,name=range,proto3" json:"range,omitempty"`
	// If `raw` flag is set, request will work only with objects that are
	// physically stored on the peer node.
	Raw bool `protobuf:"varint,3,opt,name=raw,proto3" json:"raw,omitempty"`
	// contains filtered or unexported fields
}

Byte range of object's payload request body

func (*GetRangeRequest_Body) Descriptor deprecated 

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

Deprecated: Use GetRangeRequest_Body.ProtoReflect.Descriptor instead.

func (*GetRangeRequest_Body) GetAddress 

func (x *GetRangeRequest_Body) GetAddress() *grpc1.Address

func (*GetRangeRequest_Body) GetRange 

func (x *GetRangeRequest_Body) GetRange() *Range

func (*GetRangeRequest_Body) GetRaw 

func (x *GetRangeRequest_Body) GetRaw() bool

func (*GetRangeRequest_Body) ProtoMessage 

func (*GetRangeRequest_Body) ProtoMessage()

func (*GetRangeRequest_Body) ProtoReflect 

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

func (*GetRangeRequest_Body) Reset 

func (x *GetRangeRequest_Body) Reset()

func (*GetRangeRequest_Body) SetAddress 

func (m *GetRangeRequest_Body) SetAddress(v *refs.Address)

SetAddress sets address of the object with the request payload range.

func (*GetRangeRequest_Body) SetRange 

func (m *GetRangeRequest_Body) SetRange(v *Range)

SetRange sets range of the object payload.

func (*GetRangeRequest_Body) SetRaw 

func (m *GetRangeRequest_Body) SetRaw(v bool)

SetRaw sets raw flag of the request.

func (*GetRangeRequest_Body) String 

func (x *GetRangeRequest_Body) String() string

type GetRangeResponse 

type GetRangeResponse struct {

	// Body of get range object response message.
	Body *GetRangeResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Get part of object's payload

func (*GetRangeResponse) Descriptor deprecated 

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

Deprecated: Use GetRangeResponse.ProtoReflect.Descriptor instead.

func (*GetRangeResponse) GetBody 

func (x *GetRangeResponse) GetBody() *GetRangeResponse_Body

func (*GetRangeResponse) GetMetaHeader 

func (x *GetRangeResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*GetRangeResponse) GetVerifyHeader 

func (x *GetRangeResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*GetRangeResponse) ProtoMessage 

func (*GetRangeResponse) ProtoMessage()

func (*GetRangeResponse) ProtoReflect 

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

func (*GetRangeResponse) Reset 

func (x *GetRangeResponse) Reset()

func (*GetRangeResponse) SetBody 

func (m *GetRangeResponse) SetBody(v *GetRangeResponse_Body)

SetBody sets body of the response.

func (*GetRangeResponse) SetMetaHeader 

func (m *GetRangeResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*GetRangeResponse) SetVerifyHeader 

func (m *GetRangeResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*GetRangeResponse) String 

func (x *GetRangeResponse) String() string

type GetRangeResponse_Body 

type GetRangeResponse_Body struct {

	// Requested object range or meta information about split object.
	//
	// Types that are assignable to RangePart:
	//	*GetRangeResponse_Body_Chunk
	//	*GetRangeResponse_Body_SplitInfo
	RangePart isGetRangeResponse_Body_RangePart `protobuf_oneof:"range_part"`
	// contains filtered or unexported fields
}

Get Range response body uses streams to transfer the response. Because object payload considered a byte sequence, there is no need to have some initial preamble message. The requested byte range is sent as a series chunks.

func (*GetRangeResponse_Body) Descriptor deprecated 

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

Deprecated: Use GetRangeResponse_Body.ProtoReflect.Descriptor instead.

func (*GetRangeResponse_Body) GetChunk 

func (x *GetRangeResponse_Body) GetChunk() []byte

func (*GetRangeResponse_Body) GetRangePart 

func (m *GetRangeResponse_Body) GetRangePart() isGetRangeResponse_Body_RangePart

func (*GetRangeResponse_Body) GetSplitInfo 

func (x *GetRangeResponse_Body) GetSplitInfo() *SplitInfo

func (*GetRangeResponse_Body) ProtoMessage 

func (*GetRangeResponse_Body) ProtoMessage()

func (*GetRangeResponse_Body) ProtoReflect 

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

func (*GetRangeResponse_Body) Reset 

func (x *GetRangeResponse_Body) Reset()

func (*GetRangeResponse_Body) SetChunk 

func (m *GetRangeResponse_Body) SetChunk(v *GetRangeResponse_Body_Chunk)

SetChunk sets chunk of the object payload.

func (*GetRangeResponse_Body) SetSplitInfo 

func (m *GetRangeResponse_Body) SetSplitInfo(v *SplitInfo)

SetSplitInfo sets meta info about split hierarchy of the object.

func (*GetRangeResponse_Body) String 

func (x *GetRangeResponse_Body) String() string

type GetRangeResponse_Body_Chunk 

type GetRangeResponse_Body_Chunk struct {
	// Chunked object payload's range.
	Chunk []byte `protobuf:"bytes,1,opt,name=chunk,proto3,oneof"`
}

func (*GetRangeResponse_Body_Chunk) GetChunk 

func (m *GetRangeResponse_Body_Chunk) GetChunk() []byte

GetChunk returns chunk of the object payload range bytes.

func (*GetRangeResponse_Body_Chunk) SetChunk 

func (m *GetRangeResponse_Body_Chunk) SetChunk(v []byte)

SetChunk sets chunk of the object payload range bytes.

type GetRangeResponse_Body_SplitInfo 

type GetRangeResponse_Body_SplitInfo struct {
	// Meta information of split hierarchy.
	SplitInfo *SplitInfo `protobuf:"bytes,2,opt,name=split_info,json=splitInfo,proto3,oneof"`
}

type GetRequest 

type GetRequest struct {

	// Body of get object request message.
	Body *GetRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

GET object request

func (*GetRequest) Descriptor deprecated 

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

Deprecated: Use GetRequest.ProtoReflect.Descriptor instead.

func (*GetRequest) GetBody 

func (x *GetRequest) GetBody() *GetRequest_Body

func (*GetRequest) GetMetaHeader 

func (x *GetRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*GetRequest) GetVerifyHeader 

func (x *GetRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*GetRequest) ProtoMessage 

func (*GetRequest) ProtoMessage()

func (*GetRequest) ProtoReflect 

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

func (*GetRequest) Reset 

func (x *GetRequest) Reset()

func (*GetRequest) SetBody 

func (m *GetRequest) SetBody(v *GetRequest_Body)

SetBody sets body of the request.

func (*GetRequest) SetMetaHeader 

func (m *GetRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*GetRequest) SetVerifyHeader 

func (m *GetRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*GetRequest) String 

func (x *GetRequest) String() string

type GetRequest_Body 

type GetRequest_Body struct {

	// Address of the requested object
	Address *grpc1.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// If `raw` flag is set, request will work only with objects that are
	// physically stored on the peer node
	Raw bool `protobuf:"varint,2,opt,name=raw,proto3" json:"raw,omitempty"`
	// contains filtered or unexported fields
}

GET Object request body

func (*GetRequest_Body) Descriptor deprecated 

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

Deprecated: Use GetRequest_Body.ProtoReflect.Descriptor instead.

func (*GetRequest_Body) GetAddress 

func (x *GetRequest_Body) GetAddress() *grpc1.Address

func (*GetRequest_Body) GetRaw 

func (x *GetRequest_Body) GetRaw() bool

func (*GetRequest_Body) ProtoMessage 

func (*GetRequest_Body) ProtoMessage()

func (*GetRequest_Body) ProtoReflect 

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

func (*GetRequest_Body) Reset 

func (x *GetRequest_Body) Reset()

func (*GetRequest_Body) SetAddress 

func (m *GetRequest_Body) SetAddress(v *refs.Address)

SetAddress sets address of the requested object.

func (*GetRequest_Body) SetRaw 

func (m *GetRequest_Body) SetRaw(v bool)

SetRaw sets raw flag of the request.

func (*GetRequest_Body) String 

func (x *GetRequest_Body) String() string

type GetResponse 

type GetResponse struct {

	// Body of get object response message.
	Body *GetResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

GET object response

func (*GetResponse) Descriptor deprecated 

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

Deprecated: Use GetResponse.ProtoReflect.Descriptor instead.

func (*GetResponse) GetBody 

func (x *GetResponse) GetBody() *GetResponse_Body

func (*GetResponse) GetMetaHeader 

func (x *GetResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*GetResponse) GetVerifyHeader 

func (x *GetResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*GetResponse) ProtoMessage 

func (*GetResponse) ProtoMessage()

func (*GetResponse) ProtoReflect 

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

func (*GetResponse) Reset 

func (x *GetResponse) Reset()

func (*GetResponse) SetBody 

func (m *GetResponse) SetBody(v *GetResponse_Body)

SetBody sets body of the response.

func (*GetResponse) SetMetaHeader 

func (m *GetResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*GetResponse) SetVerifyHeader 

func (m *GetResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*GetResponse) String 

func (x *GetResponse) String() string

type GetResponse_Body 

type GetResponse_Body struct {

	// Single message in the response stream.
	//
	// Types that are assignable to ObjectPart:
	//	*GetResponse_Body_Init_
	//	*GetResponse_Body_Chunk
	//	*GetResponse_Body_SplitInfo
	ObjectPart isGetResponse_Body_ObjectPart `protobuf_oneof:"object_part"`
	// contains filtered or unexported fields
}

GET Object Response body

func (*GetResponse_Body) Descriptor deprecated 

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

Deprecated: Use GetResponse_Body.ProtoReflect.Descriptor instead.

func (*GetResponse_Body) GetChunk 

func (x *GetResponse_Body) GetChunk() []byte

func (*GetResponse_Body) GetInit 

func (x *GetResponse_Body) GetInit() *GetResponse_Body_Init

func (*GetResponse_Body) GetObjectPart 

func (m *GetResponse_Body) GetObjectPart() isGetResponse_Body_ObjectPart

func (*GetResponse_Body) GetSplitInfo 

func (x *GetResponse_Body) GetSplitInfo() *SplitInfo

func (*GetResponse_Body) ProtoMessage 

func (*GetResponse_Body) ProtoMessage()

func (*GetResponse_Body) ProtoReflect 

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

func (*GetResponse_Body) Reset 

func (x *GetResponse_Body) Reset()

func (*GetResponse_Body) SetChunk 

func (m *GetResponse_Body) SetChunk(v *GetResponse_Body_Chunk)

SetChunk sets part of the object payload.

func (*GetResponse_Body) SetInit 

func (m *GetResponse_Body) SetInit(v *GetResponse_Body_Init)

SetInit sets initial part of the object.

func (*GetResponse_Body) SetSplitInfo 

func (m *GetResponse_Body) SetSplitInfo(v *SplitInfo)

SetSplitInfo sets part of the object payload.

func (*GetResponse_Body) String 

func (x *GetResponse_Body) String() string

type GetResponse_Body_Chunk 

type GetResponse_Body_Chunk struct {
	// Chunked object payload
	Chunk []byte `protobuf:"bytes,2,opt,name=chunk,proto3,oneof"`
}

func (*GetResponse_Body_Chunk) GetChunk 

func (m *GetResponse_Body_Chunk) GetChunk() []byte

GetChunk returns chunk of the object payload bytes.

func (*GetResponse_Body_Chunk) SetChunk 

func (m *GetResponse_Body_Chunk) SetChunk(v []byte)

SetChunk sets chunk of the object payload bytes.

type GetResponse_Body_Init 

type GetResponse_Body_Init struct {

	// Object's unique identifier.
	ObjectId *grpc1.ObjectID `protobuf:"bytes,1,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// Signed `ObjectID`
	Signature *grpc1.Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// Object metadata headers
	Header *Header `protobuf:"bytes,3,opt,name=header,proto3" json:"header,omitempty"`
	// contains filtered or unexported fields
}

Initial part of the `Object` structure stream. Technically it's a set of all `Object` structure's fields except `payload`.

func (*GetResponse_Body_Init) Descriptor deprecated 

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

Deprecated: Use GetResponse_Body_Init.ProtoReflect.Descriptor instead.

func (*GetResponse_Body_Init) GetHeader 

func (x *GetResponse_Body_Init) GetHeader() *Header

func (*GetResponse_Body_Init) GetObjectId 

func (x *GetResponse_Body_Init) GetObjectId() *grpc1.ObjectID

func (*GetResponse_Body_Init) GetSignature 

func (x *GetResponse_Body_Init) GetSignature() *grpc1.Signature

func (*GetResponse_Body_Init) ProtoMessage 

func (*GetResponse_Body_Init) ProtoMessage()

func (*GetResponse_Body_Init) ProtoReflect 

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

func (*GetResponse_Body_Init) Reset 

func (x *GetResponse_Body_Init) Reset()

func (*GetResponse_Body_Init) SetHeader 

func (m *GetResponse_Body_Init) SetHeader(v *Header)

SetHeader sets header of the object.

func (*GetResponse_Body_Init) SetObjectId 

func (m *GetResponse_Body_Init) SetObjectId(v *refs.ObjectID)

SetObjectId sets identifier of the object.

func (*GetResponse_Body_Init) SetSignature 

func (m *GetResponse_Body_Init) SetSignature(v *refs.Signature)

SetSignature sets signature of the object identifier.

func (*GetResponse_Body_Init) String 

func (x *GetResponse_Body_Init) String() string

type GetResponse_Body_Init_ 

type GetResponse_Body_Init_ struct {
	// Initial part of the object stream
	Init *GetResponse_Body_Init `protobuf:"bytes,1,opt,name=init,proto3,oneof"`
}

type GetResponse_Body_SplitInfo 

type GetResponse_Body_SplitInfo struct {
	// Meta information of split hierarchy for object assembly.
	SplitInfo *SplitInfo `protobuf:"bytes,3,opt,name=split_info,json=splitInfo,proto3,oneof"`
}

type HeadRequest 

type HeadRequest struct {

	// Body of head object request message.
	Body *HeadRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Object HEAD request

func (*HeadRequest) Descriptor deprecated 

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

Deprecated: Use HeadRequest.ProtoReflect.Descriptor instead.

func (*HeadRequest) GetBody 

func (x *HeadRequest) GetBody() *HeadRequest_Body

func (*HeadRequest) GetMetaHeader 

func (x *HeadRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*HeadRequest) GetVerifyHeader 

func (x *HeadRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*HeadRequest) ProtoMessage 

func (*HeadRequest) ProtoMessage()

func (*HeadRequest) ProtoReflect 

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

func (*HeadRequest) Reset 

func (x *HeadRequest) Reset()

func (*HeadRequest) SetBody 

func (m *HeadRequest) SetBody(v *HeadRequest_Body)

SetBody sets body of the request.

func (*HeadRequest) SetMetaHeader 

func (m *HeadRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*HeadRequest) SetVerifyHeader 

func (m *HeadRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*HeadRequest) String 

func (x *HeadRequest) String() string

type HeadRequest_Body 

type HeadRequest_Body struct {

	// Address of the object with the requested Header
	Address *grpc1.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// Return only minimal header subset
	MainOnly bool `protobuf:"varint,2,opt,name=main_only,json=mainOnly,proto3" json:"main_only,omitempty"`
	// If `raw` flag is set, request will work only with objects that are
	// physically stored on the peer node
	Raw bool `protobuf:"varint,3,opt,name=raw,proto3" json:"raw,omitempty"`
	// contains filtered or unexported fields
}

Object HEAD request body

func (*HeadRequest_Body) Descriptor deprecated 

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

Deprecated: Use HeadRequest_Body.ProtoReflect.Descriptor instead.

func (*HeadRequest_Body) GetAddress 

func (x *HeadRequest_Body) GetAddress() *grpc1.Address

func (*HeadRequest_Body) GetMainOnly 

func (x *HeadRequest_Body) GetMainOnly() bool

func (*HeadRequest_Body) GetRaw 

func (x *HeadRequest_Body) GetRaw() bool

func (*HeadRequest_Body) ProtoMessage 

func (*HeadRequest_Body) ProtoMessage()

func (*HeadRequest_Body) ProtoReflect 

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

func (*HeadRequest_Body) Reset 

func (x *HeadRequest_Body) Reset()

func (*HeadRequest_Body) SetAddress 

func (m *HeadRequest_Body) SetAddress(v *refs.Address)

SetAddress sets address of the object with the requested header.

func (*HeadRequest_Body) SetMainOnly 

func (m *HeadRequest_Body) SetMainOnly(v bool)

SetMainOnly sets flag to return the minimal header subset.

func (*HeadRequest_Body) SetRaw 

func (m *HeadRequest_Body) SetRaw(v bool)

SetRaw sets raw flag of the request.

func (*HeadRequest_Body) String 

func (x *HeadRequest_Body) String() string

type HeadResponse 

type HeadResponse struct {

	// Body of head object response message.
	Body *HeadResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Object HEAD response

func (*HeadResponse) Descriptor deprecated 

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

Deprecated: Use HeadResponse.ProtoReflect.Descriptor instead.

func (*HeadResponse) GetBody 

func (x *HeadResponse) GetBody() *HeadResponse_Body

func (*HeadResponse) GetMetaHeader 

func (x *HeadResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*HeadResponse) GetVerifyHeader 

func (x *HeadResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*HeadResponse) ProtoMessage 

func (*HeadResponse) ProtoMessage()

func (*HeadResponse) ProtoReflect 

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

func (*HeadResponse) Reset 

func (x *HeadResponse) Reset()

func (*HeadResponse) SetBody 

func (m *HeadResponse) SetBody(v *HeadResponse_Body)

SetBody sets body of the response.

func (*HeadResponse) SetMetaHeader 

func (m *HeadResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*HeadResponse) SetVerifyHeader 

func (m *HeadResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*HeadResponse) String 

func (x *HeadResponse) String() string

type HeadResponse_Body 

type HeadResponse_Body struct {

	// Requested object header, it's part or meta information about split
	// object.
	//
	// Types that are assignable to Head:
	//	*HeadResponse_Body_Header
	//	*HeadResponse_Body_ShortHeader
	//	*HeadResponse_Body_SplitInfo
	Head isHeadResponse_Body_Head `protobuf_oneof:"head"`
	// contains filtered or unexported fields
}

Object HEAD response body

func (*HeadResponse_Body) Descriptor deprecated 

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

Deprecated: Use HeadResponse_Body.ProtoReflect.Descriptor instead.

func (*HeadResponse_Body) GetHead 

func (m *HeadResponse_Body) GetHead() isHeadResponse_Body_Head

func (*HeadResponse_Body) GetHeader 

func (x *HeadResponse_Body) GetHeader() *HeaderWithSignature

func (*HeadResponse_Body) GetShortHeader 

func (x *HeadResponse_Body) GetShortHeader() *ShortHeader

func (*HeadResponse_Body) GetSplitInfo 

func (x *HeadResponse_Body) GetSplitInfo() *SplitInfo

func (*HeadResponse_Body) ProtoMessage 

func (*HeadResponse_Body) ProtoMessage()

func (*HeadResponse_Body) ProtoReflect 

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

func (*HeadResponse_Body) Reset 

func (x *HeadResponse_Body) Reset()

func (*HeadResponse_Body) SetHeader 

func (m *HeadResponse_Body) SetHeader(v *HeaderWithSignature)

SetHeader sets full header of the object.

func (*HeadResponse_Body) SetShortHeader 

func (m *HeadResponse_Body) SetShortHeader(v *ShortHeader)

SetShortHeader sets short header of the object.

func (*HeadResponse_Body) SetSplitInfo 

func (m *HeadResponse_Body) SetSplitInfo(v *SplitInfo)

SetSplitInfo sets meta info about split hierarchy of the object.

func (*HeadResponse_Body) String 

func (x *HeadResponse_Body) String() string

type HeadResponse_Body_Header 

type HeadResponse_Body_Header struct {
	// Full object's `Header` with `ObjectID` signature
	Header *HeaderWithSignature `protobuf:"bytes,1,opt,name=header,proto3,oneof"`
}

type HeadResponse_Body_ShortHeader 

type HeadResponse_Body_ShortHeader struct {
	// Short object header
	ShortHeader *ShortHeader `protobuf:"bytes,2,opt,name=short_header,json=shortHeader,proto3,oneof"`
}

type HeadResponse_Body_SplitInfo 

type HeadResponse_Body_SplitInfo struct {
	// Meta information of split hierarchy.
	SplitInfo *SplitInfo `protobuf:"bytes,3,opt,name=split_info,json=splitInfo,proto3,oneof"`
}
type Header struct {

	// Object format version. Effectively the version of API library used to
	// create particular object
	Version *grpc.Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Object's container
	ContainerId *grpc.ContainerID `protobuf:"bytes,2,opt,name=container_id,json=containerID,proto3" json:"container_id,omitempty"`
	// Object's owner
	OwnerId *grpc.OwnerID `protobuf:"bytes,3,opt,name=owner_id,json=ownerID,proto3" json:"owner_id,omitempty"`
	// Object creation Epoch
	CreationEpoch uint64 `protobuf:"varint,4,opt,name=creation_epoch,json=creationEpoch,proto3" json:"creation_epoch,omitempty"`
	// Size of payload in bytes.
	// `0xFFFFFFFFFFFFFFFF` means `payload_length` is unknown.
	PayloadLength uint64 `protobuf:"varint,5,opt,name=payload_length,json=payloadLength,proto3" json:"payload_length,omitempty"`
	// Hash of payload bytes
	PayloadHash *grpc.Checksum `protobuf:"bytes,6,opt,name=payload_hash,json=payloadHash,proto3" json:"payload_hash,omitempty"`
	// Type of the object payload content
	ObjectType ObjectType `protobuf:"varint,7,opt,name=object_type,json=objectType,proto3,enum=neo.fs.v2.object.ObjectType" json:"object_type,omitempty"`
	// Homomorphic hash of the object payload
	HomomorphicHash *grpc.Checksum `protobuf:"bytes,8,opt,name=homomorphic_hash,json=homomorphicHash,proto3" json:"homomorphic_hash,omitempty"`
	// Session token, if it was used during Object creation. Need it to verify
	// integrity and authenticity out of Request scope.
	SessionToken *grpc1.SessionToken `protobuf:"bytes,9,opt,name=session_token,json=sessionToken,proto3" json:"session_token,omitempty"`
	// User-defined object attributes
	Attributes []*Header_Attribute `protobuf:"bytes,10,rep,name=attributes,proto3" json:"attributes,omitempty"`
	// Position of the object in the split hierarchy
	Split *Header_Split `protobuf:"bytes,11,opt,name=split,proto3" json:"split,omitempty"`
	// contains filtered or unexported fields
}

Object Header

func (*Header) Descriptor deprecated 

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

Deprecated: Use Header.ProtoReflect.Descriptor instead.

func (*Header) GetAttributes 

func (x *Header) GetAttributes() []*Header_Attribute

func (*Header) GetContainerId 

func (x *Header) GetContainerId() *grpc.ContainerID

func (*Header) GetCreationEpoch 

func (x *Header) GetCreationEpoch() uint64

func (*Header) GetHomomorphicHash 

func (x *Header) GetHomomorphicHash() *grpc.Checksum

func (*Header) GetObjectType 

func (x *Header) GetObjectType() ObjectType

func (*Header) GetOwnerId 

func (x *Header) GetOwnerId() *grpc.OwnerID

func (*Header) GetPayloadHash 

func (x *Header) GetPayloadHash() *grpc.Checksum

func (*Header) GetPayloadLength 

func (x *Header) GetPayloadLength() uint64

func (*Header) GetSessionToken 

func (x *Header) GetSessionToken() *grpc1.SessionToken

func (*Header) GetSplit 

func (x *Header) GetSplit() *Header_Split

func (*Header) GetVersion 

func (x *Header) GetVersion() *grpc.Version

func (*Header) ProtoMessage 

func (*Header) ProtoMessage()

func (*Header) ProtoReflect 

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

func (*Header) Reset 

func (x *Header) Reset()

func (*Header) SetAttributes 

func (m *Header) SetAttributes(v []*Header_Attribute)

SetAttributes sets list of the object attributes.

func (*Header) SetContainerId 

func (m *Header) SetContainerId(v *refs.ContainerID)

SetContainerId sets identifier of the container.

func (*Header) SetCreationEpoch 

func (m *Header) SetCreationEpoch(v uint64)

SetCreationEpoch sets creation epoch number.

func (*Header) SetHomomorphicHash 

func (m *Header) SetHomomorphicHash(v *refs.Checksum)

SetHomomorphicHash sets homomorphic hash of the object payload.

func (*Header) SetObjectType 

func (m *Header) SetObjectType(v ObjectType)

SetObjectType sets type of the object.

func (*Header) SetOwnerId 

func (m *Header) SetOwnerId(v *refs.OwnerID)

SetOwnerId sets identifier of the object owner.

func (*Header) SetPayloadHash 

func (m *Header) SetPayloadHash(v *refs.Checksum)

SetPayloadHash sets hash of the object payload.

func (*Header) SetPayloadLength 

func (m *Header) SetPayloadLength(v uint64)

SetPayloadLength sets length of the object payload.

func (*Header) SetSessionToken 

func (m *Header) SetSessionToken(v *session.SessionToken)

SetSessionToken sets session token.

func (*Header) SetSplit 

func (m *Header) SetSplit(v *Header_Split)

SetSplit sets split header.

func (*Header) SetVersion 

func (m *Header) SetVersion(v *refs.Version)

SetVersion sets version of the object format.

func (*Header) String 

func (x *Header) String() string

type HeaderWithSignature 

type HeaderWithSignature struct {

	// Full object header
	Header *Header `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// Signed `ObjectID` to verify full header's authenticity
	Signature *grpc1.Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// contains filtered or unexported fields
}

Tuple of full object header and signature of `ObjectID`. \ Signed `ObjectID` is present to verify full header's authenticity through the following steps:

1. Calculate `SHA-256` of marshalled `Header` structure 2. Check if the resulting hash matched `ObjectID` 3. Check if `ObjectID` signature in `signature` field is correct

func (*HeaderWithSignature) Descriptor deprecated 

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

Deprecated: Use HeaderWithSignature.ProtoReflect.Descriptor instead.

func (*HeaderWithSignature) GetHeader 

func (x *HeaderWithSignature) GetHeader() *Header

func (*HeaderWithSignature) GetSignature 

func (x *HeaderWithSignature) GetSignature() *grpc1.Signature

func (*HeaderWithSignature) ProtoMessage 

func (*HeaderWithSignature) ProtoMessage()

func (*HeaderWithSignature) ProtoReflect 

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

func (*HeaderWithSignature) Reset 

func (x *HeaderWithSignature) Reset()

func (*HeaderWithSignature) SetHeader 

func (m *HeaderWithSignature) SetHeader(v *Header)

SetHeader sets object header.

func (*HeaderWithSignature) SetSignature 

func (m *HeaderWithSignature) SetSignature(v *refs.Signature)

SetSignature of the header.

func (*HeaderWithSignature) String 

func (x *HeaderWithSignature) String() string

type Header_Attribute 

type Header_Attribute struct {

	// string key to the object attribute
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// string value of the object attribute
	Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

`Attribute` is a user-defined Key-Value metadata pair attached to the object.

Key name must be a object-unique valid UTF-8 string. Value can't be empty. Objects with duplicated attribute names or attributes with empty values will be considered invalid.

There are some "well-known" attributes starting with `__NEOFS__` prefix that affect system behaviour:

  • __NEOFS__UPLOAD_ID \ Marks smaller parts of a split bigger object
  • __NEOFS__EXPIRATION_EPOCH \ Tells GC to delete object after that epoch
  • __NEOFS__TICK_EPOCH \ Decimal number that defines what epoch must produce object notification with UTF-8 object address in a body (`0` value produces notification right after object put)
  • __NEOFS__TICK_TOPIC \ UTF-8 string topic ID that is used for object notification

And some well-known attributes used by applications only:

  • Name \ Human-friendly name
  • FileName \ File name to be associated with the object on saving
  • Timestamp \ User-defined local time of object creation in Unix Timestamp format
  • Content-Type \ MIME Content Type of object's payload

For detailed description of each well-known attribute please see the corresponding section in NeoFS Technical specification.

func (*Header_Attribute) Descriptor deprecated 

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

Deprecated: Use Header_Attribute.ProtoReflect.Descriptor instead.

func (*Header_Attribute) GetKey 

func (x *Header_Attribute) GetKey() string

func (*Header_Attribute) GetValue 

func (x *Header_Attribute) GetValue() string

func (*Header_Attribute) ProtoMessage 

func (*Header_Attribute) ProtoMessage()

func (*Header_Attribute) ProtoReflect 

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

func (*Header_Attribute) Reset 

func (x *Header_Attribute) Reset()

func (*Header_Attribute) SetKey 

func (m *Header_Attribute) SetKey(v string)

SetKey sets key to the object attribute.

func (*Header_Attribute) SetValue 

func (m *Header_Attribute) SetValue(v string)

SetValue sets value of the object attribute.

func (*Header_Attribute) String 

func (x *Header_Attribute) String() string

type Header_Split 

type Header_Split struct {

	// Identifier of the origin object. Known only to the minor child.
	Parent *grpc.ObjectID `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Identifier of the left split neighbor
	Previous *grpc.ObjectID `protobuf:"bytes,2,opt,name=previous,proto3" json:"previous,omitempty"`
	// `signature` field of the parent object. Used to reconstruct parent.
	ParentSignature *grpc.Signature `protobuf:"bytes,3,opt,name=parent_signature,json=parentSignature,proto3" json:"parent_signature,omitempty"`
	// `header` field of the parent object. Used to reconstruct parent.
	ParentHeader *Header `protobuf:"bytes,4,opt,name=parent_header,json=parentHeader,proto3" json:"parent_header,omitempty"`
	// List of identifiers of the objects generated by splitting current one.
	Children []*grpc.ObjectID `protobuf:"bytes,5,rep,name=children,proto3" json:"children,omitempty"`
	// 16 byte UUIDv4 used to identify the split object hierarchy parts. Must be
	// unique inside container. All objects participating in the split must have
	// the same `split_id` value.
	SplitId []byte `protobuf:"bytes,6,opt,name=split_id,json=splitID,proto3" json:"split_id,omitempty"`
	// contains filtered or unexported fields
}

Bigger objects can be split into a chain of smaller objects. Information about inter-dependencies between spawned objects and how to re-construct the original one is in the `Split` headers. Parent and children objects must be within the same container.

func (*Header_Split) Descriptor deprecated 

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

Deprecated: Use Header_Split.ProtoReflect.Descriptor instead.

func (*Header_Split) GetChildren 

func (x *Header_Split) GetChildren() []*grpc.ObjectID

func (*Header_Split) GetParent 

func (x *Header_Split) GetParent() *grpc.ObjectID

func (*Header_Split) GetParentHeader 

func (x *Header_Split) GetParentHeader() *Header

func (*Header_Split) GetParentSignature 

func (x *Header_Split) GetParentSignature() *grpc.Signature

func (*Header_Split) GetPrevious 

func (x *Header_Split) GetPrevious() *grpc.ObjectID

func (*Header_Split) GetSplitId 

func (x *Header_Split) GetSplitId() []byte

func (*Header_Split) ProtoMessage 

func (*Header_Split) ProtoMessage()

func (*Header_Split) ProtoReflect 

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

func (*Header_Split) Reset 

func (x *Header_Split) Reset()

func (*Header_Split) SetChildren 

func (m *Header_Split) SetChildren(v []*refs.ObjectID)

SetChildren sets list of the identifiers of the child objects.

func (*Header_Split) SetParent 

func (m *Header_Split) SetParent(v *refs.ObjectID)

SetParent sets identifier of the parent object.

func (*Header_Split) SetParentHeader 

func (m *Header_Split) SetParentHeader(v *Header)

SetParentHeader sets parent header structure.

func (*Header_Split) SetParentSignature 

func (m *Header_Split) SetParentSignature(v *refs.Signature)

SetParentSignature sets signature of the parent object header.

func (*Header_Split) SetPrevious 

func (m *Header_Split) SetPrevious(v *refs.ObjectID)

SetPrevious sets identifier of the previous object in split-chain.

func (*Header_Split) SetSplitId 

func (m *Header_Split) SetSplitId(v []byte)

SetSplitId sets split ID of the object.

func (*Header_Split) String 

func (x *Header_Split) String() string

type MatchType 

type MatchType int32

Type of match expression 

const (
	// Unknown. Not used
	MatchType_MATCH_TYPE_UNSPECIFIED MatchType = 0
	// Full string match
	MatchType_STRING_EQUAL MatchType = 1
	// Full string mismatch
	MatchType_STRING_NOT_EQUAL MatchType = 2
	// Lack of key
	MatchType_NOT_PRESENT MatchType = 3
	// String prefix match
	MatchType_COMMON_PREFIX MatchType = 4
)

func (MatchType) Descriptor 

func (MatchType) Descriptor() protoreflect.EnumDescriptor

func (MatchType) Enum 

func (x MatchType) Enum() *MatchType

func (MatchType) EnumDescriptor deprecated 

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

Deprecated: Use MatchType.Descriptor instead.

func (*MatchType) FromString 

func (x *MatchType) FromString(s string) bool

FromString parses MatchType from a string representation, It is a reverse action to String().

Returns true if s was parsed successfully.

func (MatchType) Number 

func (x MatchType) Number() protoreflect.EnumNumber

func (MatchType) String 

func (x MatchType) String() string

func (MatchType) Type 

func (MatchType) Type() protoreflect.EnumType

type Object 

type Object struct {

	// Object's unique identifier.
	ObjectId *grpc.ObjectID `protobuf:"bytes,1,opt,name=object_id,json=objectID,proto3" json:"object_id,omitempty"`
	// Signed object_id
	Signature *grpc.Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// Object metadata headers
	Header *Header `protobuf:"bytes,3,opt,name=header,proto3" json:"header,omitempty"`
	// Payload bytes
	Payload []byte `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Object structure. Object is immutable and content-addressed. It means `ObjectID` will change if header or payload changes. It's calculated as a hash of header field, which contains hash of object's payload.

For non-regular object types payload format depends on object type specified in the header.

func (*Object) Descriptor deprecated 

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

Deprecated: Use Object.ProtoReflect.Descriptor instead.

func (*Object) GetHeader 

func (x *Object) GetHeader() *Header

func (*Object) GetObjectId 

func (x *Object) GetObjectId() *grpc.ObjectID

func (*Object) GetPayload 

func (x *Object) GetPayload() []byte

func (*Object) GetSignature 

func (x *Object) GetSignature() *grpc.Signature

func (*Object) ProtoMessage 

func (*Object) ProtoMessage()

func (*Object) ProtoReflect 

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

func (*Object) Reset 

func (x *Object) Reset()

func (*Object) SetHeader 

func (m *Object) SetHeader(v *Header)

SetHeader sets header of the object.

func (*Object) SetObjectId 

func (m *Object) SetObjectId(v *refs.ObjectID)

SetObjectId sets identifier of the object.

func (*Object) SetPayload 

func (m *Object) SetPayload(v []byte)

SetPayload sets payload bytes of the object.

func (*Object) SetSignature 

func (m *Object) SetSignature(v *refs.Signature)

SetSignature sets signature of the object identifier.

func (*Object) String 

func (x *Object) String() string

type ObjectServiceClient 

type ObjectServiceClient interface {
	// Receive full object structure, including Headers and payload. Response uses
	// gRPC stream. First response message carries object with requested address.
	// Chunk messages are parts of the object's payload if it is needed. All
	// messages, except the first one, carry payload chunks. Requested object can
	// be restored by concatenation of object message payload and all chunks
	// keeping receiving order.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   read access to the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired;
	// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
	//   the requested object has been marked as deleted.
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (ObjectService_GetClient, error)
	// Put the object into container. Request uses gRPC stream. First message
	// SHOULD be of PutHeader type. `ContainerID` and `OwnerID` of an object
	// SHOULD be set. Session token SHOULD be obtained before `PUT` operation (see
	// session package). Chunk messages are considered by server as a part of an
	// object payload. All messages, except first one, SHOULD be payload chunks.
	// Chunk messages SHOULD be sent in direct order of fragmentation.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object has been successfully saved in the container;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **LOCKED** (2050, SECTION_OBJECT): \
	//   placement of an object of type TOMBSTONE that includes at least one locked
	//   object is prohibited;
	// - **LOCK_NON_REGULAR_OBJECT** (2051, SECTION_OBJECT): \
	//   placement of an object of type LOCK that includes at least one object of
	//   type other than REGULAR is prohibited;
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object storage container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   write access to the container is denied;
	// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
	//   (for trusted object preparation) session private key does not exist or has
	// been deleted;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	Put(ctx context.Context, opts ...grpc.CallOption) (ObjectService_PutClient, error)
	// Delete the object from a container. There is no immediate removal
	// guarantee. Object will be marked for removal and deleted eventually.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object has been successfully marked to be removed from the container;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **LOCKED** (2050, SECTION_OBJECT): \
	//   deleting a locked object is prohibited;
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   delete access to the object is denied;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// Returns the object Headers without data payload. By default full header is
	// returned. If `main_only` request field is set, the short header with only
	// the very minimal information would be returned instead.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object header has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation HEAD of the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired;
	// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
	//   the requested object has been marked as deleted.
	Head(ctx context.Context, in *HeadRequest, opts ...grpc.CallOption) (*HeadResponse, error)
	// Search objects in container. Search query allows to match by Object
	// Header's filed values. Please see the corresponding NeoFS Technical
	// Specification section for more details.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   objects have been successfully selected;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   search container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation SEARCH of the object is denied;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (ObjectService_SearchClient, error)
	// Get byte range of data payload. Range is set as an (offset, length) tuple.
	// Like in `Get` method, the response uses gRPC stream. Requested range can be
	// restored by concatenation of all received payload chunks keeping receiving
	// order.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   data range of the object payload has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation RANGE of the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired;
	// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
	//   the requested object has been marked as deleted.
	GetRange(ctx context.Context, in *GetRangeRequest, opts ...grpc.CallOption) (ObjectService_GetRangeClient, error)
	// Returns homomorphic or regular hash of object's payload range after
	// applying XOR operation with the provided `salt`. Ranges are set of (offset,
	// length) tuples. Hashes order in response corresponds to ranges order in
	// request. Note that hash is calculated for XORed data.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   data range of the object payload has been successfully hashed;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation RANGEHASH of the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	GetRangeHash(ctx context.Context, in *GetRangeHashRequest, opts ...grpc.CallOption) (*GetRangeHashResponse, error)
}

ObjectServiceClient is the client API for ObjectService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewObjectServiceClient 

func NewObjectServiceClient(cc grpc.ClientConnInterface) ObjectServiceClient

type ObjectServiceServer 

type ObjectServiceServer interface {
	// Receive full object structure, including Headers and payload. Response uses
	// gRPC stream. First response message carries object with requested address.
	// Chunk messages are parts of the object's payload if it is needed. All
	// messages, except the first one, carry payload chunks. Requested object can
	// be restored by concatenation of object message payload and all chunks
	// keeping receiving order.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   read access to the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired;
	// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
	//   the requested object has been marked as deleted.
	Get(*GetRequest, ObjectService_GetServer) error
	// Put the object into container. Request uses gRPC stream. First message
	// SHOULD be of PutHeader type. `ContainerID` and `OwnerID` of an object
	// SHOULD be set. Session token SHOULD be obtained before `PUT` operation (see
	// session package). Chunk messages are considered by server as a part of an
	// object payload. All messages, except first one, SHOULD be payload chunks.
	// Chunk messages SHOULD be sent in direct order of fragmentation.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object has been successfully saved in the container;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **LOCKED** (2050, SECTION_OBJECT): \
	//   placement of an object of type TOMBSTONE that includes at least one locked
	//   object is prohibited;
	// - **LOCK_NON_REGULAR_OBJECT** (2051, SECTION_OBJECT): \
	//   placement of an object of type LOCK that includes at least one object of
	//   type other than REGULAR is prohibited;
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object storage container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   write access to the container is denied;
	// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
	//   (for trusted object preparation) session private key does not exist or has
	// been deleted;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	Put(ObjectService_PutServer) error
	// Delete the object from a container. There is no immediate removal
	// guarantee. Object will be marked for removal and deleted eventually.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object has been successfully marked to be removed from the container;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **LOCKED** (2050, SECTION_OBJECT): \
	//   deleting a locked object is prohibited;
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   delete access to the object is denied;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// Returns the object Headers without data payload. By default full header is
	// returned. If `main_only` request field is set, the short header with only
	// the very minimal information would be returned instead.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   object header has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation HEAD of the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired;
	// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
	//   the requested object has been marked as deleted.
	Head(context.Context, *HeadRequest) (*HeadResponse, error)
	// Search objects in container. Search query allows to match by Object
	// Header's filed values. Please see the corresponding NeoFS Technical
	// Specification section for more details.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   objects have been successfully selected;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   search container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation SEARCH of the object is denied;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	Search(*SearchRequest, ObjectService_SearchServer) error
	// Get byte range of data payload. Range is set as an (offset, length) tuple.
	// Like in `Get` method, the response uses gRPC stream. Requested range can be
	// restored by concatenation of all received payload chunks keeping receiving
	// order.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   data range of the object payload has been successfully read;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation RANGE of the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired;
	// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
	//   the requested object has been marked as deleted.
	GetRange(*GetRangeRequest, ObjectService_GetRangeServer) error
	// Returns homomorphic or regular hash of object's payload range after
	// applying XOR operation with the provided `salt`. Ranges are set of (offset,
	// length) tuples. Hashes order in response corresponds to ranges order in
	// request. Note that hash is calculated for XORed data.
	//
	// Statuses:
	// - **OK** (0, SECTION_SUCCESS): \
	//   data range of the object payload has been successfully hashed;
	// - Common failures (SECTION_FAILURE_COMMON);
	// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
	//   object container not found;
	// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
	//   access to operation RANGEHASH of the object is denied;
	// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
	//   object not found in container;
	// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
	//   provided session token has expired.
	GetRangeHash(context.Context, *GetRangeHashRequest) (*GetRangeHashResponse, error)
}

ObjectServiceServer is the server API for ObjectService service. All implementations should embed UnimplementedObjectServiceServer for forward compatibility

type ObjectService_GetClient 

type ObjectService_GetClient interface {
	Recv() (*GetResponse, error)
	grpc.ClientStream
}

type ObjectService_GetRangeClient 

type ObjectService_GetRangeClient interface {
	Recv() (*GetRangeResponse, error)
	grpc.ClientStream
}

type ObjectService_GetRangeServer 

type ObjectService_GetRangeServer interface {
	Send(*GetRangeResponse) error
	grpc.ServerStream
}

type ObjectService_GetServer 

type ObjectService_GetServer interface {
	Send(*GetResponse) error
	grpc.ServerStream
}

type ObjectService_PutClient 

type ObjectService_PutClient interface {
	Send(*PutRequest) error
	CloseAndRecv() (*PutResponse, error)
	grpc.ClientStream
}

type ObjectService_PutServer 

type ObjectService_PutServer interface {
	SendAndClose(*PutResponse) error
	Recv() (*PutRequest, error)
	grpc.ServerStream
}

type ObjectService_SearchClient 

type ObjectService_SearchClient interface {
	Recv() (*SearchResponse, error)
	grpc.ClientStream
}

type ObjectService_SearchServer 

type ObjectService_SearchServer interface {
	Send(*SearchResponse) error
	grpc.ServerStream
}

type ObjectType 

type ObjectType int32

Type of the object payload content. Only `REGULAR` type objects can be split, hence `TOMBSTONE`, `STORAGE_GROUP` and `LOCK` payload is limited by maximal object size.

String presentation of object type is the same as definition: * REGULAR * TOMBSTONE * STORAGE_GROUP * LOCK 

const (
	// Just a normal object
	ObjectType_REGULAR ObjectType = 0
	// Used internally to identify deleted objects
	ObjectType_TOMBSTONE ObjectType = 1
	// StorageGroup information
	ObjectType_STORAGE_GROUP ObjectType = 2
	// Object lock
	ObjectType_LOCK ObjectType = 3
)

func (ObjectType) Descriptor 

func (ObjectType) Descriptor() protoreflect.EnumDescriptor

func (ObjectType) Enum 

func (x ObjectType) Enum() *ObjectType

func (ObjectType) EnumDescriptor deprecated 

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

Deprecated: Use ObjectType.Descriptor instead.

func (*ObjectType) FromString 

func (x *ObjectType) FromString(s string) bool

FromString parses ObjectType from a string representation, It is a reverse action to String().

Returns true if s was parsed successfully.

func (ObjectType) Number 

func (x ObjectType) Number() protoreflect.EnumNumber

func (ObjectType) String 

func (x ObjectType) String() string

func (ObjectType) Type 

func (ObjectType) Type() protoreflect.EnumType

type Option 

type Option func(*cfg)

Option represents Client option.

func WithCallOptions 

func WithCallOptions(opts []grpc.CallOption) Option

WithCallOptions returns Option that configures Client to attach call options to each rpc call.

type PutIncompleteDetail 

type PutIncompleteDetail struct {
	Statuses []*grpc.Status `protobuf:"bytes,1,rep,name=statuses,proto3" json:"statuses,omitempty"`
	// contains filtered or unexported fields
}

func (*PutIncompleteDetail) Descriptor deprecated 

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

Deprecated: Use PutIncompleteDetail.ProtoReflect.Descriptor instead.

func (*PutIncompleteDetail) GetStatuses 

func (x *PutIncompleteDetail) GetStatuses() []*grpc.Status

func (*PutIncompleteDetail) ProtoMessage 

func (*PutIncompleteDetail) ProtoMessage()

func (*PutIncompleteDetail) ProtoReflect 

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

func (*PutIncompleteDetail) Reset 

func (x *PutIncompleteDetail) Reset()

func (*PutIncompleteDetail) String 

func (x *PutIncompleteDetail) String() string

type PutRequest 

type PutRequest struct {

	// Body of put object request message.
	Body *PutRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

PUT object request

func (*PutRequest) Descriptor deprecated 

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

Deprecated: Use PutRequest.ProtoReflect.Descriptor instead.

func (*PutRequest) GetBody 

func (x *PutRequest) GetBody() *PutRequest_Body

func (*PutRequest) GetMetaHeader 

func (x *PutRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*PutRequest) GetVerifyHeader 

func (x *PutRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*PutRequest) ProtoMessage 

func (*PutRequest) ProtoMessage()

func (*PutRequest) ProtoReflect 

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

func (*PutRequest) Reset 

func (x *PutRequest) Reset()

func (*PutRequest) SetBody 

func (m *PutRequest) SetBody(v *PutRequest_Body)

SetBody sets body of the request.

func (*PutRequest) SetMetaHeader 

func (m *PutRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*PutRequest) SetVerifyHeader 

func (m *PutRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*PutRequest) String 

func (x *PutRequest) String() string

type PutRequest_Body 

type PutRequest_Body struct {

	// Single message in the request stream.
	//
	// Types that are assignable to ObjectPart:
	//	*PutRequest_Body_Init_
	//	*PutRequest_Body_Chunk
	ObjectPart isPutRequest_Body_ObjectPart `protobuf_oneof:"object_part"`
	// contains filtered or unexported fields
}

PUT request body

func (*PutRequest_Body) Descriptor deprecated 

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

Deprecated: Use PutRequest_Body.ProtoReflect.Descriptor instead.

func (*PutRequest_Body) GetChunk 

func (x *PutRequest_Body) GetChunk() []byte

func (*PutRequest_Body) GetInit 

func (x *PutRequest_Body) GetInit() *PutRequest_Body_Init

func (*PutRequest_Body) GetObjectPart 

func (m *PutRequest_Body) GetObjectPart() isPutRequest_Body_ObjectPart

func (*PutRequest_Body) ProtoMessage 

func (*PutRequest_Body) ProtoMessage()

func (*PutRequest_Body) ProtoReflect 

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

func (*PutRequest_Body) Reset 

func (x *PutRequest_Body) Reset()

func (*PutRequest_Body) SetChunk 

func (m *PutRequest_Body) SetChunk(v *PutRequest_Body_Chunk)

SetChunk sets part of the object payload.

func (*PutRequest_Body) SetInit 

func (m *PutRequest_Body) SetInit(v *PutRequest_Body_Init)

SetInit sets initial part of the object.

func (*PutRequest_Body) String 

func (x *PutRequest_Body) String() string

type PutRequest_Body_Chunk 

type PutRequest_Body_Chunk struct {
	// Chunked object payload
	Chunk []byte `protobuf:"bytes,2,opt,name=chunk,proto3,oneof"`
}

func (*PutRequest_Body_Chunk) GetChunk 

func (m *PutRequest_Body_Chunk) GetChunk() []byte

GetChunk returns chunk of the object payload bytes.

func (*PutRequest_Body_Chunk) SetChunk 

func (m *PutRequest_Body_Chunk) SetChunk(v []byte)

SetChunk sets chunk of the object payload bytes.

type PutRequest_Body_Init 

type PutRequest_Body_Init struct {

	// ObjectID if available.
	ObjectId *grpc1.ObjectID `protobuf:"bytes,1,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// Object signature if available
	Signature *grpc1.Signature `protobuf:"bytes,2,opt,name=signature,proto3" json:"signature,omitempty"`
	// Object's Header
	Header *Header `protobuf:"bytes,3,opt,name=header,proto3" json:"header,omitempty"`
	// Number of the object copies to store within the RPC call. By default
	// object is processed according to the container's placement policy.
	CopiesNumber uint32 `protobuf:"varint,4,opt,name=copies_number,json=copiesNumber,proto3" json:"copies_number,omitempty"`
	// contains filtered or unexported fields
}

Newly created object structure parameters. If some optional parameters are not set, they will be calculated by a peer node.

func (*PutRequest_Body_Init) Descriptor deprecated 

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

Deprecated: Use PutRequest_Body_Init.ProtoReflect.Descriptor instead.

func (*PutRequest_Body_Init) GetCopiesNumber 

func (x *PutRequest_Body_Init) GetCopiesNumber() uint32

func (*PutRequest_Body_Init) GetHeader 

func (x *PutRequest_Body_Init) GetHeader() *Header

func (*PutRequest_Body_Init) GetObjectId 

func (x *PutRequest_Body_Init) GetObjectId() *grpc1.ObjectID

func (*PutRequest_Body_Init) GetSignature 

func (x *PutRequest_Body_Init) GetSignature() *grpc1.Signature

func (*PutRequest_Body_Init) ProtoMessage 

func (*PutRequest_Body_Init) ProtoMessage()

func (*PutRequest_Body_Init) ProtoReflect 

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

func (*PutRequest_Body_Init) Reset 

func (x *PutRequest_Body_Init) Reset()

func (*PutRequest_Body_Init) SetCopiesNumber 

func (m *PutRequest_Body_Init) SetCopiesNumber(v uint32)

SetCopiesNumber sets number of the copies to save.

func (*PutRequest_Body_Init) SetHeader 

func (m *PutRequest_Body_Init) SetHeader(v *Header)

SetHeader sets header of the object.

func (*PutRequest_Body_Init) SetObjectId 

func (m *PutRequest_Body_Init) SetObjectId(v *refs.ObjectID)

SetObjectId sets identifier of the object.

func (*PutRequest_Body_Init) SetSignature 

func (m *PutRequest_Body_Init) SetSignature(v *refs.Signature)

SetSignature sets signature of the object identifier.

func (*PutRequest_Body_Init) String 

func (x *PutRequest_Body_Init) String() string

type PutRequest_Body_Init_ 

type PutRequest_Body_Init_ struct {
	// Initial part of the object stream
	Init *PutRequest_Body_Init `protobuf:"bytes,1,opt,name=init,proto3,oneof"`
}

type PutResponse 

type PutResponse struct {

	// Body of put object response message.
	Body *PutResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

PUT Object response

func (*PutResponse) Descriptor deprecated 

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

Deprecated: Use PutResponse.ProtoReflect.Descriptor instead.

func (*PutResponse) GetBody 

func (x *PutResponse) GetBody() *PutResponse_Body

func (*PutResponse) GetMetaHeader 

func (x *PutResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*PutResponse) GetVerifyHeader 

func (x *PutResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*PutResponse) ProtoMessage 

func (*PutResponse) ProtoMessage()

func (*PutResponse) ProtoReflect 

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

func (*PutResponse) Reset 

func (x *PutResponse) Reset()

func (*PutResponse) SetBody 

func (m *PutResponse) SetBody(v *PutResponse_Body)

SetBody sets body of the response.

func (*PutResponse) SetMetaHeader 

func (m *PutResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*PutResponse) SetVerifyHeader 

func (m *PutResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*PutResponse) String 

func (x *PutResponse) String() string

type PutResponse_Body 

type PutResponse_Body struct {

	// Identifier of the saved object
	ObjectId *grpc1.ObjectID `protobuf:"bytes,1,opt,name=object_id,json=objectId,proto3" json:"object_id,omitempty"`
	// contains filtered or unexported fields
}

PUT Object response body

func (*PutResponse_Body) Descriptor deprecated 

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

Deprecated: Use PutResponse_Body.ProtoReflect.Descriptor instead.

func (*PutResponse_Body) GetObjectId 

func (x *PutResponse_Body) GetObjectId() *grpc1.ObjectID

func (*PutResponse_Body) ProtoMessage 

func (*PutResponse_Body) ProtoMessage()

func (*PutResponse_Body) ProtoReflect 

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

func (*PutResponse_Body) Reset 

func (x *PutResponse_Body) Reset()

func (*PutResponse_Body) SetObjectId 

func (m *PutResponse_Body) SetObjectId(v *refs.ObjectID)

SetObjectId sets identifier of the saved object.

func (*PutResponse_Body) String 

func (x *PutResponse_Body) String() string

type Range 

type Range struct {

	// Offset of the range from the object payload start
	Offset uint64 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
	// Length in bytes of the object payload range
	Length uint64 `protobuf:"varint,2,opt,name=length,proto3" json:"length,omitempty"`
	// contains filtered or unexported fields
}

Object payload range.Ranges of zero length SHOULD be considered as invalid.

func (*Range) Descriptor deprecated 

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

Deprecated: Use Range.ProtoReflect.Descriptor instead.

func (*Range) GetLength 

func (x *Range) GetLength() uint64

func (*Range) GetOffset 

func (x *Range) GetOffset() uint64

func (*Range) ProtoMessage 

func (*Range) ProtoMessage()

func (*Range) ProtoReflect 

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

func (*Range) Reset 

func (x *Range) Reset()

func (*Range) SetLength 

func (m *Range) SetLength(v uint64)

SetLength sets length of the payload range.

func (*Range) SetOffset 

func (m *Range) SetOffset(v uint64)

SetOffset sets offset of the payload range.

func (*Range) String 

func (x *Range) String() string

type SearchRequest 

type SearchRequest struct {

	// Body of search object request message.
	Body *SearchRequest_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries request meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.RequestMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries request verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.RequestVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Object Search request

func (*SearchRequest) Descriptor deprecated 

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

Deprecated: Use SearchRequest.ProtoReflect.Descriptor instead.

func (*SearchRequest) GetBody 

func (x *SearchRequest) GetBody() *SearchRequest_Body

func (*SearchRequest) GetMetaHeader 

func (x *SearchRequest) GetMetaHeader() *grpc.RequestMetaHeader

func (*SearchRequest) GetVerifyHeader 

func (x *SearchRequest) GetVerifyHeader() *grpc.RequestVerificationHeader

func (*SearchRequest) ProtoMessage 

func (*SearchRequest) ProtoMessage()

func (*SearchRequest) ProtoReflect 

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

func (*SearchRequest) Reset 

func (x *SearchRequest) Reset()

func (*SearchRequest) SetBody 

func (m *SearchRequest) SetBody(v *SearchRequest_Body)

SetBody sets body of the request.

func (*SearchRequest) SetMetaHeader 

func (m *SearchRequest) SetMetaHeader(v *session.RequestMetaHeader)

SetMetaHeader sets meta header of the request.

func (*SearchRequest) SetVerifyHeader 

func (m *SearchRequest) SetVerifyHeader(v *session.RequestVerificationHeader)

SetVerifyHeader sets verification header of the request.

func (*SearchRequest) String 

func (x *SearchRequest) String() string

type SearchRequest_Body 

type SearchRequest_Body struct {

	// Container identifier were to search
	ContainerId *grpc1.ContainerID `protobuf:"bytes,1,opt,name=container_id,json=containerId,proto3" json:"container_id,omitempty"`
	// Version of the Query Language used
	Version uint32 `protobuf:"varint,2,opt,name=version,proto3" json:"version,omitempty"`
	// List of search expressions
	Filters []*SearchRequest_Body_Filter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"`
	// contains filtered or unexported fields
}

Object Search request body

func (*SearchRequest_Body) Descriptor deprecated 

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

Deprecated: Use SearchRequest_Body.ProtoReflect.Descriptor instead.

func (*SearchRequest_Body) GetContainerId 

func (x *SearchRequest_Body) GetContainerId() *grpc1.ContainerID

func (*SearchRequest_Body) GetFilters 

func (x *SearchRequest_Body) GetFilters() []*SearchRequest_Body_Filter

func (*SearchRequest_Body) GetVersion 

func (x *SearchRequest_Body) GetVersion() uint32

func (*SearchRequest_Body) ProtoMessage 

func (*SearchRequest_Body) ProtoMessage()

func (*SearchRequest_Body) ProtoReflect 

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

func (*SearchRequest_Body) Reset 

func (x *SearchRequest_Body) Reset()

func (*SearchRequest_Body) SetContainerId 

func (m *SearchRequest_Body) SetContainerId(v *refs.ContainerID)

SetContainerId sets container ID of the search requets.

func (*SearchRequest_Body) SetFilters 

func (m *SearchRequest_Body) SetFilters(v []*SearchRequest_Body_Filter)

SetFilters sets list of the query filters.

func (*SearchRequest_Body) SetVersion 

func (m *SearchRequest_Body) SetVersion(v uint32)

SetVersion sets version of the search query.

func (*SearchRequest_Body) String 

func (x *SearchRequest_Body) String() string

type SearchRequest_Body_Filter 

type SearchRequest_Body_Filter struct {

	// Match type to use
	MatchType MatchType `protobuf:"varint,1,opt,name=match_type,json=matchType,proto3,enum=neo.fs.v2.object.MatchType" json:"match_type,omitempty"`
	// Attribute or Header fields to match
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// Value to match
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Filter structure checks if object header field or attribute content matches a value.

If no filters set, search request will return all objects of the container, including Regular object, Tombstones and Storage Group objects. Most human users expect to get only object they can directly work with. In that case the `$Object:ROOT` filter should be used.

By default `key` field refers to the corresponding object's `Attribute`. Some Object's header fields can also be accessed by adding `$Object:` prefix to the name. Here is the list of fields available via this prefix:

  • $Object:version \ version
  • $Object:objectID \ object_id
  • $Object:containerID \ container_id
  • $Object:ownerID \ owner_id
  • $Object:creationEpoch \ creation_epoch
  • $Object:payloadLength \ payload_length
  • $Object:payloadHash \ payload_hash
  • $Object:objectType \ object_type
  • $Object:homomorphicHash \ homomorphic_hash
  • $Object:split.parent \ object_id of parent
  • $Object:split.splitID \ 16 byte UUIDv4 used to identify the split object hierarchy parts

There are some well-known filter aliases to match objects by certain properties:

  • $Object:ROOT \ Returns only `REGULAR` type objects that are not split or are the top level root objects in a split hierarchy. This includes objects not present physically, like large objects split into smaller objects without separate top-level root object. Other type objects like StorageGroups and Tombstones will not be shown. This filter may be useful for listing objects like `ls` command of some virtual file system. This filter is activated if the `key` exists, disregarding the value and matcher type.
  • $Object:PHY \ Returns only objects physically stored in the system. This filter is activated if the `key` exists, disregarding the value and matcher type.

Note: using filters with a key with prefix `$Object:` and match type `NOT_PRESENT `is not recommended since this is not a cross-version approach. Behavior when processing this kind of filters is undefined.

func (*SearchRequest_Body_Filter) Descriptor deprecated 

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

Deprecated: Use SearchRequest_Body_Filter.ProtoReflect.Descriptor instead.

func (*SearchRequest_Body_Filter) GetKey 

func (x *SearchRequest_Body_Filter) GetKey() string

func (*SearchRequest_Body_Filter) GetMatchType 

func (x *SearchRequest_Body_Filter) GetMatchType() MatchType

func (*SearchRequest_Body_Filter) GetValue 

func (x *SearchRequest_Body_Filter) GetValue() string

func (*SearchRequest_Body_Filter) ProtoMessage 

func (*SearchRequest_Body_Filter) ProtoMessage()

func (*SearchRequest_Body_Filter) ProtoReflect 

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

func (*SearchRequest_Body_Filter) Reset 

func (x *SearchRequest_Body_Filter) Reset()

func (*SearchRequest_Body_Filter) SetKey 

func (m *SearchRequest_Body_Filter) SetKey(v string)

SetKey sets key to the filtering header.

func (*SearchRequest_Body_Filter) SetMatchType 

func (m *SearchRequest_Body_Filter) SetMatchType(v MatchType)

SetMatchType sets match type of the filter.

func (*SearchRequest_Body_Filter) SetValue 

func (m *SearchRequest_Body_Filter) SetValue(v string)

SetValue sets value of the filtering header.

func (*SearchRequest_Body_Filter) String 

func (x *SearchRequest_Body_Filter) String() string

type SearchResponse 

type SearchResponse struct {

	// Body of search object response message.
	Body *SearchResponse_Body `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// Carries response meta information. Header data is used only to regulate
	// message transport and does not affect request execution.
	MetaHeader *grpc.ResponseMetaHeader `protobuf:"bytes,2,opt,name=meta_header,json=metaHeader,proto3" json:"meta_header,omitempty"`
	// Carries response verification information. This header is used to
	// authenticate the nodes of the message route and check the correctness of
	// transmission.
	VerifyHeader *grpc.ResponseVerificationHeader `protobuf:"bytes,3,opt,name=verify_header,json=verifyHeader,proto3" json:"verify_header,omitempty"`
	// contains filtered or unexported fields
}

Search response

func (*SearchResponse) Descriptor deprecated 

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

Deprecated: Use SearchResponse.ProtoReflect.Descriptor instead.

func (*SearchResponse) GetBody 

func (x *SearchResponse) GetBody() *SearchResponse_Body

func (*SearchResponse) GetMetaHeader 

func (x *SearchResponse) GetMetaHeader() *grpc.ResponseMetaHeader

func (*SearchResponse) GetVerifyHeader 

func (x *SearchResponse) GetVerifyHeader() *grpc.ResponseVerificationHeader

func (*SearchResponse) ProtoMessage 

func (*SearchResponse) ProtoMessage()

func (*SearchResponse) ProtoReflect 

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

func (*SearchResponse) Reset 

func (x *SearchResponse) Reset()

func (*SearchResponse) SetBody 

func (m *SearchResponse) SetBody(v *SearchResponse_Body)

SetBody sets body of the response.

func (*SearchResponse) SetMetaHeader 

func (m *SearchResponse) SetMetaHeader(v *session.ResponseMetaHeader)

SetMetaHeader sets meta header of the response.

func (*SearchResponse) SetVerifyHeader 

func (m *SearchResponse) SetVerifyHeader(v *session.ResponseVerificationHeader)

SetVerifyHeader sets verification header of the response.

func (*SearchResponse) String 

func (x *SearchResponse) String() string

type SearchResponse_Body 

type SearchResponse_Body struct {

	// List of `ObjectID`s that match the search query
	IdList []*grpc1.ObjectID `protobuf:"bytes,1,rep,name=id_list,json=idList,proto3" json:"id_list,omitempty"`
	// contains filtered or unexported fields
}

Object Search response body

func (*SearchResponse_Body) Descriptor deprecated 

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

Deprecated: Use SearchResponse_Body.ProtoReflect.Descriptor instead.

func (*SearchResponse_Body) GetIdList 

func (x *SearchResponse_Body) GetIdList() []*grpc1.ObjectID

func (*SearchResponse_Body) ProtoMessage 

func (*SearchResponse_Body) ProtoMessage()

func (*SearchResponse_Body) ProtoReflect 

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

func (*SearchResponse_Body) Reset 

func (x *SearchResponse_Body) Reset()

func (*SearchResponse_Body) SetIdList 

func (m *SearchResponse_Body) SetIdList(v []*refs.ObjectID)

SetIdList sets list of the identifiers of the matched objects.

func (*SearchResponse_Body) String 

func (x *SearchResponse_Body) String() string

type ShortHeader 

type ShortHeader struct {

	// Object format version. Effectively the version of API library used to
	// create particular object.
	Version *grpc.Version `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Epoch when the object was created
	CreationEpoch uint64 `protobuf:"varint,2,opt,name=creation_epoch,json=creationEpoch,proto3" json:"creation_epoch,omitempty"`
	// Object's owner
	OwnerId *grpc.OwnerID `protobuf:"bytes,3,opt,name=owner_id,json=ownerID,proto3" json:"owner_id,omitempty"`
	// Type of the object payload content
	ObjectType ObjectType `protobuf:"varint,4,opt,name=object_type,json=objectType,proto3,enum=neo.fs.v2.object.ObjectType" json:"object_type,omitempty"`
	// Size of payload in bytes.
	// `0xFFFFFFFFFFFFFFFF` means `payload_length` is unknown
	PayloadLength uint64 `protobuf:"varint,5,opt,name=payload_length,json=payloadLength,proto3" json:"payload_length,omitempty"`
	// Hash of payload bytes
	PayloadHash *grpc.Checksum `protobuf:"bytes,6,opt,name=payload_hash,json=payloadHash,proto3" json:"payload_hash,omitempty"`
	// Homomorphic hash of the object payload
	HomomorphicHash *grpc.Checksum `protobuf:"bytes,7,opt,name=homomorphic_hash,json=homomorphicHash,proto3" json:"homomorphic_hash,omitempty"`
	// contains filtered or unexported fields
}

Short header fields

func (*ShortHeader) Descriptor deprecated 

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

Deprecated: Use ShortHeader.ProtoReflect.Descriptor instead.

func (*ShortHeader) GetCreationEpoch 

func (x *ShortHeader) GetCreationEpoch() uint64

func (*ShortHeader) GetHomomorphicHash 

func (x *ShortHeader) GetHomomorphicHash() *grpc.Checksum

func (*ShortHeader) GetObjectType 

func (x *ShortHeader) GetObjectType() ObjectType

func (*ShortHeader) GetOwnerId 

func (x *ShortHeader) GetOwnerId() *grpc.OwnerID

func (*ShortHeader) GetPayloadHash 

func (x *ShortHeader) GetPayloadHash() *grpc.Checksum

func (*ShortHeader) GetPayloadLength 

func (x *ShortHeader) GetPayloadLength() uint64

func (*ShortHeader) GetVersion 

func (x *ShortHeader) GetVersion() *grpc.Version

func (*ShortHeader) ProtoMessage 

func (*ShortHeader) ProtoMessage()

func (*ShortHeader) ProtoReflect 

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

func (*ShortHeader) Reset 

func (x *ShortHeader) Reset()

func (*ShortHeader) SetCreationEpoch 

func (m *ShortHeader) SetCreationEpoch(v uint64)

SetCreationEpoch sets creation epoch number.

func (*ShortHeader) SetHomomorphicHash 

func (m *ShortHeader) SetHomomorphicHash(v *refs.Checksum)

SetHomomorphicHash sets homomorphic hash of the object payload.

func (*ShortHeader) SetObjectType 

func (m *ShortHeader) SetObjectType(v ObjectType)

SetObjectType sets type of the object.

func (*ShortHeader) SetOwnerId 

func (m *ShortHeader) SetOwnerId(v *refs.OwnerID)

SetOwnerId sets identifier of the object owner.

func (*ShortHeader) SetPayloadHash 

func (m *ShortHeader) SetPayloadHash(v *refs.Checksum)

SetPayloadHash sets hash of the object payload.

func (*ShortHeader) SetPayloadLength 

func (m *ShortHeader) SetPayloadLength(v uint64)

SetPayloadLength sets length of the object payload.

func (*ShortHeader) SetVersion 

func (m *ShortHeader) SetVersion(v *refs.Version)

SetVersion sets version of the object.

func (*ShortHeader) String 

func (x *ShortHeader) String() string

type SplitInfo 

type SplitInfo struct {

	// 16 byte UUID used to identify the split object hierarchy parts.
	SplitId []byte `protobuf:"bytes,1,opt,name=split_id,json=splitId,proto3" json:"split_id,omitempty"`
	// Identifier of the last object in split hierarchy parts. It contains
	// split header with original object header.
	LastPart *grpc.ObjectID `protobuf:"bytes,2,opt,name=last_part,json=lastPart,proto3" json:"last_part,omitempty"`
	// Identifier of linking object for split hierarchy parts. It contains
	// split header with original object header and sorted list of
	// object parts.
	Link *grpc.ObjectID `protobuf:"bytes,3,opt,name=link,proto3" json:"link,omitempty"`
	// contains filtered or unexported fields
}

Meta information of split hierarchy for object assembly. With last part one can traverse linked list of split hierarchy back to first part and assemble original object. With linking object one can assembly object straight away from the object parts.

func (*SplitInfo) Descriptor deprecated 

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

Deprecated: Use SplitInfo.ProtoReflect.Descriptor instead.

func (*SplitInfo) GetLastPart 

func (x *SplitInfo) GetLastPart() *grpc.ObjectID
func (x *SplitInfo) GetLink() *grpc.ObjectID

func (*SplitInfo) GetSplitId 

func (x *SplitInfo) GetSplitId() []byte

func (*SplitInfo) ProtoMessage 

func (*SplitInfo) ProtoMessage()

func (*SplitInfo) ProtoReflect 

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

func (*SplitInfo) Reset 

func (x *SplitInfo) Reset()

func (*SplitInfo) SetLastPart 

func (m *SplitInfo) SetLastPart(v *refs.ObjectID)

SetLastPart sets id of most right child in split hierarchy. 

func (m *SplitInfo) SetLink(v *refs.ObjectID)

SetLink sets id of linking object in split hierarchy.

func (*SplitInfo) SetSplitId 

func (m *SplitInfo) SetSplitId(v []byte)

SetSplitId sets id of split hierarchy.

func (*SplitInfo) String 

func (x *SplitInfo) String() string

type StatusCommon 

type StatusCommon int32
const (
	StatusCommon_ACCESS_DENIED StatusCommon = 0
)

func (StatusCommon) Descriptor 

func (StatusCommon) Descriptor() protoreflect.EnumDescriptor

func (StatusCommon) Enum 

func (x StatusCommon) Enum() *StatusCommon

func (StatusCommon) EnumDescriptor deprecated 

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

Deprecated: Use StatusCommon.Descriptor instead.

func (StatusCommon) Number 

func (x StatusCommon) Number() protoreflect.EnumNumber

func (StatusCommon) String 

func (x StatusCommon) String() string

func (StatusCommon) Type 

func (StatusCommon) Type() protoreflect.EnumType

type StatusPut 

type StatusPut int32
const (
	StatusPut_STATUS_PUT_INCOMPLETE StatusPut = 0
)

func (StatusPut) Descriptor 

func (StatusPut) Descriptor() protoreflect.EnumDescriptor

func (StatusPut) Enum 

func (x StatusPut) Enum() *StatusPut

func (StatusPut) EnumDescriptor deprecated 

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

Deprecated: Use StatusPut.Descriptor instead.

func (StatusPut) Number 

func (x StatusPut) Number() protoreflect.EnumNumber

func (StatusPut) String 

func (x StatusPut) String() string

func (StatusPut) Type 

func (StatusPut) Type() protoreflect.EnumType

type UnimplementedObjectServiceServer 

type UnimplementedObjectServiceServer struct {
}

UnimplementedObjectServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedObjectServiceServer) Delete 

func (UnimplementedObjectServiceServer) Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)

func (UnimplementedObjectServiceServer) Get 

func (UnimplementedObjectServiceServer) Get(*GetRequest, ObjectService_GetServer) error

func (UnimplementedObjectServiceServer) GetRange 

func (UnimplementedObjectServiceServer) GetRange(*GetRangeRequest, ObjectService_GetRangeServer) error

func (UnimplementedObjectServiceServer) GetRangeHash 

func (UnimplementedObjectServiceServer) GetRangeHash(context.Context, *GetRangeHashRequest) (*GetRangeHashResponse, error)

func (UnimplementedObjectServiceServer) Head 

func (UnimplementedObjectServiceServer) Head(context.Context, *HeadRequest) (*HeadResponse, error)

func (UnimplementedObjectServiceServer) Put 

func (UnimplementedObjectServiceServer) Put(ObjectService_PutServer) error

func (UnimplementedObjectServiceServer) Search 

func (UnimplementedObjectServiceServer) Search(*SearchRequest, ObjectService_SearchServer) error

type UnsafeObjectServiceServer 

type UnsafeObjectServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeObjectServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ObjectServiceServer will result in compilation errors.

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.