forked from TrueCloudLab/frostfs-api-go
Revert "Revert "[#16] container, object: Regenerate service comments""
This reverts commit b02ec516e72fbc9030d6dc71f956e23ac93c54da.
This commit is contained in:
parent
3b938873cc
commit
5f318f0b75
2 changed files with 318 additions and 320 deletions
108
container/grpc/service_grpc.pb.go
generated
108
container/grpc/service_grpc.pb.go
generated
|
@ -28,9 +28,9 @@ type ContainerServiceClient interface {
|
||||||
// is added into smart contract storage.
|
// is added into smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// request to save the container has been sent to the sidechain;
|
// request to save the container has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
Put(ctx context.Context, in *PutRequest, opts ...grpc.CallOption) (*PutResponse, error)
|
Put(ctx context.Context, in *PutRequest, opts ...grpc.CallOption) (*PutResponse, error)
|
||||||
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
||||||
// response immediately. After a new block is issued in sidechain, request is
|
// response immediately. After a new block is issued in sidechain, request is
|
||||||
|
@ -38,53 +38,53 @@ type ContainerServiceClient interface {
|
||||||
// is added into smart contract storage.
|
// is added into smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// request to remove the container has been sent to the sidechain;
|
// request to remove the container has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
|
Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
|
||||||
// Returns container structure from `Container` smart contract storage.
|
// Returns container structure from `Container` smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// container has been successfully read;
|
// container has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// requested container not found.
|
// requested container not found.
|
||||||
Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
|
Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
|
||||||
// Returns all owner's containers from 'Container` smart contract' storage.
|
// Returns all owner's containers from 'Container` smart contract' storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// container list has been successfully read;
|
// container list has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
|
List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
|
||||||
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
||||||
// immediately. After one more block in sidechain, changes in an Extended ACL are
|
// immediately. After one more block in sidechain, changes in an Extended ACL are
|
||||||
// added into smart contract storage.
|
// added into smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// request to save container eACL has been sent to the sidechain;
|
// request to save container eACL has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
SetExtendedACL(ctx context.Context, in *SetExtendedACLRequest, opts ...grpc.CallOption) (*SetExtendedACLResponse, error)
|
SetExtendedACL(ctx context.Context, in *SetExtendedACLRequest, opts ...grpc.CallOption) (*SetExtendedACLResponse, error)
|
||||||
// Returns Extended ACL table and signature from `Container` smart contract
|
// Returns Extended ACL table and signature from `Container` smart contract
|
||||||
// storage.
|
// storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// container eACL has been successfully read;
|
// container eACL has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// container not found;
|
// container not found;
|
||||||
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
||||||
// eACL table not found.
|
// eACL table not found.
|
||||||
GetExtendedACL(ctx context.Context, in *GetExtendedACLRequest, opts ...grpc.CallOption) (*GetExtendedACLResponse, error)
|
GetExtendedACL(ctx context.Context, in *GetExtendedACLRequest, opts ...grpc.CallOption) (*GetExtendedACLResponse, error)
|
||||||
// Announces the space values used by the container for P2P synchronization.
|
// Announces the space values used by the container for P2P synchronization.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// estimation of used space has been successfully announced;
|
// estimation of used space has been successfully announced;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
AnnounceUsedSpace(ctx context.Context, in *AnnounceUsedSpaceRequest, opts ...grpc.CallOption) (*AnnounceUsedSpaceResponse, error)
|
AnnounceUsedSpace(ctx context.Context, in *AnnounceUsedSpaceRequest, opts ...grpc.CallOption) (*AnnounceUsedSpaceResponse, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -169,9 +169,9 @@ type ContainerServiceServer interface {
|
||||||
// is added into smart contract storage.
|
// is added into smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// request to save the container has been sent to the sidechain;
|
// request to save the container has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
Put(context.Context, *PutRequest) (*PutResponse, error)
|
Put(context.Context, *PutRequest) (*PutResponse, error)
|
||||||
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
// `Delete` invokes `Container` smart contract's `Delete` method and returns
|
||||||
// response immediately. After a new block is issued in sidechain, request is
|
// response immediately. After a new block is issued in sidechain, request is
|
||||||
|
@ -179,53 +179,53 @@ type ContainerServiceServer interface {
|
||||||
// is added into smart contract storage.
|
// is added into smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// request to remove the container has been sent to the sidechain;
|
// request to remove the container has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
|
Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
|
||||||
// Returns container structure from `Container` smart contract storage.
|
// Returns container structure from `Container` smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// container has been successfully read;
|
// container has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// requested container not found.
|
// requested container not found.
|
||||||
Get(context.Context, *GetRequest) (*GetResponse, error)
|
Get(context.Context, *GetRequest) (*GetResponse, error)
|
||||||
// Returns all owner's containers from 'Container` smart contract' storage.
|
// Returns all owner's containers from 'Container` smart contract' storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// container list has been successfully read;
|
// container list has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
List(context.Context, *ListRequest) (*ListResponse, error)
|
List(context.Context, *ListRequest) (*ListResponse, error)
|
||||||
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
// Invokes 'SetEACL' method of 'Container` smart contract and returns response
|
||||||
// immediately. After one more block in sidechain, changes in an Extended ACL are
|
// immediately. After one more block in sidechain, changes in an Extended ACL are
|
||||||
// added into smart contract storage.
|
// added into smart contract storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// request to save container eACL has been sent to the sidechain;
|
// request to save container eACL has been sent to the sidechain;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
SetExtendedACL(context.Context, *SetExtendedACLRequest) (*SetExtendedACLResponse, error)
|
SetExtendedACL(context.Context, *SetExtendedACLRequest) (*SetExtendedACLResponse, error)
|
||||||
// Returns Extended ACL table and signature from `Container` smart contract
|
// Returns Extended ACL table and signature from `Container` smart contract
|
||||||
// storage.
|
// storage.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// container eACL has been successfully read;
|
// container eACL has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// container not found;
|
// container not found;
|
||||||
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
// - **EACL_NOT_FOUND** (3073, SECTION_CONTAINER): \
|
||||||
// eACL table not found.
|
// eACL table not found.
|
||||||
GetExtendedACL(context.Context, *GetExtendedACLRequest) (*GetExtendedACLResponse, error)
|
GetExtendedACL(context.Context, *GetExtendedACLRequest) (*GetExtendedACLResponse, error)
|
||||||
// Announces the space values used by the container for P2P synchronization.
|
// Announces the space values used by the container for P2P synchronization.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// estimation of used space has been successfully announced;
|
// estimation of used space has been successfully announced;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON).
|
// - Common failures (SECTION_FAILURE_COMMON).
|
||||||
AnnounceUsedSpace(context.Context, *AnnounceUsedSpaceRequest) (*AnnounceUsedSpaceResponse, error)
|
AnnounceUsedSpace(context.Context, *AnnounceUsedSpaceRequest) (*AnnounceUsedSpaceResponse, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
530
object/grpc/service_grpc.pb.go
generated
530
object/grpc/service_grpc.pb.go
generated
|
@ -30,32 +30,32 @@ type ObjectServiceClient interface {
|
||||||
// keeping the receiving order.
|
// keeping the receiving order.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Get` behaviour:
|
// Extended headers can change `Get` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requsted version of Network Map for object placement
|
// Will use the requsted version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
||||||
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
||||||
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
|
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
|
||||||
// the latest one otherwise) of Network Map to find an object until the depth
|
// the latest one otherwise) of Network Map to find an object until the depth
|
||||||
// limit is reached.
|
// limit is reached.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object has been successfully read;
|
// object has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// read access to the object is denied;
|
// read access to the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||||
// the requested object has been marked as deleted;
|
// the requested object has been marked as deleted;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (ObjectService_GetClient, error)
|
Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (ObjectService_GetClient, error)
|
||||||
// Put the object into container. Request uses gRPC stream. First message
|
// Put the object into container. Request uses gRPC stream. First message
|
||||||
// SHOULD be of PutHeader type. `ContainerID` and `OwnerID` of an object
|
// SHOULD be of PutHeader type. `ContainerID` and `OwnerID` of an object
|
||||||
|
@ -65,107 +65,106 @@ type ObjectServiceClient interface {
|
||||||
// Chunk messages SHOULD be sent in the direct order of fragmentation.
|
// Chunk messages SHOULD be sent in the direct order of fragmentation.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Put` behaviour:
|
// Extended headers can change `Put` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH \
|
// * [ __SYSTEM__NETMAP_EPOCH \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requsted version of Network Map for object placement
|
// Will use the requsted version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object has been successfully saved in the container;
|
// object has been successfully saved in the container;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// write access to the container is denied;
|
// write access to the container is denied;
|
||||||
// - **LOCKED** (2050, SECTION_OBJECT): \
|
// - **LOCKED** (2050, SECTION_OBJECT): \
|
||||||
// placement of an object of type TOMBSTONE that includes at least one locked
|
// placement of an object of type TOMBSTONE that includes at least one locked
|
||||||
// object is prohibited;
|
// object is prohibited;
|
||||||
// - **LOCK_NON_REGULAR_OBJECT** (2051, SECTION_OBJECT): \
|
// - **LOCK_NON_REGULAR_OBJECT** (2051, SECTION_OBJECT): \
|
||||||
// placement of an object of type LOCK that includes at least one object of
|
// placement of an object of type LOCK that includes at least one object of
|
||||||
// type other than REGULAR is prohibited;
|
// type other than REGULAR is prohibited;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object storage container not found;
|
// object storage container not found;
|
||||||
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||||
// (for trusted object preparation) session private key does not exist or has
|
// (for trusted object preparation) session private key does not exist or has
|
||||||
//
|
|
||||||
// been deleted;
|
// been deleted;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Put(ctx context.Context, opts ...grpc.CallOption) (ObjectService_PutClient, error)
|
Put(ctx context.Context, opts ...grpc.CallOption) (ObjectService_PutClient, error)
|
||||||
// Delete the object from a container. There is no immediate removal
|
// Delete the object from a container. There is no immediate removal
|
||||||
// guarantee. Object will be marked for removal and deleted eventually.
|
// guarantee. Object will be marked for removal and deleted eventually.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Delete` behaviour:
|
// Extended headers can change `Delete` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object has been successfully marked to be removed from the container;
|
// object has been successfully marked to be removed from the container;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// delete access to the object is denied;
|
// delete access to the object is denied;
|
||||||
// - **LOCKED** (2050, SECTION_OBJECT): \
|
// - **LOCKED** (2050, SECTION_OBJECT): \
|
||||||
// deleting a locked object is prohibited;
|
// deleting a locked object is prohibited;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
|
Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
|
||||||
// Returns the object Headers without data payload. By default full header is
|
// 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
|
// returned. If `main_only` request field is set, the short header with only
|
||||||
// the very minimal information will be returned instead.
|
// the very minimal information will be returned instead.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Head` behaviour:
|
// Extended headers can change `Head` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object header has been successfully read;
|
// object header has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation HEAD of the object is denied;
|
// access to operation HEAD of the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||||
// the requested object has been marked as deleted;
|
// the requested object has been marked as deleted;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Head(ctx context.Context, in *HeadRequest, opts ...grpc.CallOption) (*HeadResponse, error)
|
Head(ctx context.Context, in *HeadRequest, opts ...grpc.CallOption) (*HeadResponse, error)
|
||||||
// Search objects in container. Search query allows to match by Object
|
// Search objects in container. Search query allows to match by Object
|
||||||
// Header's filed values. Please see the corresponding NeoFS Technical
|
// Header's filed values. Please see the corresponding NeoFS Technical
|
||||||
// Specification section for more details.
|
// Specification section for more details.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Search` behaviour:
|
// Extended headers can change `Search` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// objects have been successfully selected;
|
// objects have been successfully selected;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation SEARCH of the object is denied;
|
// access to operation SEARCH of the object is denied;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// search container not found;
|
// search container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Search(ctx context.Context, in *SearchRequest, opts ...grpc.CallOption) (ObjectService_SearchClient, error)
|
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.
|
// 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
|
// Like in `Get` method, the response uses gRPC stream. Requested range can be
|
||||||
|
@ -173,33 +172,33 @@ type ObjectServiceClient interface {
|
||||||
// order.
|
// order.
|
||||||
//
|
//
|
||||||
// Extended headers can change `GetRange` behaviour:
|
// Extended headers can change `GetRange` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
||||||
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
||||||
// Will try older versions of Network Map to find an object until the depth
|
// Will try older versions of Network Map to find an object until the depth
|
||||||
// limit is reached.
|
// limit is reached.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// data range of the object payload has been successfully read;
|
// data range of the object payload has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation RANGE of the object is denied;
|
// access to operation RANGE of the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||||
// the requested object has been marked as deleted.
|
// the requested object has been marked as deleted.
|
||||||
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
||||||
// the requested range is out of bounds;
|
// the requested range is out of bounds;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
GetRange(ctx context.Context, in *GetRangeRequest, opts ...grpc.CallOption) (ObjectService_GetRangeClient, error)
|
GetRange(ctx context.Context, in *GetRangeRequest, opts ...grpc.CallOption) (ObjectService_GetRangeClient, error)
|
||||||
// Returns homomorphic or regular hash of object's payload range after
|
// Returns homomorphic or regular hash of object's payload range after
|
||||||
// applying XOR operation with the provided `salt`. Ranges are set of (offset,
|
// applying XOR operation with the provided `salt`. Ranges are set of (offset,
|
||||||
|
@ -207,31 +206,31 @@ type ObjectServiceClient interface {
|
||||||
// the request. Note that hash is calculated for XORed data.
|
// the request. Note that hash is calculated for XORed data.
|
||||||
//
|
//
|
||||||
// Extended headers can change `GetRangeHash` behaviour:
|
// Extended headers can change `GetRangeHash` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
||||||
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
||||||
// Will try older versions of Network Map to find an object until the depth
|
// Will try older versions of Network Map to find an object until the depth
|
||||||
// limit is reached.
|
// limit is reached.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// data range of the object payload has been successfully hashed;
|
// data range of the object payload has been successfully hashed;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation RANGEHASH of the object is denied;
|
// access to operation RANGEHASH of the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
||||||
// the requested range is out of bounds;
|
// the requested range is out of bounds;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
GetRangeHash(ctx context.Context, in *GetRangeHashRequest, opts ...grpc.CallOption) (*GetRangeHashResponse, error)
|
GetRangeHash(ctx context.Context, in *GetRangeHashRequest, opts ...grpc.CallOption) (*GetRangeHashResponse, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -412,32 +411,32 @@ type ObjectServiceServer interface {
|
||||||
// keeping the receiving order.
|
// keeping the receiving order.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Get` behaviour:
|
// Extended headers can change `Get` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requsted version of Network Map for object placement
|
// Will use the requsted version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
||||||
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
||||||
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
|
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
|
||||||
// the latest one otherwise) of Network Map to find an object until the depth
|
// the latest one otherwise) of Network Map to find an object until the depth
|
||||||
// limit is reached.
|
// limit is reached.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object has been successfully read;
|
// object has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// read access to the object is denied;
|
// read access to the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||||
// the requested object has been marked as deleted;
|
// the requested object has been marked as deleted;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Get(*GetRequest, ObjectService_GetServer) error
|
Get(*GetRequest, ObjectService_GetServer) error
|
||||||
// Put the object into container. Request uses gRPC stream. First message
|
// Put the object into container. Request uses gRPC stream. First message
|
||||||
// SHOULD be of PutHeader type. `ContainerID` and `OwnerID` of an object
|
// SHOULD be of PutHeader type. `ContainerID` and `OwnerID` of an object
|
||||||
|
@ -447,107 +446,106 @@ type ObjectServiceServer interface {
|
||||||
// Chunk messages SHOULD be sent in the direct order of fragmentation.
|
// Chunk messages SHOULD be sent in the direct order of fragmentation.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Put` behaviour:
|
// Extended headers can change `Put` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH \
|
// * [ __SYSTEM__NETMAP_EPOCH \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requsted version of Network Map for object placement
|
// Will use the requsted version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object has been successfully saved in the container;
|
// object has been successfully saved in the container;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// write access to the container is denied;
|
// write access to the container is denied;
|
||||||
// - **LOCKED** (2050, SECTION_OBJECT): \
|
// - **LOCKED** (2050, SECTION_OBJECT): \
|
||||||
// placement of an object of type TOMBSTONE that includes at least one locked
|
// placement of an object of type TOMBSTONE that includes at least one locked
|
||||||
// object is prohibited;
|
// object is prohibited;
|
||||||
// - **LOCK_NON_REGULAR_OBJECT** (2051, SECTION_OBJECT): \
|
// - **LOCK_NON_REGULAR_OBJECT** (2051, SECTION_OBJECT): \
|
||||||
// placement of an object of type LOCK that includes at least one object of
|
// placement of an object of type LOCK that includes at least one object of
|
||||||
// type other than REGULAR is prohibited;
|
// type other than REGULAR is prohibited;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object storage container not found;
|
// object storage container not found;
|
||||||
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
|
||||||
// (for trusted object preparation) session private key does not exist or has
|
// (for trusted object preparation) session private key does not exist or has
|
||||||
//
|
|
||||||
// been deleted;
|
// been deleted;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Put(ObjectService_PutServer) error
|
Put(ObjectService_PutServer) error
|
||||||
// Delete the object from a container. There is no immediate removal
|
// Delete the object from a container. There is no immediate removal
|
||||||
// guarantee. Object will be marked for removal and deleted eventually.
|
// guarantee. Object will be marked for removal and deleted eventually.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Delete` behaviour:
|
// Extended headers can change `Delete` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object has been successfully marked to be removed from the container;
|
// object has been successfully marked to be removed from the container;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// delete access to the object is denied;
|
// delete access to the object is denied;
|
||||||
// - **LOCKED** (2050, SECTION_OBJECT): \
|
// - **LOCKED** (2050, SECTION_OBJECT): \
|
||||||
// deleting a locked object is prohibited;
|
// deleting a locked object is prohibited;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
|
Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
|
||||||
// Returns the object Headers without data payload. By default full header is
|
// 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
|
// returned. If `main_only` request field is set, the short header with only
|
||||||
// the very minimal information will be returned instead.
|
// the very minimal information will be returned instead.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Head` behaviour:
|
// Extended headers can change `Head` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// object header has been successfully read;
|
// object header has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation HEAD of the object is denied;
|
// access to operation HEAD of the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||||
// the requested object has been marked as deleted;
|
// the requested object has been marked as deleted;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Head(context.Context, *HeadRequest) (*HeadResponse, error)
|
Head(context.Context, *HeadRequest) (*HeadResponse, error)
|
||||||
// Search objects in container. Search query allows to match by Object
|
// Search objects in container. Search query allows to match by Object
|
||||||
// Header's filed values. Please see the corresponding NeoFS Technical
|
// Header's filed values. Please see the corresponding NeoFS Technical
|
||||||
// Specification section for more details.
|
// Specification section for more details.
|
||||||
//
|
//
|
||||||
// Extended headers can change `Search` behaviour:
|
// Extended headers can change `Search` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// objects have been successfully selected;
|
// objects have been successfully selected;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation SEARCH of the object is denied;
|
// access to operation SEARCH of the object is denied;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// search container not found;
|
// search container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
Search(*SearchRequest, ObjectService_SearchServer) error
|
Search(*SearchRequest, ObjectService_SearchServer) error
|
||||||
// Get byte range of data payload. Range is set as an (offset, length) tuple.
|
// 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
|
// Like in `Get` method, the response uses gRPC stream. Requested range can be
|
||||||
|
@ -555,33 +553,33 @@ type ObjectServiceServer interface {
|
||||||
// order.
|
// order.
|
||||||
//
|
//
|
||||||
// Extended headers can change `GetRange` behaviour:
|
// Extended headers can change `GetRange` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
||||||
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
||||||
// Will try older versions of Network Map to find an object until the depth
|
// Will try older versions of Network Map to find an object until the depth
|
||||||
// limit is reached.
|
// limit is reached.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// data range of the object payload has been successfully read;
|
// data range of the object payload has been successfully read;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation RANGE of the object is denied;
|
// access to operation RANGE of the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
// - **OBJECT_ALREADY_REMOVED** (2052, SECTION_OBJECT): \
|
||||||
// the requested object has been marked as deleted.
|
// the requested object has been marked as deleted.
|
||||||
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
||||||
// the requested range is out of bounds;
|
// the requested range is out of bounds;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
GetRange(*GetRangeRequest, ObjectService_GetRangeServer) error
|
GetRange(*GetRangeRequest, ObjectService_GetRangeServer) error
|
||||||
// Returns homomorphic or regular hash of object's payload range after
|
// Returns homomorphic or regular hash of object's payload range after
|
||||||
// applying XOR operation with the provided `salt`. Ranges are set of (offset,
|
// applying XOR operation with the provided `salt`. Ranges are set of (offset,
|
||||||
|
@ -589,31 +587,31 @@ type ObjectServiceServer interface {
|
||||||
// the request. Note that hash is calculated for XORed data.
|
// the request. Note that hash is calculated for XORed data.
|
||||||
//
|
//
|
||||||
// Extended headers can change `GetRangeHash` behaviour:
|
// Extended headers can change `GetRangeHash` behaviour:
|
||||||
// - [ __SYSTEM__NETMAP_EPOCH ] \
|
// * [ __SYSTEM__NETMAP_EPOCH ] \
|
||||||
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
|
||||||
// Will use the requested version of Network Map for object placement
|
// Will use the requested version of Network Map for object placement
|
||||||
// calculation.
|
// calculation.
|
||||||
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
|
||||||
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
|
||||||
// Will try older versions of Network Map to find an object until the depth
|
// Will try older versions of Network Map to find an object until the depth
|
||||||
// limit is reached.
|
// limit is reached.
|
||||||
//
|
//
|
||||||
// Please refer to detailed `XHeader` description.
|
// Please refer to detailed `XHeader` description.
|
||||||
//
|
//
|
||||||
// Statuses:
|
// Statuses:
|
||||||
// - **OK** (0, SECTION_SUCCESS): \
|
// - **OK** (0, SECTION_SUCCESS): \
|
||||||
// data range of the object payload has been successfully hashed;
|
// data range of the object payload has been successfully hashed;
|
||||||
// - Common failures (SECTION_FAILURE_COMMON);
|
// - Common failures (SECTION_FAILURE_COMMON);
|
||||||
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
// - **ACCESS_DENIED** (2048, SECTION_OBJECT): \
|
||||||
// access to operation RANGEHASH of the object is denied;
|
// access to operation RANGEHASH of the object is denied;
|
||||||
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
// - **OBJECT_NOT_FOUND** (2049, SECTION_OBJECT): \
|
||||||
// object not found in container;
|
// object not found in container;
|
||||||
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
// - **OUT_OF_RANGE** (2053, SECTION_OBJECT): \
|
||||||
// the requested range is out of bounds;
|
// the requested range is out of bounds;
|
||||||
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
// - **CONTAINER_NOT_FOUND** (3072, SECTION_CONTAINER): \
|
||||||
// object container not found;
|
// object container not found;
|
||||||
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
|
||||||
// provided session token has expired.
|
// provided session token has expired.
|
||||||
GetRangeHash(context.Context, *GetRangeHashRequest) (*GetRangeHashResponse, error)
|
GetRangeHash(context.Context, *GetRangeHashRequest) (*GetRangeHashResponse, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue