clusters

Documentation

Overview

Package clusters provides interaction with Limes at the cluster hierarchical level.

Index

• type CommonResult
  • func Get(c *gophercloud.ServiceClient, opts GetOptsBuilder) (r CommonResult)
  • func (r CommonResult) Extract() (*limesresources.ClusterReport, error)
• type GetOpts
  • func (opts GetOpts) ToClusterGetQuery() (string, error)
• type GetOptsBuilder

Types

type CommonResult

type CommonResult struct {
	gophercloud.Result
}

CommonResult is the result of a Get operation. Call its appropriate Extract method to interpret it as a Cluster.

func Get

func Get(c *gophercloud.ServiceClient, opts GetOptsBuilder) (r CommonResult)

Get retrieves details on a single cluster, by ID.

func (CommonResult) Extract

func (r CommonResult) Extract() (*limesresources.ClusterReport, error)

Extract interprets a CommonResult as a Cluster.

type GetOpts

type GetOpts struct {
	Detail    bool                          `q:"detail"`
	Areas     []string                      `q:"area"`
	Services  []limes.ServiceType           `q:"service"`
	Resources []limesresources.ResourceName `q:"resource"`
}

GetOpts contains parameters for filtering a Get request.

func (GetOpts) ToClusterGetQuery

func (opts GetOpts) ToClusterGetQuery() (string, error)

ToClusterGetQuery formats a GetOpts into a query string.

type GetOptsBuilder

type GetOptsBuilder interface {
	ToClusterGetQuery() (string, error)
}

GetOptsBuilder allows extensions to add additional parameters to the Get request.