gophercloud: github.com/rackspace/gophercloud/openstack/blockstorage/v1/volumes Index | Files | Directories

package volumes

import "github.com/rackspace/gophercloud/openstack/blockstorage/v1/volumes"

Package volumes provides information and interaction with volumes in the OpenStack Block Storage service. A volume is a detachable block storage device, akin to a USB hard drive. It can only be attached to one instance at a time.

Index

Package Files

doc.go requests.go results.go urls.go util.go

func ExtractVolumes Uses

func ExtractVolumes(page pagination.Page) ([]Volume, error)

ExtractVolumes extracts and returns Volumes. It is used while iterating over a volumes.List call.

func IDFromName Uses

func IDFromName(client *gophercloud.ServiceClient, name string) (string, error)

IDFromName is a convienience function that returns a server's ID given its name.

func List Uses

func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager

List returns Volumes optionally limited by the conditions provided in ListOpts.

func WaitForStatus Uses

func WaitForStatus(c *gophercloud.ServiceClient, id, status string, secs int) error

WaitForStatus will continually poll the resource, checking for a particular status. It will do this for the amount of seconds defined.

type CreateOpts Uses

type CreateOpts struct {
    // OPTIONAL
    Availability string
    // OPTIONAL
    Description string
    // OPTIONAL
    Metadata map[string]string
    // OPTIONAL
    Name string
    // REQUIRED
    Size int
    // OPTIONAL
    SnapshotID, SourceVolID, ImageID string
    // OPTIONAL
    VolumeType string
}

CreateOpts contains options for creating a Volume. This object is passed to the volumes.Create function. For more information about these parameters, see the Volume object.

func (CreateOpts) ToVolumeCreateMap Uses

func (opts CreateOpts) ToVolumeCreateMap() (map[string]interface{}, error)

ToVolumeCreateMap assembles a request body based on the contents of a CreateOpts.

type CreateOptsBuilder Uses

type CreateOptsBuilder interface {
    ToVolumeCreateMap() (map[string]interface{}, error)
}

CreateOptsBuilder allows extensions to add additional parameters to the Create request.

type CreateResult Uses

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

CreateResult contains the response body and error from a Create request.

func Create Uses

func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) CreateResult

Create will create a new Volume based on the values in CreateOpts. To extract the Volume object from the response, call the Extract method on the CreateResult.

func (CreateResult) Extract Uses

func (r CreateResult) Extract() (*Volume, error)

Extract will get the Volume object out of the commonResult object.

type DeleteResult Uses

type DeleteResult struct {
    gophercloud.ErrResult
}

DeleteResult contains the response body and error from a Delete request.

func Delete Uses

func Delete(client *gophercloud.ServiceClient, id string) DeleteResult

Delete will delete the existing Volume with the provided ID.

type GetResult Uses

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

GetResult contains the response body and error from a Get request.

func Get Uses

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

Get retrieves the Volume with the provided ID. To extract the Volume object from the response, call the Extract method on the GetResult.

func (GetResult) Extract Uses

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

Extract will get the Volume object out of the commonResult object.

type ListOpts Uses

type ListOpts struct {
    // admin-only option. Set it to true to see all tenant volumes.
    AllTenants bool `q:"all_tenants"`
    // List only volumes that contain Metadata.
    Metadata map[string]string `q:"metadata"`
    // List only volumes that have Name as the display name.
    Name string `q:"name"`
    // List only volumes that have a status of Status.
    Status string `q:"status"`
}

ListOpts holds options for listing Volumes. It is passed to the volumes.List function.

func (ListOpts) ToVolumeListQuery Uses

func (opts ListOpts) ToVolumeListQuery() (string, error)

ToVolumeListQuery formats a ListOpts into a query string.

type ListOptsBuilder Uses

type ListOptsBuilder interface {
    ToVolumeListQuery() (string, error)
}

ListOptsBuilder allows extensions to add additional parameters to the List request.

type ListResult Uses

type ListResult struct {
    pagination.SinglePageBase
}

ListResult is a pagination.pager that is returned from a call to the List function.

func (ListResult) IsEmpty Uses

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

IsEmpty returns true if a ListResult contains no Volumes.

type UpdateOpts Uses

type UpdateOpts struct {
    // OPTIONAL
    Name string
    // OPTIONAL
    Description string
    // OPTIONAL
    Metadata map[string]string
}

UpdateOpts contain options for updating an existing Volume. This object is passed to the volumes.Update function. For more information about the parameters, see the Volume object.

func (UpdateOpts) ToVolumeUpdateMap Uses

func (opts UpdateOpts) ToVolumeUpdateMap() (map[string]interface{}, error)

ToVolumeUpdateMap assembles a request body based on the contents of an UpdateOpts.

type UpdateOptsBuilder Uses

type UpdateOptsBuilder interface {
    ToVolumeUpdateMap() (map[string]interface{}, error)
}

UpdateOptsBuilder allows extensions to add additional parameters to the Update request.

type UpdateResult Uses

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

UpdateResult contains the response body and error from an Update request.

func Update Uses

func Update(client *gophercloud.ServiceClient, id string, opts UpdateOptsBuilder) UpdateResult

Update will update the Volume with provided information. To extract the updated Volume from the response, call the Extract method on the UpdateResult.

func (UpdateResult) Extract Uses

func (r UpdateResult) Extract() (*Volume, error)

Extract will get the Volume object out of the commonResult object.

type Volume Uses

type Volume struct {
    // Current status of the volume.
    Status string `mapstructure:"status"`

    // Human-readable display name for the volume.
    Name string `mapstructure:"display_name"`

    // Instances onto which the volume is attached.
    Attachments []map[string]interface{} `mapstructure:"attachments"`

    // This parameter is no longer used.
    AvailabilityZone string `mapstructure:"availability_zone"`

    // Indicates whether this is a bootable volume.
    Bootable string `mapstructure:"bootable"`

    // The date when this volume was created.
    CreatedAt string `mapstructure:"created_at"`

    // Human-readable description for the volume.
    Description string `mapstructure:"display_description"`

    // The type of volume to create, either SATA or SSD.
    VolumeType string `mapstructure:"volume_type"`

    // The ID of the snapshot from which the volume was created
    SnapshotID string `mapstructure:"snapshot_id"`

    // The ID of another block storage volume from which the current volume was created
    SourceVolID string `mapstructure:"source_volid"`

    // Arbitrary key-value pairs defined by the user.
    Metadata map[string]string `mapstructure:"metadata"`

    // Unique identifier for the volume.
    ID  string `mapstructure:"id"`

    // Size of the volume in GB.
    Size int `mapstructure:"size"`
}

Volume contains all the information associated with an OpenStack Volume.

Directories

PathSynopsis
testingThis is package created is to hold fixtures (which imports testing), so that importing volumes package does not inadvertently import testing into production code More information here: https://github.com/rackspace/gophercloud/issues/473

Package volumes imports 4 packages (graph) and is imported by 122 packages. Updated 2016-07-23. Refresh now. Tools for package owners.