shares

package
v0.0.0-...-d823fe1 Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2021 License: Apache-2.0 Imports: 5 Imported by: 7

Documentation

Overview

Package shares enables management and retrieval of shares Share service. Example to List Shares 

listshares := shares.ListOpts{}
allshares, err := shares.List(client,listshares)
if err != nil {
	panic(err)
}
fmt.Println(allshares)

Example to Create a share 

share:=shares.CreateOpts{
		Name:"sfs-test",
		ShareProto:"NFS",
		Size:1,
	}
outshare,err:=shares.Create(client,share).Extract()
if err != nil {
			panic(err)
		}
fmt.Println(outshare)

Example to Update a share 

updateshare:=shares.UpdateOpts{DisplayName:"sfs-test-1",DisplayDescription:"test sfs"}
out,err:=shares.Update(client,"6149e448-dcac-4691-96d9-041e09ef617f",updateshare).Extract()
if err != nil {
		panic(err)
	}
fmt.Println(out)

Example to Delete a share 

out:=shares.Delete(client,"6149e448-dcac-4691-96d9-041e09ef617f")
fmt.Println(out)
if err != nil {
	panic(err)
}

Example to Get share 

getshare,err:=shares.Get(client, "6149e448-dcac-4691-96d9-041e09ef617f").Extract()
fmt.Println(getshare)
if err != nil {
		panic(err)
	}

Example to Allow Access createSet:=shares.GrantAccessOpts{AccessLevel:"rw",AccessTo:"5232f396-d6cc-4a81-8de3-afd7a7ecdfd8",AccessType:"cert"} 

access,err:=shares.GrantAccess(client,"dff2df5f-00e7-4517-ac32-1d0ab8dc0d68",createSet).Extract()
fmt.Println(access)
if err != nil {
		panic(err)
	}

Example to Deny Access 

deleteSet := shares.DeleteAccessOpts{AccessID:"fc32500f-fa78-4f06-8caf-06ad7fb9726c"}
remove:=shares.DeleteAccess(client,"1b8facf8-b822-4349-a033-e078b2a84b7f",deleteSet)
fmt.Println(remove)
if err != nil {
		panic(err)
	}

Example to Get Access Rule Detail 

rule_list,err:= shares.ListAccessRights(client,"42381b5b-f8cb-445e-9465-89a718e071a7").ExtractAccessRights()
if err != nil {
		panic(err)
	}
fmt.Println(rule_list)

Example to Get Mount Location Details 

mount, err := shares.GetExportLocations(client, "dff2df5f-00e7-4517-ac32-1d0ab8dc0d68").ExtractExportLocations()
fmt.Println(mount)
if err != nil {
		panic(err)
	}

Example to Extend share 

extendsfs:=shares.ExpandOpts{OSExtend: shares.OSExtendOpts{NewSize: 512}}
shares.Expand(client,"45a3af18-8ab0-405c-9ead-06c51a415f79",extendsfs)

Example to Shrink share 

shrinksfs:=shares.ShrinkOpts{OSShrink: shares.OSShrinkOpts{NewSize: 8}}
shares.Shrink(client,"45a3af18-8ab0-405c-9ead-06c51a415f79",shrinksfs)

Index

Constants

This section is empty.

Variables

View Source 
var (
	// SortAsc is used to sort a list of Shares in ascending order.
	SortAsc SortDir = "asc"
	// SortDesc is used to sort a list of Shares in descending order.
	SortDesc SortDir = "desc"
	// SortId is used to sort a list of Shares by id.
	SortId SortKey = "id"
	// SortName is used to sort a list of Shares by name.
	SortName SortKey = "name"
	// SortSize is used to sort a list of Shares by size.
	SortSize SortKey = "size"
	// SortHost is used to sort a list of Shares by host.
	SortHost SortKey = "host"
	// SortShareProto is used to sort a list of Shares by share_proto.
	SortShareProto SortKey = "share_proto"
	// SortStatus is used to sort a list of Shares by status.
	SortStatus SortKey = "status"
	// SortProjectId is used to sort a list of Shares by project_id.
	SortProjectId SortKey = "project_id"
	// SortShareTypeId is used to sort a list of Shares by share_type_id.
	SortShareTypeId SortKey = "share_type_id"
	// SortShareNetworkId is used to sort a list of Shares by share_network_id.
	SortShareNetworkId SortKey = "share_network_id"
	// SortSnapshotId is used to sort a list of Shares by snapshot_id.
	SortSnapshotId SortKey = "snapshot_id"
	// SortCreatedAt is used to sort a list of Shares by date created.
	SortCreatedAt SortKey = "created_at"
	// SortUpdatedAt is used to sort a list of Shares by date updated.
	SortUpdatedAt SortKey = "updated_at"
)
View Source 
var RequestOpts golangsdk.RequestOpts = golangsdk.RequestOpts{
	MoreHeaders: map[string]string{"Content-Type": "application/json",
		"X-Openstack-Manila-Api-Version": "2.9"},
}

Functions

This section is empty.

Types

type AccessRight 

type AccessRight struct {
	// The access rule type that can be "ip", "cert" or "user".
	AccessType string `json:"access_type"`
	// The value that defines the access that can be a valid format of IP, cert or user.
	AccessTo string `json:"access_to"`
	// The access level to the share is either "rw" or "ro".
	AccessLevel string `json:"access_level"`
	// The state of the access rule
	State string `json:"state"`
	// The access rule ID.
	ID string `json:"id"`
}

AccessRight contains all information associated with an OpenStack share Grant Access Response

type AccessRightsResult 

type AccessRightsResult struct {
	golangsdk.Result
}

AccessRightsResult contains the result body and error from a AccessRight request.

func ListAccessRights 

func ListAccessRights(client *golangsdk.ServiceClient, share_id string) (r AccessRightsResult)

ListAccessRights lists all access rules assigned to a Share based on its id. To extract the AccessRight slice from the response, call the Extract method on the AccessRightsResult. Client must have Microversion set; minimum supported microversion for ListAccessRights is 2.7.

func (AccessRightsResult) ExtractAccessRights 

func (r AccessRightsResult) ExtractAccessRights() ([]AccessRight, error)

Extract will get a slice of AccessRight objects from the AccessRightsResult

type CreateOpts 

type CreateOpts struct {
	// Defines the share protocol to use
	ShareProto string `json:"share_proto" required:"true"`
	// Size in GB
	Size int `json:"size" required:"true"`
	// Defines the share name
	Name string `json:"name,omitempty"`
	// Share description
	Description string `json:"description,omitempty"`
	// ShareType defines the sharetype. If omitted, a default share type is used
	ShareType string `json:"share_type,omitempty"`
	// The UUID from which to create a share
	SnapshotID string `json:"snapshot_id,omitempty"`
	// Determines whether or not the share is public
	IsPublic bool `json:"is_public,omitempty"`
	// Key value pairs of user defined metadata
	Metadata map[string]string `json:"metadata,omitempty"`
	// The UUID of the share network to which the share belongs to
	ShareNetworkID string `json:"share_network_id,omitempty"`
	// The UUID of the consistency group to which the share belongs to
	ConsistencyGroupID string `json:"consistency_group_id,omitempty"`
	// The availability zone of the share
	AvailabilityZone string `json:"availability_zone,omitempty"`
}

CreateOpts contains the options for create a Share. This object is passed to shares.Create(). For more information about these parameters, please refer to the Share object, or the shared file systems API v2 documentation

func (CreateOpts) ToShareCreateMap 

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

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

type CreateOptsBuilder 

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

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

type CreateResult 

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

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

func Create 

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

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

func (CreateResult) Extract 

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

Extract will get the Share object from the commonResult

type DeleteAccessOpts 

type DeleteAccessOpts struct {
	// The access ID to be deleted
	AccessID string `json:"access_id"`
}

func (DeleteAccessOpts) ToDeleteAccessMap 

func (opts DeleteAccessOpts) ToDeleteAccessMap() (map[string]interface{}, error)

type DeleteAccessOptsBuilder 

type DeleteAccessOptsBuilder interface {
	ToDeleteAccessMap() (map[string]interface{}, error)
}

Delete the Access Rule

type DeleteAccessResult 

type DeleteAccessResult struct {
	golangsdk.Result
}

DeleteAccessResult contains the response body from DeleteAccess rights

func DeleteAccess 

func DeleteAccess(client *golangsdk.ServiceClient, share_id string, opts DeleteAccessOptsBuilder) (r DeleteAccessResult)

Deletes the Access Rule

type DeleteResult 

type DeleteResult struct {
	golangsdk.ErrResult
}

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

func Delete 

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

Delete will delete an existing Share with the given UUID.

type ExpandOpts 

type ExpandOpts struct {
	// Specifies the os-extend object.
	OSExtend OSExtendOpts `json:"os-extend" required:"true"`
}

ExpandOpts contains the options for expanding a Share. This object is passed to shares.Expand(). For more information about these parameters, please refer to the Share object, or the shared file systems API v2 documentation

func (ExpandOpts) ToShareExpandMap 

func (opts ExpandOpts) ToShareExpandMap() (map[string]interface{}, error)

ToShareExpandMap assembles a request body based on the contents of a ExpandOpts.

type ExpandOptsBuilder 

type ExpandOptsBuilder interface {
	ToShareExpandMap() (map[string]interface{}, error)
}

ExpandOptsBuilder allows extensions to add additional parameters to the Expand request.

type ExpandResult 

type ExpandResult struct {
	golangsdk.ErrResult
}

ExpandResult contains the response body and error from a Expand request.

func Expand 

func Expand(client *golangsdk.ServiceClient, share_id string, opts ExpandOptsBuilder) (r ExpandResult)

Expand will expand a Share based on the values in ExpandOpts.

type ExportLocation 

type ExportLocation struct {
	// The export location path that should be used for mount operation.
	Path string `json:"path"`
	// The UUID of the share instance that this export location belongs to.
	ShareInstanceID string `json:"share_instance_id"`
	// Defines purpose of an export location.
	// If set to true, then it is expected to be used for service needs
	// and by administrators only.
	// If it is set to false, then this export location can be used by end users.
	IsAdminOnly bool `json:"is_admin_only"`
	// The share export location UUID.
	ID        string `json:"id"`
	Preferred bool   `json:"preferred"`
}

ExportLocation contains all information associated with a share export location

type GetExportLocationsResult 

type GetExportLocationsResult struct {
	golangsdk.Result
}

GetExportLocationsResult contains the response body from GetExportLocations

func GetExportLocations 

func GetExportLocations(client *golangsdk.ServiceClient, id string) (r GetExportLocationsResult)

Gets the Mount/Export Locations of the SFS specified

func (GetExportLocationsResult) ExtractExportLocations 

func (r GetExportLocationsResult) ExtractExportLocations() ([]ExportLocation, error)

Extract will get the Export Locations from the commonResult

type GetResult 

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

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

func Get 

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

Get will get a single share with given UUID

func (GetResult) Extract 

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

Extract will get the Share object from the commonResult

type GrantAccessOpts 

type GrantAccessOpts struct {
	// The access rule type that can be "ip", "cert" or "user".
	AccessType string `json:"access_type"`
	// The value that defines the access that can be a valid format of IP, cert or user.
	AccessTo string `json:"access_to"`
	// The access level to the share is either "rw" or "ro".
	AccessLevel string `json:"access_level"`
}

GrantAccessOpts contains the options for creation of an GrantAccess request. For more information about these parameters, please, refer to the shared file systems API v2, Share Actions, Grant Access documentation

func (GrantAccessOpts) ToGrantAccessMap 

func (opts GrantAccessOpts) ToGrantAccessMap() (map[string]interface{}, error)

ToGrantAccessMap assembles a request body based on the contents of a GrantAccessOpts.

type GrantAccessOptsBuilder 

type GrantAccessOptsBuilder interface {
	ToGrantAccessMap() (map[string]interface{}, error)
}

GrantAccessOptsBuilder allows extensions to add additional parameters to the GrantAccess request.

type GrantAccessResult 

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

GrantAccessResult contains the result body and error from an GrantAccess request.

func GrantAccess 

func GrantAccess(client *golangsdk.ServiceClient, share_id string, opts GrantAccessOptsBuilder) (r GrantAccessResult)

GrantAccess will grant access to a Share based on the values in GrantAccessOpts. To extract the GrantAccess object from the response, call the Extract method on the GrantAccessResult. Client must have Microversion set; minimum supported microversion for GrantAccess is 2.7.

func (GrantAccessResult) Extract 

func (r GrantAccessResult) Extract() (*Share, error)

Extract will get the Share object from the commonResult

func (GrantAccessResult) ExtractAccess 

func (r GrantAccessResult) ExtractAccess() (*AccessRight, error)

Extract will get the GrantAccess object from the commonResult

type ListOpts 

type ListOpts struct {
	ID       string
	Status   string  `q:"status"`
	Name     string  `q:"name"`
	Limit    int     `q:"limit"`
	Offset   int     `q:"offset"`
	SortKey  SortKey `q:"sort_key"`
	SortDir  SortDir `q:"sort_dir"`
	IsPublic bool    `q:"is_public"`
}

ListOpts allows the filtering and sorting of paginated collections through the API. Filtering is achieved by passing in struct field values that map to the share attributes you want to see returned. SortKey allows you to sort by a particular share attribute. SortDir sets the direction, and is either `asc' or `desc'. Marker and Limit are used for pagination.

type ListOptsBuilder 

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

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

type OSExtendOpts 

type OSExtendOpts struct {
	// Specifies the post-expansion capacity (GB) of the shared file system.
	NewSize int `json:"new_size" required:"true"`
}

type OSShrinkOpts 

type OSShrinkOpts struct {
	// Specifies the post-shrinking capacity (GB) of the shared file system.
	NewSize int `json:"new_size" required:"true"`
}

type Share 

type Share struct {
	// The availability zone of the share
	AvailabilityZone string `json:"availability_zone"`
	// A description of the share
	Description string `json:"description"`
	// The host name of the share
	Host string `json:"host"`
	// The UUID of the share
	ID string `json:"id"`
	// Indicates the visibility of the share
	IsPublic bool `json:"is_public"`
	// Share links for pagination
	Links []map[string]string `json:"links"`
	// Key, value -pairs of custom metadata
	Metadata map[string]string `json:"metadata"`
	// The name of the share
	Name string `json:"name"`
	// The UUID of the project to which this share belongs to
	ProjectID string `json:"project_id"`
	// The UUID of the share network
	ShareNetworkID string `json:"share_network_id"`
	// The shared file system protocol
	ShareProto string `json:"share_proto"`
	// The UUID of the share type.
	ShareType string `json:"share_type"`
	// Size of the share in GB
	Size int `json:"size"`
	// UUID of the snapshot from which to create the share
	SnapshotID string `json:"snapshot_id"`
	// The share status
	Status string `json:"status"`
	// The type of the volume
	VolumeType string `json:"volume_type"`
	// Timestamp when the share was created
	CreatedAt time.Time `json:"-"`
	//Specifies the mount location.
	ExportLocation string `json:"export_location"`
	//Lists the mount locations.
	ExportLocations []string `json:"export_locations"`
}

Share contains all information associated with an OpenStack Share

func ExtractShares 

func ExtractShares(r pagination.Page) ([]Share, error)

ExtractShares accepts a Page struct, specifically a SharePage struct, and extracts the elements into a slice of share structs. In other words, a generic collection is mapped into a relevant slice.

func FilterShares 

func FilterShares(shares []Share, opts ListOpts) ([]Share, error)

func List 

func List(c *golangsdk.ServiceClient, opts ListOpts) ([]Share, error)

List returns a Pager which allows you to iterate over a collection of share resources. It accepts a ListOpts struct, which allows you to filter the returned collection for greater efficiency.

func (*Share) UnmarshalJSON 

func (r *Share) UnmarshalJSON(b []byte) error

type SharePage 

type SharePage struct {
	pagination.LinkedPageBase
}

SharePage is the page returned by a pager when traversing over a collection of Shares.

func (SharePage) IsEmpty 

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

IsEmpty returns true if a ListResult contains no Shares.

func (SharePage) NextPageURL 

func (r SharePage) NextPageURL() (string, error)

NextPageURL is invoked when a paginated collection of shares has reached the end of a page and the pager seeks to traverse over a new one. In order to do this, it needs to construct the next page's URL.

type ShrinkOpts 

type ShrinkOpts struct {
	// Specifies the os-shrink object.
	OSShrink OSShrinkOpts `json:"os-shrink" required:"true"`
}

ShrinkOpts contains the options for shrinking a Share. This object is passed to shares.Shrink(). For more information about these parameters, please refer to the Share object, or the shared file systems API v2 documentation

func (ShrinkOpts) ToShareShrinkMap 

func (opts ShrinkOpts) ToShareShrinkMap() (map[string]interface{}, error)

ToShareShrinkMap assembles a request body based on the contents of a ShrinkOpts.

type ShrinkOptsBuilder 

type ShrinkOptsBuilder interface {
	ToShareShrinkMap() (map[string]interface{}, error)
}

ShrinkOptsBuilder allows extensions to add additional parameters to the Shrink request.

type ShrinkResult 

type ShrinkResult struct {
	golangsdk.ErrResult
}

ShrinkResult contains the response body and error from a Shrink request.

func Shrink 

func Shrink(client *golangsdk.ServiceClient, share_id string, opts ShrinkOptsBuilder) (r ShrinkResult)

Shrink will shrink a Share based on the values in ShrinkOpts.

type SortDir 

type SortDir string

SortDir is a type for specifying in which direction to sort a list of Shares.

type SortKey 

type SortKey string

SortKey is a type for specifying by which key to sort a list of Shares.

type UpdateOpts 

type UpdateOpts struct {
	// DisplayName is equivalent to Name. The API supports using both
	// This is an inherited attribute from the block storage API
	DisplayName string `json:"display_name" required:"true"`
	// DisplayDescription is equivalent to Description. The API supports using bot
	// This is an inherited attribute from the block storage API
	DisplayDescription string `json:"display_description,omitempty"`
}

UpdateOpts contains the values used when updating a Share.

func (UpdateOpts) ToShareUpdateMap 

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

ToShareUpdateMap builds an update body based on UpdateOpts.

type UpdateOptsBuilder 

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

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

type UpdateResult 

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

UpdateResult contains the response body and error from a update request.

func Update 

func Update(c *golangsdk.ServiceClient, id string, opts UpdateOptsBuilder) (r UpdateResult)

Update allows shares to be updated. You can update the DisplayName, DisplayDescription.

func (UpdateResult) Extract 

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

Extract will get the Share object from the commonResult

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.