File: requests.go

package info (click to toggle)
golang-github-gophercloud-gophercloud 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 11,416 kB
  • sloc: sh: 99; makefile: 21
file content (92 lines) | stat: -rw-r--r-- 3,119 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
package schedulerstats

import (
	"github.com/gophercloud/gophercloud"
	"github.com/gophercloud/gophercloud/pagination"
)

// ListOptsBuilder allows extensions to add additional parameters to the
// List request.
type ListOptsBuilder interface {
	ToPoolsListQuery() (string, error)
}

// ListOpts controls the view of data returned (e.g globally or per project).
type ListOpts struct {
	// The pool name for the back end.
	ProjectID string `json:"project_id,omitempty"`
	// The pool name for the back end.
	PoolName string `json:"pool_name"`
	// The host name for the back end.
	HostName string `json:"host_name"`
	// The name of the back end.
	BackendName string `json:"backend_name"`
	// The capabilities for the storage back end.
	Capabilities string `json:"capabilities"`
	// The share type name or UUID. Allows filtering back end pools based on the extra-specs in the share type.
	ShareType string `json:"share_type,omitempty"`
}

// ToPoolsListQuery formats a ListOpts into a query string.
func (opts ListOpts) ToPoolsListQuery() (string, error) {
	q, err := gophercloud.BuildQueryString(opts)
	return q.String(), err
}

// List makes a request against the API to list pool information.
func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
	url := poolsListURL(client)
	if opts != nil {
		query, err := opts.ToPoolsListQuery()
		if err != nil {
			return pagination.Pager{Err: err}
		}
		url += query
	}
	return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
		return PoolPage{pagination.SinglePageBase(r)}
	})
}

// ListDetailOptsBuilder allows extensions to add additional parameters to the
// ListDetail request.
type ListDetailOptsBuilder interface {
	ToPoolsListQuery() (string, error)
}

// ListOpts controls the view of data returned (e.g globally or per project).
type ListDetailOpts struct {
	// The pool name for the back end.
	ProjectID string `json:"project_id,omitempty"`
	// The pool name for the back end.
	PoolName string `json:"pool_name"`
	// The host name for the back end.
	HostName string `json:"host_name"`
	// The name of the back end.
	BackendName string `json:"backend_name"`
	// The capabilities for the storage back end.
	Capabilities string `json:"capabilities"`
	// The share type name or UUID. Allows filtering back end pools based on the extra-specs in the share type.
	ShareType string `json:"share_type,omitempty"`
}

// ToPoolsListQuery formats a ListDetailOpts into a query string.
func (opts ListDetailOpts) ToPoolsListQuery() (string, error) {
	q, err := gophercloud.BuildQueryString(opts)
	return q.String(), err
}

// ListDetail makes a request against the API to list detailed pool information.
func ListDetail(client *gophercloud.ServiceClient, opts ListDetailOptsBuilder) pagination.Pager {
	url := poolsListDetailURL(client)
	if opts != nil {
		query, err := opts.ToPoolsListQuery()
		if err != nil {
			return pagination.Pager{Err: err}
		}
		url += query
	}
	return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
		return PoolPage{pagination.SinglePageBase(r)}
	})
}