manilaclient

package
v1.31.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Builder

type Builder interface {
	New(o *client.AuthOpts) (Interface, error)
}

type Client

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

func New

func New(o *client.AuthOpts, userAgent string, extraUserAgentData []string) (*Client, error)

func (Client) CreateShare

func (c Client) CreateShare(opts shares.CreateOptsBuilder) (*shares.Share, error)

func (Client) CreateSnapshot

func (c Client) CreateSnapshot(opts snapshots.CreateOptsBuilder) (*snapshots.Snapshot, error)

func (Client) DeleteShare

func (c Client) DeleteShare(shareID string) error

func (Client) DeleteSnapshot

func (c Client) DeleteSnapshot(snapID string) error

func (Client) ExtendShare added in v1.22.0

func (c Client) ExtendShare(shareID string, opts shares.ExtendOptsBuilder) error

func (Client) GetAccessRights

func (c Client) GetAccessRights(shareID string) ([]shares.AccessRight, error)

func (Client) GetExportLocations

func (c Client) GetExportLocations(shareID string) ([]shares.ExportLocation, error)

func (Client) GetExtraSpecs added in v1.17.0

func (c Client) GetExtraSpecs(shareTypeID string) (sharetypes.ExtraSpecs, error)

func (Client) GetShareByID

func (c Client) GetShareByID(shareID string) (*shares.Share, error)

func (Client) GetShareByName

func (c Client) GetShareByName(shareName string) (*shares.Share, error)

func (Client) GetShareTypeIDFromName added in v1.17.0

func (c Client) GetShareTypeIDFromName(shareTypeName string) (string, error)

func (Client) GetShareTypes added in v1.17.0

func (c Client) GetShareTypes() ([]sharetypes.ShareType, error)

func (Client) GetSnapshotByID

func (c Client) GetSnapshotByID(snapID string) (*snapshots.Snapshot, error)

func (Client) GetSnapshotByName

func (c Client) GetSnapshotByName(snapName string) (*snapshots.Snapshot, error)

func (Client) GetUserMessages

func (c Client) GetUserMessages(opts messages.ListOptsBuilder) ([]messages.Message, error)

func (Client) GrantAccess

func (c Client) GrantAccess(shareID string, opts shares.GrantAccessOptsBuilder) (*shares.AccessRight, error)

func (Client) SetShareMetadata added in v1.17.0

func (c Client) SetShareMetadata(shareID string, opts shares.SetMetadataOptsBuilder) (map[string]string, error)

type ClientBuilder

type ClientBuilder struct {
	UserAgent          string
	ExtraUserAgentData []string
}

func (*ClientBuilder) New

func (cb *ClientBuilder) New(o *client.AuthOpts) (Interface, error)

type Interface

type Interface interface {
	GetShareByID(shareID string) (*shares.Share, error)
	GetShareByName(shareName string) (*shares.Share, error)
	CreateShare(opts shares.CreateOptsBuilder) (*shares.Share, error)
	DeleteShare(shareID string) error
	ExtendShare(shareID string, opts shares.ExtendOptsBuilder) error

	GetExportLocations(shareID string) ([]shares.ExportLocation, error)

	SetShareMetadata(shareID string, opts shares.SetMetadataOptsBuilder) (map[string]string, error)

	GetAccessRights(shareID string) ([]shares.AccessRight, error)
	GrantAccess(shareID string, opts shares.GrantAccessOptsBuilder) (*shares.AccessRight, error)

	GetSnapshotByID(snapID string) (*snapshots.Snapshot, error)
	GetSnapshotByName(snapName string) (*snapshots.Snapshot, error)
	CreateSnapshot(opts snapshots.CreateOptsBuilder) (*snapshots.Snapshot, error)
	DeleteSnapshot(snapID string) error

	GetExtraSpecs(shareTypeID string) (sharetypes.ExtraSpecs, error)
	GetShareTypes() ([]sharetypes.ShareType, error)
	GetShareTypeIDFromName(shareTypeName string) (string, error)

	GetUserMessages(opts messages.ListOptsBuilder) ([]messages.Message, error)
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL