fileclient

Documentation

Overview

Package fileclient implements the client for azure file.

Index

• type Client
  • func New(config *azclients.ClientConfig) *Client
  • func (c *Client) CreateFileShare(resourceGroupName, accountName string, shareOptions *ShareOptions) error
  • func (c *Client) DeleteFileShare(resourceGroupName, accountName, name string) error
  • func (c *Client) GetFileShare(resourceGroupName, accountName, name string) (storage.FileShare, error)
  • func (c *Client) ResizeFileShare(resourceGroupName, accountName, name string, sizeGiB int) error
• type Interface
• type ShareOptions

Types

type Client

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

Client implements the azure file client interface

func New

func New(config *azclients.ClientConfig) *Client

New creates a azure file client

func (*Client) CreateFileShare

func (c *Client) CreateFileShare(resourceGroupName, accountName string, shareOptions *ShareOptions) error

CreateFileShare creates a file share

func (*Client) DeleteFileShare

func (c *Client) DeleteFileShare(resourceGroupName, accountName, name string) error

DeleteFileShare deletes a file share

func (*Client) GetFileShare

func (c *Client) GetFileShare(resourceGroupName, accountName, name string) (storage.FileShare, error)

GetFileShare gets a file share

func (*Client) ResizeFileShare

func (c *Client) ResizeFileShare(resourceGroupName, accountName, name string, sizeGiB int) error

ResizeFileShare resizes a file share

type Interface

type Interface interface {
	CreateFileShare(resourceGroupName, accountName string, shareOptions *ShareOptions) error
	DeleteFileShare(resourceGroupName, accountName, name string) error
	ResizeFileShare(resourceGroupName, accountName, name string, sizeGiB int) error
	GetFileShare(resourceGroupName, accountName, name string) (storage.FileShare, error)
}

Interface is the client interface for creating file shares, interface for test injection. mockgen -source=$GOPATH/src/sigs.k8s.io/cloud-provider-azure/pkg/azureclients/fileclient/interface.go -package=mockfileclient Interface > $GOPATH/src/sigs.k8s.io/cloud-provider-azure/pkg/azureclients/fileclient/mockfileclient/interface.go

type ShareOptions

type ShareOptions struct {
	Name       string
	Protocol   storage.EnabledProtocols
	RequestGiB int
}

ShareOptions contains the fields which are used to create file share.