azure

Documentation

Index

• Constants
• Variables
• func ConfigureFolder(prefix string, settings map[string]string) (storage.Folder, error)
• func NewCredentialError(settingName string) storage.Error
• func NewFolderError(err error, format string, args ...interface{}) storage.Error
• type AzureAuthType
• type Folder
  • func NewFolder(uploadStreamOptions azblob.UploadStreamOptions, ...) *Folder
  • func (folder *Folder) CopyObject(srcPath string, dstPath string) error
  • func (folder *Folder) DeleteObjects(objectRelativePaths []string) error
  • func (folder *Folder) Exists(objectRelativePath string) (bool, error)
  • func (folder *Folder) GetPath() string
  • func (folder *Folder) GetSubFolder(subFolderRelativePath string) storage.Folder
  • func (folder *Folder) ListFolder() (objects []storage.Object, subFolders []storage.Folder, err error)
  • func (folder *Folder) PutObject(name string, content io.Reader) error
  • func (folder *Folder) ReadObject(objectRelativePath string) (io.ReadCloser, error)

Constants

const (
	AccountSetting    = "AZURE_STORAGE_ACCOUNT"
	AccessKeySetting  = "AZURE_STORAGE_ACCESS_KEY"
	SasTokenSetting   = "AZURE_STORAGE_SAS_TOKEN"
	EndpointSuffix    = "AZURE_ENDPOINT_SUFFIX"
	EnvironmentName   = "AZURE_ENVIRONMENT_NAME"
	BufferSizeSetting = "AZURE_BUFFER_SIZE"
	MaxBuffersSetting = "AZURE_MAX_BUFFERS"
	TryTimeoutSetting = "AZURE_TRY_TIMEOUT"
)

Variables

var SettingList = []string{
	AccountSetting,
	AccessKeySetting,
	SasTokenSetting,
	EnvironmentName,
	EndpointSuffix,
	BufferSizeSetting,
	MaxBuffersSetting,
}

Functions

func ConfigureFolder

func ConfigureFolder(prefix string, settings map[string]string) (storage.Folder, error)

func NewCredentialError

func NewCredentialError(settingName string) storage.Error

func NewFolderError

func NewFolderError(err error, format string, args ...interface{}) storage.Error

Types

type AzureAuthType

type AzureAuthType string

nolint: revive

const (
	AzureAccessKeyAuth AzureAuthType = "AzureAccessKeyAuth"
	AzureSASTokenAuth  AzureAuthType = "AzureSASTokenAuth"
)

type Folder

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

func NewFolder

func NewFolder(
	uploadStreamOptions azblob.UploadStreamOptions,
	containerClient azblob.ContainerClient,
	credential *azblob.SharedKeyCredential,
	timeout time.Duration,
	path string) *Folder

func (*Folder) CopyObject

func (folder *Folder) CopyObject(srcPath string, dstPath string) error

func (*Folder) DeleteObjects

func (folder *Folder) DeleteObjects(objectRelativePaths []string) error

func (*Folder) Exists

func (folder *Folder) Exists(objectRelativePath string) (bool, error)

func (*Folder) GetPath

func (folder *Folder) GetPath() string

func (*Folder) GetSubFolder

func (folder *Folder) GetSubFolder(subFolderRelativePath string) storage.Folder

func (*Folder) ListFolder

func (folder *Folder) ListFolder() (objects []storage.Object, subFolders []storage.Folder, err error)

func (*Folder) PutObject

func (folder *Folder) PutObject(name string, content io.Reader) error

func (*Folder) ReadObject

func (folder *Folder) ReadObject(objectRelativePath string) (io.ReadCloser, error)