package
0.0.0-20230109062233-ba464ddfa386
Repository: https://github.com/truecloudlab/frostfs-rest-gw.git
Documentation: pkg.go.dev

# Functions

NewAuth creates a new http.Handler for the auth operation.
NewAuthBadRequest creates AuthBadRequest with default headers values.
NewAuthOK creates AuthOK with default headers values.
NewAuthParams creates a new AuthParams object with the default values initialized.
NewDeleteContainer creates a new http.Handler for the delete container operation.
NewDeleteContainerBadRequest creates DeleteContainerBadRequest with default headers values.
NewDeleteContainerOK creates DeleteContainerOK with default headers values.
NewDeleteContainerParams creates a new DeleteContainerParams object with the default values initialized.
NewDeleteObject creates a new http.Handler for the delete object operation.
NewDeleteObjectBadRequest creates DeleteObjectBadRequest with default headers values.
NewDeleteObjectOK creates DeleteObjectOK with default headers values.
NewDeleteObjectParams creates a new DeleteObjectParams object with the default values initialized.
NewFormBinaryBearer creates a new http.Handler for the form binary bearer operation.
NewFormBinaryBearerBadRequest creates FormBinaryBearerBadRequest with default headers values.
NewFormBinaryBearerOK creates FormBinaryBearerOK with default headers values.
NewFormBinaryBearerParams creates a new FormBinaryBearerParams object with the default values initialized.
NewFrostfsRestGwAPI creates a new FrostfsRestGw instance.
NewGetBalance creates a new http.Handler for the get balance operation.
NewGetBalanceBadRequest creates GetBalanceBadRequest with default headers values.
NewGetBalanceOK creates GetBalanceOK with default headers values.
NewGetBalanceParams creates a new GetBalanceParams object There are no default values defined in the spec.
NewGetContainer creates a new http.Handler for the get container operation.
NewGetContainerBadRequest creates GetContainerBadRequest with default headers values.
NewGetContainerEACL creates a new http.Handler for the get container e ACL operation.
NewGetContainerEACLBadRequest creates GetContainerEACLBadRequest with default headers values.
NewGetContainerEACLOK creates GetContainerEACLOK with default headers values.
NewGetContainerEACLParams creates a new GetContainerEACLParams object There are no default values defined in the spec.
NewGetContainerOK creates GetContainerOK with default headers values.
NewGetContainerParams creates a new GetContainerParams object There are no default values defined in the spec.
NewGetObjectInfo creates a new http.Handler for the get object info operation.
NewGetObjectInfoBadRequest creates GetObjectInfoBadRequest with default headers values.
NewGetObjectInfoOK creates GetObjectInfoOK with default headers values.
NewGetObjectInfoParams creates a new GetObjectInfoParams object with the default values initialized.
NewListContainers creates a new http.Handler for the list containers operation.
NewListContainersBadRequest creates ListContainersBadRequest with default headers values.
NewListContainersOK creates ListContainersOK with default headers values.
NewListContainersParams creates a new ListContainersParams object with the default values initialized.
NewOptionsAuth creates a new http.Handler for the options auth operation.
NewOptionsAuthBearer creates a new http.Handler for the options auth bearer operation.
NewOptionsAuthBearerOK creates OptionsAuthBearerOK with default headers values.
NewOptionsAuthBearerParams creates a new OptionsAuthBearerParams object There are no default values defined in the spec.
NewOptionsAuthOK creates OptionsAuthOK with default headers values.
NewOptionsAuthParams creates a new OptionsAuthParams object There are no default values defined in the spec.
NewOptionsContainersEACL creates a new http.Handler for the options containers e ACL operation.
NewOptionsContainersEACLOK creates OptionsContainersEACLOK with default headers values.
NewOptionsContainersEACLParams creates a new OptionsContainersEACLParams object There are no default values defined in the spec.
NewOptionsContainersGetDelete creates a new http.Handler for the options containers get delete operation.
NewOptionsContainersGetDeleteOK creates OptionsContainersGetDeleteOK with default headers values.
NewOptionsContainersGetDeleteParams creates a new OptionsContainersGetDeleteParams object There are no default values defined in the spec.
NewOptionsContainersPutList creates a new http.Handler for the options containers put list operation.
NewOptionsContainersPutListOK creates OptionsContainersPutListOK with default headers values.
NewOptionsContainersPutListParams creates a new OptionsContainersPutListParams object There are no default values defined in the spec.
NewOptionsObjectsGetDelete creates a new http.Handler for the options objects get delete operation.
NewOptionsObjectsGetDeleteOK creates OptionsObjectsGetDeleteOK with default headers values.
NewOptionsObjectsGetDeleteParams creates a new OptionsObjectsGetDeleteParams object There are no default values defined in the spec.
NewOptionsObjectsPut creates a new http.Handler for the options objects put operation.
NewOptionsObjectsPutOK creates OptionsObjectsPutOK with default headers values.
NewOptionsObjectsPutParams creates a new OptionsObjectsPutParams object There are no default values defined in the spec.
NewOptionsObjectsSearch creates a new http.Handler for the options objects search operation.
NewOptionsObjectsSearchOK creates OptionsObjectsSearchOK with default headers values.
NewOptionsObjectsSearchParams creates a new OptionsObjectsSearchParams object There are no default values defined in the spec.
NewPutContainer creates a new http.Handler for the put container operation.
NewPutContainerBadRequest creates PutContainerBadRequest with default headers values.
NewPutContainerEACL creates a new http.Handler for the put container e ACL operation.
NewPutContainerEACLBadRequest creates PutContainerEACLBadRequest with default headers values.
NewPutContainerEACLOK creates PutContainerEACLOK with default headers values.
NewPutContainerEACLParams creates a new PutContainerEACLParams object with the default values initialized.
NewPutContainerOK creates PutContainerOK with default headers values.
NewPutContainerParams creates a new PutContainerParams object with the default values initialized.
NewPutObject creates a new http.Handler for the put object operation.
NewPutObjectBadRequest creates PutObjectBadRequest with default headers values.
NewPutObjectOK creates PutObjectOK with default headers values.
NewPutObjectParams creates a new PutObjectParams object with the default values initialized.
NewSearchObjects creates a new http.Handler for the search objects operation.
NewSearchObjectsBadRequest creates SearchObjectsBadRequest with default headers values.
NewSearchObjectsOK creates SearchObjectsOK with default headers values.
NewSearchObjectsParams creates a new SearchObjectsParams object with the default values initialized.

# Constants

AuthBadRequestCode is the HTTP code returned for type AuthBadRequest.
AuthOKCode is the HTTP code returned for type AuthOK.
DeleteContainerBadRequestCode is the HTTP code returned for type DeleteContainerBadRequest.
DeleteContainerOKCode is the HTTP code returned for type DeleteContainerOK.
DeleteObjectBadRequestCode is the HTTP code returned for type DeleteObjectBadRequest.
DeleteObjectOKCode is the HTTP code returned for type DeleteObjectOK.
FormBinaryBearerBadRequestCode is the HTTP code returned for type FormBinaryBearerBadRequest.
FormBinaryBearerOKCode is the HTTP code returned for type FormBinaryBearerOK.
GetBalanceBadRequestCode is the HTTP code returned for type GetBalanceBadRequest.
GetBalanceOKCode is the HTTP code returned for type GetBalanceOK.
GetContainerBadRequestCode is the HTTP code returned for type GetContainerBadRequest.
GetContainerEACLBadRequestCode is the HTTP code returned for type GetContainerEACLBadRequest.
GetContainerEACLOKCode is the HTTP code returned for type GetContainerEACLOK.
GetContainerOKCode is the HTTP code returned for type GetContainerOK.
GetObjectInfoBadRequestCode is the HTTP code returned for type GetObjectInfoBadRequest.
GetObjectInfoOKCode is the HTTP code returned for type GetObjectInfoOK.
ListContainersBadRequestCode is the HTTP code returned for type ListContainersBadRequest.
ListContainersOKCode is the HTTP code returned for type ListContainersOK.
OptionsAuthBearerOKCode is the HTTP code returned for type OptionsAuthBearerOK.
OptionsAuthOKCode is the HTTP code returned for type OptionsAuthOK.
OptionsContainersEACLOKCode is the HTTP code returned for type OptionsContainersEACLOK.
OptionsContainersGetDeleteOKCode is the HTTP code returned for type OptionsContainersGetDeleteOK.
OptionsContainersPutListOKCode is the HTTP code returned for type OptionsContainersPutListOK.
OptionsObjectsGetDeleteOKCode is the HTTP code returned for type OptionsObjectsGetDeleteOK.
OptionsObjectsPutOKCode is the HTTP code returned for type OptionsObjectsPutOK.
OptionsObjectsSearchOKCode is the HTTP code returned for type OptionsObjectsSearchOK.
PutContainerBadRequestCode is the HTTP code returned for type PutContainerBadRequest.
PutContainerEACLBadRequestCode is the HTTP code returned for type PutContainerEACLBadRequest.
PutContainerEACLOKCode is the HTTP code returned for type PutContainerEACLOK.
PutContainerOKCode is the HTTP code returned for type PutContainerOK.
PutObjectBadRequestCode is the HTTP code returned for type PutObjectBadRequest.
PutObjectOKCode is the HTTP code returned for type PutObjectOK.
SearchObjectsBadRequestCode is the HTTP code returned for type SearchObjectsBadRequest.
SearchObjectsOKCode is the HTTP code returned for type SearchObjectsOK.

# Structs

Auth swagger:route POST /auth auth Form bearer token to further requests */.
AuthBadRequest Bad request swagger:response authBadRequest */.
AuthOK Base64 encoded stable binary marshaled bearer token bodies.
AuthParams contains all the bound params for the auth operation typically these are obtained from a http.Request swagger:parameters auth.
DeleteContainer swagger:route DELETE /containers/{containerId} deleteContainer Delete container by id */.
DeleteContainerBadRequest Bad request.
DeleteContainerOK Successful deletion.
DeleteContainerParams contains all the bound params for the delete container operation typically these are obtained from a http.Request swagger:parameters deleteContainer.
DeleteObject swagger:route DELETE /objects/{containerId}/{objectId} deleteObject Remove object from FrostFS */.
DeleteObjectBadRequest Bad request.
DeleteObjectOK Successful deletion.
DeleteObjectParams contains all the bound params for the delete object operation typically these are obtained from a http.Request swagger:parameters deleteObject.
FormBinaryBearer swagger:route GET /auth/bearer formBinaryBearer Form binary bearer token */.
FormBinaryBearerBadRequest Bad request swagger:response formBinaryBearerBadRequest */.
FormBinaryBearerOK Base64 encoded stable binary marshaled bearer token.
FormBinaryBearerParams contains all the bound params for the form binary bearer operation typically these are obtained from a http.Request swagger:parameters formBinaryBearer.
FrostfsRestGwAPI REST API for native integration with FrostFS.
GetBalance swagger:route GET /accounting/balance/{address} getBalance Get balance in FrostFS Getting balance of provided wallet address in FrostFS.
GetBalanceBadRequest Bad request swagger:response getBalanceBadRequest */.
GetBalanceOK Balance of address in FrostFS swagger:response getBalanceOK */.
GetBalanceParams contains all the bound params for the get balance operation typically these are obtained from a http.Request swagger:parameters getBalance.
GetContainer swagger:route GET /containers/{containerId} getContainer Get container by id */.
GetContainerBadRequest Bad request.
GetContainerEACL swagger:route GET /containers/{containerId}/eacl getContainerEAcl Get container EACL by id */.
GetContainerEACLBadRequest Bad request.
GetContainerEACLOK Container EACL information.
GetContainerEACLParams contains all the bound params for the get container e ACL operation typically these are obtained from a http.Request swagger:parameters getContainerEACL.
GetContainerOK Container info.
GetContainerParams contains all the bound params for the get container operation typically these are obtained from a http.Request swagger:parameters getContainer.
GetObjectInfo swagger:route GET /objects/{containerId}/{objectId} getObjectInfo Get object info by address */.
GetObjectInfoBadRequest Bad request swagger:response getObjectInfoBadRequest */.
GetObjectInfoOK Object info swagger:response getObjectInfoOK */.
GetObjectInfoParams contains all the bound params for the get object info operation typically these are obtained from a http.Request swagger:parameters getObjectInfo.
ListContainers swagger:route GET /containers listContainers Get list of containers */.
ListContainersBadRequest Bad request.
ListContainersOK Containers info.
ListContainersParams contains all the bound params for the list containers operation typically these are obtained from a http.Request swagger:parameters listContainers.
OptionsAuth swagger:route OPTIONS /auth optionsAuth OptionsAuth options auth API */.
OptionsAuthBearer swagger:route OPTIONS /auth/bearer optionsAuthBearer OptionsAuthBearer options auth bearer API */.
OptionsAuthBearerOK CORS swagger:response optionsAuthBearerOK */.
OptionsAuthBearerParams contains all the bound params for the options auth bearer operation typically these are obtained from a http.Request swagger:parameters optionsAuthBearer.
OptionsAuthOK CORS swagger:response optionsAuthOK */.
OptionsAuthParams contains all the bound params for the options auth operation typically these are obtained from a http.Request swagger:parameters optionsAuth.
OptionsContainersEACL swagger:route OPTIONS /containers/{containerId}/eacl optionsContainersEAcl OptionsContainersEACL options containers e ACL API */.
OptionsContainersEACLOK CORS swagger:response optionsContainersEAclOK */.
OptionsContainersEACLParams contains all the bound params for the options containers e ACL operation typically these are obtained from a http.Request swagger:parameters optionsContainersEACL.
OptionsContainersGetDelete swagger:route OPTIONS /containers/{containerId} optionsContainersGetDelete OptionsContainersGetDelete options containers get delete API */.
OptionsContainersGetDeleteOK CORS swagger:response optionsContainersGetDeleteOK */.
OptionsContainersGetDeleteParams contains all the bound params for the options containers get delete operation typically these are obtained from a http.Request swagger:parameters optionsContainersGetDelete.
OptionsContainersPutList swagger:route OPTIONS /containers optionsContainersPutList OptionsContainersPutList options containers put list API */.
OptionsContainersPutListOK CORS swagger:response optionsContainersPutListOK */.
OptionsContainersPutListParams contains all the bound params for the options containers put list operation typically these are obtained from a http.Request swagger:parameters optionsContainersPutList.
OptionsObjectsGetDelete swagger:route OPTIONS /objects/{containerId}/{objectId} optionsObjectsGetDelete OptionsObjectsGetDelete options objects get delete API */.
OptionsObjectsGetDeleteOK CORS swagger:response optionsObjectsGetDeleteOK */.
OptionsObjectsGetDeleteParams contains all the bound params for the options objects get delete operation typically these are obtained from a http.Request swagger:parameters optionsObjectsGetDelete.
OptionsObjectsPut swagger:route OPTIONS /objects optionsObjectsPut OptionsObjectsPut options objects put API */.
OptionsObjectsPutOK CORS swagger:response optionsObjectsPutOK */.
OptionsObjectsPutParams contains all the bound params for the options objects put operation typically these are obtained from a http.Request swagger:parameters optionsObjectsPut.
OptionsObjectsSearch swagger:route OPTIONS /objects/{containerId}/search optionsObjectsSearch OptionsObjectsSearch options objects search API */.
OptionsObjectsSearchOK Base64 encoded stable binary marshaled bearer token.
OptionsObjectsSearchParams contains all the bound params for the options objects search operation typically these are obtained from a http.Request swagger:parameters optionsObjectsSearch.
PutContainer swagger:route PUT /containers putContainer Create new container in FrostFS */.
PutContainerBadRequest Bad request.
PutContainerEACL swagger:route PUT /containers/{containerId}/eacl putContainerEAcl Set container EACL by id */.
PutContainerEACLBadRequest Bad request.
PutContainerEACLOK Successful EACL updating.
PutContainerEACLParams contains all the bound params for the put container e ACL operation typically these are obtained from a http.Request swagger:parameters putContainerEACL.
PutContainerOK Identifier of the created container.
PutContainerOKBody put container o k body Example: {"containerId":"5HZTn5qkRnmgSz9gSrw22CEdPPk6nQhkwf2Mgzyvkikv"} swagger:model PutContainerOKBody.
PutContainerParams contains all the bound params for the put container operation typically these are obtained from a http.Request swagger:parameters putContainer.
PutObject swagger:route PUT /objects putObject Upload object to FrostFS */.
PutObjectBadRequest Bad request swagger:response putObjectBadRequest */.
PutObjectOK Address of uploaded objects swagger:response putObjectOK */.
PutObjectParams contains all the bound params for the put object operation typically these are obtained from a http.Request swagger:parameters putObject.
SearchObjects swagger:route POST /objects/{containerId}/search searchObjects Search objects by filters */.
SearchObjectsBadRequest Bad request swagger:response searchObjectsBadRequest */.
SearchObjectsOK List of objects swagger:response searchObjectsOK */.
SearchObjectsParams contains all the bound params for the search objects operation typically these are obtained from a http.Request swagger:parameters searchObjects.

# Interfaces

AuthHandler interface for that can handle valid auth params.
DeleteContainerHandler interface for that can handle valid delete container params.
DeleteObjectHandler interface for that can handle valid delete object params.
FormBinaryBearerHandler interface for that can handle valid form binary bearer params.
GetBalanceHandler interface for that can handle valid get balance params.
GetContainerEACLHandler interface for that can handle valid get container e ACL params.
GetContainerHandler interface for that can handle valid get container params.
GetObjectInfoHandler interface for that can handle valid get object info params.
ListContainersHandler interface for that can handle valid list containers params.
OptionsAuthBearerHandler interface for that can handle valid options auth bearer params.
OptionsAuthHandler interface for that can handle valid options auth params.
OptionsContainersEACLHandler interface for that can handle valid options containers e ACL params.
OptionsContainersGetDeleteHandler interface for that can handle valid options containers get delete params.
OptionsContainersPutListHandler interface for that can handle valid options containers put list params.
OptionsObjectsGetDeleteHandler interface for that can handle valid options objects get delete params.
OptionsObjectsPutHandler interface for that can handle valid options objects put params.
OptionsObjectsSearchHandler interface for that can handle valid options objects search params.
PutContainerEACLHandler interface for that can handle valid put container e ACL params.
PutContainerHandler interface for that can handle valid put container params.
PutObjectHandler interface for that can handle valid put object params.
SearchObjectsHandler interface for that can handle valid search objects params.

# Type aliases

AuthHandlerFunc turns a function with the right signature into a auth handler.
DeleteContainerHandlerFunc turns a function with the right signature into a delete container handler.
DeleteObjectHandlerFunc turns a function with the right signature into a delete object handler.
FormBinaryBearerHandlerFunc turns a function with the right signature into a form binary bearer handler.
GetBalanceHandlerFunc turns a function with the right signature into a get balance handler.
GetContainerEACLHandlerFunc turns a function with the right signature into a get container e ACL handler.
GetContainerHandlerFunc turns a function with the right signature into a get container handler.
GetObjectInfoHandlerFunc turns a function with the right signature into a get object info handler.
ListContainersHandlerFunc turns a function with the right signature into a list containers handler.
OptionsAuthBearerHandlerFunc turns a function with the right signature into a options auth bearer handler.
OptionsAuthHandlerFunc turns a function with the right signature into a options auth handler.
OptionsContainersEACLHandlerFunc turns a function with the right signature into a options containers e ACL handler.
OptionsContainersGetDeleteHandlerFunc turns a function with the right signature into a options containers get delete handler.
OptionsContainersPutListHandlerFunc turns a function with the right signature into a options containers put list handler.
OptionsObjectsGetDeleteHandlerFunc turns a function with the right signature into a options objects get delete handler.
OptionsObjectsPutHandlerFunc turns a function with the right signature into a options objects put handler.
OptionsObjectsSearchHandlerFunc turns a function with the right signature into a options objects search handler.
PutContainerEACLHandlerFunc turns a function with the right signature into a put container e ACL handler.
PutContainerHandlerFunc turns a function with the right signature into a put container handler.
PutObjectHandlerFunc turns a function with the right signature into a put object handler.
SearchObjectsHandlerFunc turns a function with the right signature into a search objects handler.