base

Documentation

Overview

Package base provides information and interaction with the base API resource in the OpenStack CDN service. This API resource allows for retrieving the Home Document and pinging the root URL.

Index

• func HandleGetSuccessfully(t *testing.T)
• func HandlePingSuccessfully(t *testing.T)
• type GetResult
  • func Get(c *gophercloud.ServiceClient) GetResult
  • func (r GetResult) Extract() (*HomeDocument, error)
• type HomeDocument
• type PingResult
  • func Ping(c *gophercloud.ServiceClient) PingResult

Functions

func HandleGetSuccessfully

func HandleGetSuccessfully(t *testing.T)

HandleGetSuccessfully creates an HTTP handler at `/` on the test handler mux that responds with a `Get` response.

func HandlePingSuccessfully

func HandlePingSuccessfully(t *testing.T)

HandlePingSuccessfully creates an HTTP handler at `/ping` on the test handler mux that responds with a `Ping` response.

Types

type GetResult

type GetResult struct {
	gophercloud.Result
}

GetResult represents the result of a Get operation.

func Get

func Get(c *gophercloud.ServiceClient) GetResult

Get retrieves the home document, allowing the user to discover the entire API.

func (GetResult) Extract

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

Extract is a function that accepts a result and extracts a home document resource.

type HomeDocument

type HomeDocument map[string]interface{}

HomeDocument is a resource that contains all the resources for the CDN API.

type PingResult

type PingResult struct {
	gophercloud.ErrResult
}

PingResult represents the result of a Ping operation.

func Ping

func Ping(c *gophercloud.ServiceClient) PingResult

Ping retrieves a ping to the server.