apiversions

Documentation

Overview

Package apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.

This package is deprecated and should only be used in environments where the older API version format is expected.

Consider using the gophercloud/openstack/blockstorage/apiversions package instead.

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 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 Cinder API versions available to end-users.

Types

type APIVersion

type APIVersion struct {
	ID      string `json:"id"`      // unique identifier
	Status  string `json:"status"`  // current status
	Updated string `json:"updated"` // date last updated
}

APIVersion represents an API version for Cinder.

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 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 retrieve the volume type with the provided ID. To extract the volume type from the result, call the Extract method on the GetResult.

func (GetResult) Extract

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

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