#include <userver/s3api/clients/s3api.hpp>

Detailed Description

Main interface for the S3 api

Definition at line 80 of file s3api.hpp.

Inheritance diagram for s3api::Client:

Classes
struct	HeaderDataRequest

struct	HeadersDataResponse

struct	Tag

Public Types
using	CiUnorderedMap = ::http::headers::HeaderMap

using	Meta = CiUnorderedMap

using	Headers = CiUnorderedMap

Public Member Functions
virtual std::string	PutObject (std::string_view path, std::string data, const std::optional< Meta > &meta=std::nullopt, std::string_view content_type="text/plain", const std::optional< std::string > &content_disposition=std::nullopt, const std::optional< std::vector< Tag > > &tags=std::nullopt) const =0

virtual void	DeleteObject (std::string_view path) const =0

virtual std::optional< std::string >	GetObject (std::string_view path, std::optional< std::string > version=std::nullopt, HeadersDataResponse *headers_data=nullptr, const HeaderDataRequest &headers_request=HeaderDataRequest()) const =0

virtual std::string	TryGetObject (std::string_view path, std::optional< std::string > version=std::nullopt, HeadersDataResponse *headers_data=nullptr, const HeaderDataRequest &headers_request=HeaderDataRequest()) const =0

virtual std::optional< std::string >	GetPartialObject (std::string_view path, std::string_view range, std::optional< std::string > version=std::nullopt, HeadersDataResponse *headers_data=nullptr, const HeaderDataRequest &headers_request=HeaderDataRequest()) const =0

virtual std::string	TryGetPartialObject (std::string_view path, std::string_view range, std::optional< std::string > version=std::nullopt, HeadersDataResponse *headers_data=nullptr, const HeaderDataRequest &headers_request=HeaderDataRequest()) const =0

virtual std::string	CopyObject (std::string_view key_from, std::string_view bucket_to, std::string_view key_to, const std::optional< Meta > &meta=std::nullopt)=0

virtual std::string	CopyObject (std::string_view key_from, std::string_view key_to, const std::optional< Meta > &meta=std::nullopt)=0

virtual std::optional< HeadersDataResponse >	GetObjectHead (std::string_view path, const HeaderDataRequest &request=HeaderDataRequest()) const =0

virtual std::string	GenerateDownloadUrl (std::string_view path, time_t expires, bool use_ssl=false) const =0

virtual std::string	GenerateDownloadUrlVirtualHostAddressing (std::string_view path, const std::chrono::system_clock::time_point &expires_at, std::string_view protocol="https://") const =0

virtual std::string	GenerateUploadUrlVirtualHostAddressing (std::string_view data, std::string_view content_type, std::string_view path, const std::chrono::system_clock::time_point &expires_at, std::string_view protocol="https://") const =0

virtual std::optional< std::string >	ListBucketContents (std::string_view path, int max_keys, std::string marker="", std::string delimiter="") const =0

virtual std::vector< ObjectMeta >	ListBucketContentsParsed (std::string_view path_prefix) const =0

virtual std::vector< std::string >	ListBucketDirectories (std::string_view path_prefix) const =0

virtual void	UpdateConfig (ConnectionCfg &&config)=0

virtual std::string_view	GetBucketName () const =0