apiversions

Documentation

Overview

Package apiversions provides information and interaction with the different API versions for the Shared File System service, code-named Manila.

Example to List API Versions

allPages, err := apiversions.List(client).AllPages()
if err != nil {
	panic(err)
}

allVersions, err := apiversions.ExtractAPIVersions(allPages)
if err != nil {
	panic(err)
}

for _, version := range allVersions {
	fmt.Printf("%+v\n", version)
}

Example to Get an API Version

version, err := apiVersions.Get(client, "v2.1").Extract()
if err != nil {
	panic(err)
}

fmt.Printf("%+v\n", version)

Index

• func List(c *gophercloud.ServiceClient) pagination.Pager
• type APIVersion
  • func ExtractAPIVersions(r pagination.Page) ([]APIVersion, error)
• type APIVersionPage
  • func (r APIVersionPage) IsEmpty() (bool, error)
• type ErrMultipleVersionsFound
  • func (e ErrMultipleVersionsFound) Error() string
• type ErrVersionNotFound
  • func (e ErrVersionNotFound) Error() string
• type GetResult
  • func Get(client *gophercloud.ServiceClient, v string) (r GetResult)
  • func (r GetResult) Extract() (*APIVersion, error)

Functions

func List

func List(c *gophercloud.ServiceClient) pagination.Pager

List lists all the API versions available to end-users.

Types

type APIVersion

type APIVersion struct {
	// ID is the unique identifier of the API version.
	ID string `json:"id"`

	// MinVersion is the minimum microversion supported.
	MinVersion string `json:"min_version"`

	// Status is the API versions status.
	Status string `json:"status"`

	// Updated is the date when the API was last updated.
	Updated time.Time `json:"updated"`

	// Version is the maximum microversion supported.
	Version string `json:"version"`
}

APIVersion represents an API version for the Shared File System service.

func ExtractAPIVersions

func ExtractAPIVersions(r pagination.Page) ([]APIVersion, error)

ExtractAPIVersions takes a collection page, extracts all of the elements, and returns them a slice of APIVersion structs. It is effectively a cast.

type APIVersionPage

type APIVersionPage struct {
	pagination.SinglePageBase
}

APIVersionPage is the page returned by a pager when traversing over a collection of API versions.

func (APIVersionPage) IsEmpty

func (r APIVersionPage) IsEmpty() (bool, error)

IsEmpty checks whether an APIVersionPage struct is empty.

type ErrMultipleVersionsFound

type ErrMultipleVersionsFound struct {
	Count int
}

ErrMultipleVersionsFound is the error when a request for an API version returns multiple results.

func (ErrMultipleVersionsFound) Error

func (e ErrMultipleVersionsFound) Error() string

type ErrVersionNotFound

type ErrVersionNotFound struct{}

ErrVersionNotFound is the error when the requested API version could not be found.

func (ErrVersionNotFound) Error

func (e ErrVersionNotFound) Error() string

type GetResult

type GetResult struct {
	gophercloud.Result
}

GetResult represents the result of a get operation.

func Get

func Get(client *gophercloud.ServiceClient, v string) (r GetResult)

Get will get a specific API version, specified by major ID.

func (GetResult) Extract

func (r GetResult) Extract() (*APIVersion, error)

Extract is a function that accepts a result and extracts an API version resource.