eclcloud

package module
v1.11.0 Latest Latest
Warning

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

 Go to latest Published: Feb 18, 2021 License: Apache-2.0 Imports: 14 Imported by: 6

README ¶

eclcloud: an Enterprise Cloud SDK for Go

eclcloud is an Enterprise Cloud Go SDK.

How to install

Before installing, you need to ensure that your GOPATH environment variable is pointing to an appropriate directory where you want to install eclcloud:

mkdir $HOME/go
export GOPATH=$HOME/go

Getting started

Credentials

Because you'll be hitting an API, you will need to retrieve your Enterprise Cloud credentials and either store them as environment variables or in your local Go files. The first method is recommended because it decouples credential information from source code, allowing you to push the latter to your version control system without any security risk.

You will need to retrieve the following:

  • APIKey(equivalent of keystone user name)
  • API Secret Key(equivalent of keystone password)
  • a valid Keystone identity URL
Authentication

Once you have access to your credentials, you can begin plugging them into eclcloud. The next step is authentication, and this is handled by a base "Provider" struct. To get one, you can either pass in your credentials explicitly, or tell eclcloud to use environment variables:

import (
  "github.com/nttcom/eclcloud"
  "github.com/nttcom/eclcloud"
  "github.com/nttcom/eclcloud/utils"
)

// Option 1: Pass in the values yourself
opts := eclcloud.AuthOptions{
  IdentityEndpoint: "https://{your keystone url}/v3",
  Username: "{apikey}",
  Password: "{api secret key}",
}

// Option 2: Use a utility function to retrieve all your environment variables
opts, err := ecl.AuthOptionsFromEnv()

Once you have the opts variable, you can pass it in and get back a ProviderClient struct:

provider, err := ecl.AuthenticatedClient(opts)

The ProviderClient is the top-level client that all of your Enterprise Cloud services derive from. The provider contains all of the authentication details that allow your Go code to access the API - such as the base URL and token ID.

Provision a server

Once we have a base Provider, we inject it as a dependency into each Enterprise Cloud service. In order to work with the Compute API, we need a Compute service client; which can be created like so:

client, err := ecl.NewComputeV2(provider, eclcloud.EndpointOpts{
  Region: os.Getenv("OS_REGION_NAME"),
})

We then use this client for any Compute API operation we want. In our case, we want to provision a new server - so we invoke the Create method and pass in the flavor ID (hardware specification) and image ID (operating system) we're interested in:

import "github.com/nttcom/eclcloud/compute/v2/servers"

server, err := servers.Create(client, servers.CreateOpts{
  Name:      "My new server!",
  FlavorRef: "flavor_id",
  ImageRef:  "image_id",
}).Extract()

The above code sample creates a new server with the parameters, and embodies the new resource in the server variable (a servers.Server struct).

Advanced Usage

Have a look at the FAQ for some tips on customizing the way eclcloud works.

Backwards-Compatibility Guarantees

None. Vendor it and write tests covering the parts you use.

Contributing

See the contributing guide.

Help and feedback

If you're struggling with something or have spotted a potential bug, feel free to submit an issue to our bug tracker.

Documentation ¶

Overview ¶

Package eclcloud provides interface to Enterprise Cloud. The library has a three-level hierarchy: providers, services, and resources.

Authenticating with Providers ¶

Provider structs represent the cloud providers that offer and manage a collection of services. You will generally want to create one Provider client per Enterprise Cloud.

Use your Enterprise Cloud credentials to create a Provider client. The IdentityEndpoint is typically referred to as "auth_url" or "OS_AUTH_URL" in information provided by the cloud operator. Additionally, the cloud may refer to TenantID or TenantName as project_id and project_name. Credentials are specified like so: 

opts := eclcloud.AuthOptions{
  IdentityEndpoint: "https://keystone-{region}-ecl.api.ntt.com/v3/",
  Username: "{api key}",
  Password: "{api secret key}",
  TenantID: "{tenant_id}",
}

provider, err := ecl.AuthenticatedClient(opts)

You may also use the ecl.AuthOptionsFromEnv() helper function. This function reads in standard environment variables frequently found in an Enterprise Cloud `openrc` file. Again note that Gophercloud currently uses "tenant" instead of "project". 

opts, err := ecl.AuthOptionsFromEnv()
provider, err := ecl.AuthenticatedClient(opts)

Service Clients ¶

Service structs are specific to a provider and handle all of the logic and operations for a particular Enterprise Cloud service. Examples of services include: Compute, Object Storage, Block Storage. In order to define one, you need to pass in the parent provider, like so: 

opts := eclcloud.EndpointOpts{Region: "RegionOne"}

client := ecl.NewComputeV2(provider, opts)

Resources ¶

Resource structs are the domain models that services make use of in order to work with and represent the state of API resources: 

server, err := servers.Get(client, "{serverId}").Extract()

Intermediate Result structs are returned for API operations, which allow generic access to the HTTP headers, response body, and any errors associated with the network transaction. To turn a result into a usable resource struct, you must call the Extract method which is chained to the response, or an Extract function from an applicable extension: 

result := servers.Get(client, "{serverId}")

// Attempt to extract the disk configuration from the OS-DCF disk config
// extension:
config, err := diskconfig.ExtractGet(result)

All requests that enumerate a collection return a Pager struct that is used to iterate through the results one page at a time. Use the EachPage method on that Pager to handle each successive Page in a closure, then use the appropriate extraction method from that request's package to interpret that Page as a slice of results: 

err := servers.List(client, nil).EachPage(func (page pagination.Page) (bool, error) {
  s, err := servers.ExtractServers(page)
  if err != nil {
    return false, err
  }

  // Handle the []servers.Server slice.

  // Return "false" or an error to prematurely stop fetching new pages.
  return true, nil
})

If you want to obtain the entire collection of pages without doing any intermediary processing on each page, you can use the AllPages method: 

allPages, err := servers.List(client, nil).AllPages()
allServers, err := servers.ExtractServers(allPages)

This top-level package contains utility functions and data types that are used throughout the provider and service packages. Of particular note for end users are the AuthOptions and EndpointOpts structs.

Index ¶

Constants ¶

View Source 
const DefaultUserAgent = "eclcloud/1.0.0"

DefaultUserAgent is the default User-Agent string set in the request header.

View Source 
const ISO8601 = "2006-01-02T15:04:05+0000"

ISO8601 describes a common time format used by some API responses. Expecially in storage SDP of Enterprise Cloud 2.0

View Source 
const RFC3339Milli = "2006-01-02T15:04:05.999999Z"

RFC3339Milli describes a common time format used by some API responses.

View Source 
const RFC3339MilliNoZ = "2006-01-02T15:04:05.999999"
View Source 
const RFC3339NoZ = "2006-01-02T15:04:05"

RFC3339NoZ is the time format used in Heat (Orchestration).

View Source 
const RFC3339ZNoT = "2006-01-02 15:04:05-07:00"

RFC3339ZNoT is the time format used in Zun (Containers Service).

View Source 
const RFC3339ZNoTNoZ = "2006-01-02 15:04:05"

RFC3339ZNoTNoZ is another time format used in Zun (Containers Service).

Variables ¶

This section is empty.

Functions ¶

func BuildHeaders ¶ 

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

BuildHeaders is an internal function to be used by request methods in individual resource packages.

It accepts an arbitrary tagged structure and produces a string map that's suitable for use as the HTTP headers of an outgoing request. Field names are mapped to header names based in "h" tags. 

type struct Something {
  Bar string `h:"x_bar"`
  Baz int    `h:"lorem_ipsum"`
}

instance := Something{
  Bar: "AAA",
  Baz: "BBB",
}

will be converted into: 

map[string]string{
  "x_bar": "AAA",
  "lorem_ipsum": "BBB",
}

Untagged fields and fields left at their zero values are skipped. Integers, booleans and string values are supported.

func BuildQueryString ¶ 

func BuildQueryString(opts interface{}) (*url.URL, error)

BuildQueryString is an internal function to be used by request methods in individual resource packages.

It accepts a tagged structure and expands it into a URL struct. Field names are converted into query parameters based on a "q" tag. For example: 

type struct Something {
   Bar string `q:"x_bar"`
   Baz int    `q:"lorem_ipsum"`
}

instance := Something{
   Bar: "AAA",
   Baz: "BBB",
}

will be converted into "?x_bar=AAA&lorem_ipsum=BBB".

The struct's fields may be strings, integers, or boolean values. Fields left at their type's zero value will be omitted from the query.

func BuildRequestBody ¶ 

func BuildRequestBody(opts interface{}, parent string) (map[string]interface{}, error)

BuildRequestBody builds a map[string]interface from the given `struct`. If parent is not an empty string, the final map[string]interface returned will encapsulate the built one. For example: 

disk := 1
createOpts := flavors.CreateOpts{
  ID:         "1",
  Name:       "m1.tiny",
  Disk:       &disk,
  RAM:        512,
  VCPUs:      1,
  RxTxFactor: 1.0,
}

body, err := eclcloud.BuildRequestBody(createOpts, "flavor")

The above example can be run as-is, however it is recommended to look at how BuildRequestBody is used within eclcloud to more fully understand how it fits within the request process as a whole rather than use it directly as shown above.

func ExtractNextURL ¶ 

func ExtractNextURL(links []Link) (string, error)

ExtractNextURL is an internal function useful for packages of collection resources that are paginated in a certain way.

It attempts to extract the "next" URL from slice of Link structs, or "" if no such URL is present.

func IDSliceToQueryString ¶ 

func IDSliceToQueryString(name string, ids []int) string

IDSliceToQueryString takes a slice of elements and converts them into a query string. For example, if name=foo and slice=[]int{20, 40, 60}, then the result would be `?name=20&name=40&name=60'

func IntToPointer ¶ 

func IntToPointer(i int) *int

IntToPointer is a function for converting integers into integer pointers. This is useful when passing in options to operations.

func IntWithinRange ¶ 

func IntWithinRange(val, min, max int) bool

IntWithinRange returns TRUE if an integer falls within a defined range, and FALSE if not.

func MaybeInt ¶ 

func MaybeInt(original int) *int

MaybeInt is an internal function to be used by request methods in individual resource packages.

Like MaybeString, it accepts an int that may or may not be a zero value, and returns either a pointer to its address or nil. It's intended to hint that the JSON serializer should omit its field.

func MaybeString ¶ 

func MaybeString(original string) *string

MaybeString is an internal function to be used by request methods in individual resource packages.

It takes a string that might be a zero value and returns either a pointer to its address or nil. This is useful for allowing users to conveniently omit values from an options struct by leaving them zeroed, but still pass nil to the JSON serializer so they'll be omitted from the request body.

func NormalizePathURL ¶ 

func NormalizePathURL(basePath, rawPath string) (string, error)

NormalizePathURL is used to convert rawPath to a fqdn, using basePath as a reference in the filesystem, if necessary. basePath is assumed to contain either '.' when first used, or the file:// type fqdn of the parent resource. e.g. myFavScript.yaml => file://opt/lib/myFavScript.yaml

func NormalizeURL ¶ 

func NormalizeURL(url string) string

NormalizeURL is an internal function to be used by provider clients.

It ensures that each endpoint URL has a closing `/`, as expected by ServiceClient's methods.

func WaitFor ¶ 

func WaitFor(timeout int, predicate func() (bool, error)) error

WaitFor polls a predicate function, once per second, up to a timeout limit. This is useful to wait for a resource to transition to a certain state. To handle situations when the predicate might hang indefinitely, the predicate will be prematurely cancelled after the timeout. Resource packages will wrap this in a more convenient function that's specific to a certain resource, but it can also be useful on its own.

Types ¶

type AuthOptions ¶ 

type AuthOptions struct {
	// IdentityEndpoint specifies the HTTP endpoint that is required to work with
	// the Identity API of the appropriate version. While it's ultimately needed by
	// all of the identity services, it will often be populated by a provider-level
	// function.
	//
	// The IdentityEndpoint is typically referred to as the "auth_url" or
	// "OS_AUTH_URL" in the information provided by the cloud operator.
	IdentityEndpoint string `json:"-"`

	// Username is required if using Identity V2 API. Consult with your provider's
	// control panel to discover your account's username. In Identity V3, either
	// UserID or a combination of Username and DomainID or DomainName are needed.
	Username string `json:"username,omitempty"`
	UserID   string `json:"-"`

	Password string `json:"password,omitempty"`

	// At most one of DomainID and DomainName must be provided if using Username
	// with Identity V3. Otherwise, either are optional.
	DomainID   string `json:"-"`
	DomainName string `json:"name,omitempty"`

	// The TenantID and TenantName fields are optional for the Identity V2 API.
	// The same fields are known as project_id and project_name in the Identity
	// V3 API, but are collected as TenantID and TenantName here in both cases.
	// Some providers allow you to specify a TenantName instead of the TenantId.
	// Some require both. Your provider's authentication policies will determine
	// how these fields influence authentication.
	// If DomainID or DomainName are provided, they will also apply to TenantName.
	// It is not currently possible to authenticate with Username and a Domain
	// and scope to a Project in a different Domain by using TenantName. To
	// accomplish that, the ProjectID will need to be provided as the TenantID
	// option.
	TenantID   string `json:"tenantId,omitempty"`
	TenantName string `json:"tenantName,omitempty"`

	// AllowReauth should be set to true if you grant permission for Eclcloud to
	// cache your credentials in memory, and to allow Eclcloud to attempt to
	// re-authenticate automatically if/when your token expires.  If you set it to
	// false, it will not cache these settings, but re-authentication will not be
	// possible.  This setting defaults to false.
	//
	// NOTE: The reauth function will try to re-authenticate endlessly if left
	// unchecked. The way to limit the number of attempts is to provide a custom
	// HTTP client to the provider client and provide a transport that implements
	// the RoundTripper interface and stores the number of failed retries. For an
	// example of this, see here:
	// https://github.com/rackspace/rack/blob/1.0.0/auth/clients.go#L311
	AllowReauth bool `json:"-"`

	// TokenID allows users to authenticate (possibly as another user) with an
	// authentication token ID.
	TokenID string `json:"-"`

	// Scope determines the scoping of the authentication request.
	Scope *AuthScope `json:"-"`

	// Authentication through Application Credentials requires supplying name, project and secret
	// For project we can use TenantID
	ApplicationCredentialID     string `json:"-"`
	ApplicationCredentialName   string `json:"-"`
	ApplicationCredentialSecret string `json:"-"`
}

AuthOptions stores information needed to authenticate to an Enterprise Cloud. You can populate one manually, or use a provider's AuthOptionsFromEnv() function to read relevant information from the standard environment variables. Pass one to a provider's AuthenticatedClient function to authenticate and obtain a ProviderClient representing an active session on that provider.

Its fields are the union of those recognized by each identity implementation and provider.

An example of manually providing authentication information: 

opts := eclcloud.AuthOptions{
  IdentityEndpoint: "https://keystone-{your_region}-ecl.api.ntt.com/v3/",
  Username: "{api key}",
  Password: "{api secret key}",
  TenantID: "{tenant id}",
}

provider, err := ecl.AuthenticatedClient(opts)

An example of using AuthOptionsFromEnv(), where the environment variables can be read from a file, such as a standard openrc file: 

opts, err := ecl.AuthOptionsFromEnv()
provider, err := ecl.AuthenticatedClient(opts)

func (AuthOptions) CanReauth ¶ 

func (opts AuthOptions) CanReauth() bool

func (AuthOptions) ToTokenV2CreateMap ¶ 

func (opts AuthOptions) ToTokenV2CreateMap() (map[string]interface{}, error)

ToTokenV2CreateMap allows AuthOptions to satisfy the AuthOptionsBuilder interface in the v2 tokens package

func (*AuthOptions) ToTokenV3CreateMap ¶ 

func (opts *AuthOptions) ToTokenV3CreateMap(scope map[string]interface{}) (map[string]interface{}, error)

func (*AuthOptions) ToTokenV3ScopeMap ¶ 

func (opts *AuthOptions) ToTokenV3ScopeMap() (map[string]interface{}, error)

type AuthScope ¶ 

type AuthScope struct {
	ProjectID   string
	ProjectName string
	DomainID    string
	DomainName  string
}

AuthScope allows a created token to be limited to a specific domain or project.

type Availability ¶ 

type Availability string

Availability indicates to whom a specific service endpoint is accessible: the internet at large, internal networks only, or only to administrators. Different identity services use different terminology for these. Identity v2 lists them as different kinds of URLs within the service catalog ("adminURL", "internalURL", and "publicURL"), while v3 lists them as "Interfaces" in an endpoint's response. 

const (

	// AvailabilityPublic indicates that an endpoint is available to everyone on
	// the internet.
	AvailabilityPublic Availability = "public"
)

type BaseError ¶ 

type BaseError struct {
	DefaultErrString string
	Info             string
}

BaseError is an error type that all other error types embed.

func (BaseError) Error ¶ 

func (e BaseError) Error() string

type EnabledState ¶ 

type EnabledState *bool

EnabledState is a convenience type, mostly used in Create and Update operations. Because the zero value of a bool is FALSE, we need to use a pointer instead to indicate zero-ness. 

var (
	Enabled  EnabledState = &iTrue
	Disabled EnabledState = &iFalse
)

Convenience vars for EnabledState values.

type EndpointLocator ¶ 

type EndpointLocator func(EndpointOpts) (string, error)

EndpointLocator is an internal function to be used by provider implementations.

It provides an implementation that locates a single endpoint from a service catalog for a specific ProviderClient based on user-provided EndpointOpts. The provider then uses it to discover related ServiceClients.

type EndpointOpts ¶ 

type EndpointOpts struct {
	// Type [required] is the service type for the client (e.g., "compute",
	// "object-store"). Generally, this will be supplied by the service client
	// function, but a user-given value will be honored if provided.
	Type string

	// Name [optional] is the service name for the client (e.g., "nova") as it
	// appears in the service catalog. Services can have the same Type but a
	// different Name, which is why both Type and Name are sometimes needed.
	Name string

	// Region [required] is the geographic region in which the endpoint resides,
	// generally specifying which datacenter should house your resources.
	// Required only for services that span multiple regions.
	Region string

	// Availability [optional] is the visibility of the endpoint to be returned.
	// Valid types include the constants AvailabilityPublic, AvailabilityInternal,
	// or AvailabilityAdmin from this package.
	//
	// Availability is not required, and defaults to AvailabilityPublic. Not all
	// providers or services offer all Availability options.
	Availability Availability
}

EndpointOpts specifies search criteria used by queries against an Enterprise Cloud service catalog. The options must contain enough information to unambiguously identify one, and only one, endpoint within the catalog.

Usually, these are passed to service client factory functions in a provider package, like "ecl.NewComputeV2()".

func (*EndpointOpts) ApplyDefaults ¶ 

func (eo *EndpointOpts) ApplyDefaults(t string)

ApplyDefaults is an internal method to be used by provider implementations.

It sets EndpointOpts fields if not already set, including a default type. Currently, EndpointOpts.Availability defaults to the public endpoint.

type Err400er ¶ 

type Err400er interface {
	Error400(ErrUnexpectedResponseCode) error
}

Err400er is the interface resource error types implement to override the error message from a 400 error.

type Err401er ¶ 

type Err401er interface {
	Error401(ErrUnexpectedResponseCode) error
}

Err401er is the interface resource error types implement to override the error message from a 401 error.

type Err403er ¶ 

type Err403er interface {
	Error403(ErrUnexpectedResponseCode) error
}

Err403er is the interface resource error types implement to override the error message from a 403 error.

type Err404er ¶ 

type Err404er interface {
	Error404(ErrUnexpectedResponseCode) error
}

Err404er is the interface resource error types implement to override the error message from a 404 error.

type Err405er ¶ 

type Err405er interface {
	Error405(ErrUnexpectedResponseCode) error
}

Err405er is the interface resource error types implement to override the error message from a 405 error.

type Err408er ¶ 

type Err408er interface {
	Error408(ErrUnexpectedResponseCode) error
}

Err408er is the interface resource error types implement to override the error message from a 408 error.

type Err409er ¶ 

type Err409er interface {
	Error409(ErrUnexpectedResponseCode) error
}

Err409er is the interface resource error types implement to override the error message from a 409 error.

type Err429er ¶ 

type Err429er interface {
	Error429(ErrUnexpectedResponseCode) error
}

Err429er is the interface resource error types implement to override the error message from a 429 error.

type Err500er ¶ 

type Err500er interface {
	Error500(ErrUnexpectedResponseCode) error
}

Err500er is the interface resource error types implement to override the error message from a 500 error.

type Err503er ¶ 

type Err503er interface {
	Error503(ErrUnexpectedResponseCode) error
}

Err503er is the interface resource error types implement to override the error message from a 503 error.

type ErrAPIKeyProvided ¶ 

type ErrAPIKeyProvided struct{ BaseError }

ErrAPIKeyProvided indicates that an APIKey was provided but can't be used.

func (ErrAPIKeyProvided) Error ¶ 

func (e ErrAPIKeyProvided) Error() string

type ErrAppCredMissingSecret ¶ 

type ErrAppCredMissingSecret struct{ BaseError }

ErrAppCredMissingSecret indicates that no Application Credential Secret was provided with Application Credential ID or Name

func (ErrAppCredMissingSecret) Error ¶ 

func (e ErrAppCredMissingSecret) Error() string

type ErrDefault400 ¶ 

type ErrDefault400 struct {
	ErrUnexpectedResponseCode
}

ErrDefault400 is the default error type returned on a 400 HTTP response code.

func (ErrDefault400) Error ¶ 

func (e ErrDefault400) Error() string

type ErrDefault401 ¶ 

type ErrDefault401 struct {
	ErrUnexpectedResponseCode
}

ErrDefault401 is the default error type returned on a 401 HTTP response code.

func (ErrDefault401) Error ¶ 

func (e ErrDefault401) Error() string

type ErrDefault403 ¶ 

type ErrDefault403 struct {
	ErrUnexpectedResponseCode
}

ErrDefault403 is the default error type returned on a 403 HTTP response code.

func (ErrDefault403) Error ¶ 

func (e ErrDefault403) Error() string

type ErrDefault404 ¶ 

type ErrDefault404 struct {
	ErrUnexpectedResponseCode
}

ErrDefault404 is the default error type returned on a 404 HTTP response code.

func (ErrDefault404) Error ¶ 

func (e ErrDefault404) Error() string

type ErrDefault405 ¶ 

type ErrDefault405 struct {
	ErrUnexpectedResponseCode
}

ErrDefault405 is the default error type returned on a 405 HTTP response code.

func (ErrDefault405) Error ¶ 

func (e ErrDefault405) Error() string

type ErrDefault408 ¶ 

type ErrDefault408 struct {
	ErrUnexpectedResponseCode
}

ErrDefault408 is the default error type returned on a 408 HTTP response code.

func (ErrDefault408) Error ¶ 

func (e ErrDefault408) Error() string

type ErrDefault409 ¶ 

type ErrDefault409 struct {
	ErrUnexpectedResponseCode
}

ErrDefault409 is the default error type returned on a 409 HTTP response code.

func (ErrDefault409) Error ¶ 

func (e ErrDefault409) Error() string

type ErrDefault429 ¶ 

type ErrDefault429 struct {
	ErrUnexpectedResponseCode
}

ErrDefault429 is the default error type returned on a 429 HTTP response code.

func (ErrDefault429) Error ¶ 

func (e ErrDefault429) Error() string

type ErrDefault500 ¶ 

type ErrDefault500 struct {
	ErrUnexpectedResponseCode
}

ErrDefault500 is the default error type returned on a 500 HTTP response code.

func (ErrDefault500) Error ¶ 

func (e ErrDefault500) Error() string

type ErrDefault503 ¶ 

type ErrDefault503 struct {
	ErrUnexpectedResponseCode
}

ErrDefault503 is the default error type returned on a 503 HTTP response code.

func (ErrDefault503) Error ¶ 

func (e ErrDefault503) Error() string

type ErrDomainIDOrDomainName ¶ 

type ErrDomainIDOrDomainName struct{ BaseError }

ErrDomainIDOrDomainName indicates that a username was provided, but no domain to scope it. It may also indicate that both a DomainID and a DomainName were provided at once.

func (ErrDomainIDOrDomainName) Error ¶ 

func (e ErrDomainIDOrDomainName) Error() string

type ErrDomainIDWithToken ¶ 

type ErrDomainIDWithToken struct{ BaseError }

ErrDomainIDWithToken indicates that a DomainID was provided, but token authentication is being used instead.

func (ErrDomainIDWithToken) Error ¶ 

func (e ErrDomainIDWithToken) Error() string

type ErrDomainIDWithUserID ¶ 

type ErrDomainIDWithUserID struct{ BaseError }

ErrDomainIDWithUserID indicates that a DomainID was provided, but unnecessary because a UserID is being used.

func (ErrDomainIDWithUserID) Error ¶ 

func (e ErrDomainIDWithUserID) Error() string

type ErrDomainNameWithToken ¶ 

type ErrDomainNameWithToken struct{ BaseError }

ErrDomainNameWithToken indicates that a DomainName was provided, but token authentication is being used instead.s

func (ErrDomainNameWithToken) Error ¶ 

func (e ErrDomainNameWithToken) Error() string

type ErrDomainNameWithUserID ¶ 

type ErrDomainNameWithUserID struct{ BaseError }

ErrDomainNameWithUserID indicates that a DomainName was provided, but unnecessary because a UserID is being used.

func (ErrDomainNameWithUserID) Error ¶ 

func (e ErrDomainNameWithUserID) Error() string

type ErrEndpointNotFound ¶ 

type ErrEndpointNotFound struct {
	BaseError
}

ErrEndpointNotFound is returned when no available endpoints match the provided EndpointOpts. This is also generally returned by provider service factory methods, and usually indicates that a region was specified incorrectly.

func (ErrEndpointNotFound) Error ¶ 

func (e ErrEndpointNotFound) Error() string

type ErrErrorAfterReauthentication ¶ 

type ErrErrorAfterReauthentication struct {
	BaseError
	ErrOriginal error
}

ErrErrorAfterReauthentication is the error type returned when reauthentication succeeds, but an error occurs afterword (usually an HTTP error).

func (ErrErrorAfterReauthentication) Error ¶ 

func (e ErrErrorAfterReauthentication) Error() string

type ErrInvalidInput ¶ 

type ErrInvalidInput struct {
	ErrMissingInput
	Value interface{}
}

ErrInvalidInput is an error type used for most non-HTTP Eclcloud errors.

func (ErrInvalidInput) Error ¶ 

func (e ErrInvalidInput) Error() string

type ErrMissingAnyoneOfEnvironmentVariables ¶ 

type ErrMissingAnyoneOfEnvironmentVariables struct {
	BaseError
	EnvironmentVariables []string
}

ErrMissingAnyoneOfEnvironmentVariables is the error when anyone of the environment variables is required in a particular situation but not provided by the user

func (ErrMissingAnyoneOfEnvironmentVariables) Error ¶ 

func (e ErrMissingAnyoneOfEnvironmentVariables) Error() string

type ErrMissingEnvironmentVariable ¶ 

type ErrMissingEnvironmentVariable struct {
	BaseError
	EnvironmentVariable string
}

ErrMissingEnvironmentVariable is the error when environment variable is required in a particular situation but not provided by the user

func (ErrMissingEnvironmentVariable) Error ¶ 

func (e ErrMissingEnvironmentVariable) Error() string

type ErrMissingInput ¶ 

type ErrMissingInput struct {
	BaseError
	Argument string
}

ErrMissingInput is the error when input is required in a particular situation but not provided by the user

func (ErrMissingInput) Error ¶ 

func (e ErrMissingInput) Error() string

type ErrMissingPassword ¶ 

type ErrMissingPassword struct{ BaseError }

ErrMissingPassword indicates that no password was provided and no token is available.

func (ErrMissingPassword) Error ¶ 

func (e ErrMissingPassword) Error() string

type ErrMultipleResourcesFound ¶ 

type ErrMultipleResourcesFound struct {
	BaseError
	Name         string
	Count        int
	ResourceType string
}

ErrMultipleResourcesFound is the error when trying to retrieve a resource's ID by name and multiple resources have the user-provided name.

func (ErrMultipleResourcesFound) Error ¶ 

func (e ErrMultipleResourcesFound) Error() string

type ErrResourceNotFound ¶ 

type ErrResourceNotFound struct {
	BaseError
	Name         string
	ResourceType string
}

ErrResourceNotFound is the error when trying to retrieve a resource's ID by name and the resource doesn't exist.

func (ErrResourceNotFound) Error ¶ 

func (e ErrResourceNotFound) Error() string

type ErrResult ¶ 

type ErrResult struct {
	Result
}

ErrResult is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.

It represents results that only contain a potential error and nothing else. Usually, if the operation executed successfully, the Err field will be nil; otherwise it will be stocked with a relevant error. Use the ExtractErr method to cleanly pull it out.

func (ErrResult) ExtractErr ¶ 

func (r ErrResult) ExtractErr() error

ExtractErr is a function that extracts error information, or nil, from a result.

type ErrScopeDomainIDOrDomainName ¶ 

type ErrScopeDomainIDOrDomainName struct{ BaseError }

ErrScopeDomainIDOrDomainName indicates that a domain ID or Name was required in a Scope, but not present.

func (ErrScopeDomainIDOrDomainName) Error ¶ 

func (e ErrScopeDomainIDOrDomainName) Error() string

type ErrScopeEmpty ¶ 

type ErrScopeEmpty struct{ BaseError }

ErrScopeEmpty indicates that no credentials were provided in a Scope.

func (ErrScopeEmpty) Error ¶ 

func (e ErrScopeEmpty) Error() string

type ErrScopeProjectIDAlone ¶ 

type ErrScopeProjectIDAlone struct{ BaseError }

ErrScopeProjectIDAlone indicates that a ProjectID was provided with other constraints in a Scope.

func (ErrScopeProjectIDAlone) Error ¶ 

func (e ErrScopeProjectIDAlone) Error() string

type ErrScopeProjectIDOrProjectName ¶ 

type ErrScopeProjectIDOrProjectName struct{ BaseError }

ErrScopeProjectIDOrProjectName indicates that both a ProjectID and a ProjectName were provided in a Scope.

func (ErrScopeProjectIDOrProjectName) Error ¶ 

func (e ErrScopeProjectIDOrProjectName) Error() string

type ErrServiceNotFound ¶ 

type ErrServiceNotFound struct {
	BaseError
}

ErrServiceNotFound is returned when no service in a service catalog matches the provided EndpointOpts. This is generally returned by provider service factory methods like "NewComputeV2()" and can mean that a service is not enabled for your account.

func (ErrServiceNotFound) Error ¶ 

func (e ErrServiceNotFound) Error() string

type ErrTenantIDProvided ¶ 

type ErrTenantIDProvided struct{ BaseError }

ErrTenantIDProvided indicates that a TenantID was provided but can't be used.

func (ErrTenantIDProvided) Error ¶ 

func (e ErrTenantIDProvided) Error() string

type ErrTenantNameProvided ¶ 

type ErrTenantNameProvided struct{ BaseError }

ErrTenantNameProvided indicates that a TenantName was provided but can't be used.

func (ErrTenantNameProvided) Error ¶ 

func (e ErrTenantNameProvided) Error() string

type ErrTimeOut ¶ 

type ErrTimeOut struct {
	BaseError
}

ErrTimeOut is the error type returned when an operations times out.

func (ErrTimeOut) Error ¶ 

func (e ErrTimeOut) Error() string

type ErrUnableToReauthenticate ¶ 

type ErrUnableToReauthenticate struct {
	BaseError
	ErrOriginal error
}

ErrUnableToReauthenticate is the error type returned when reauthentication fails.

func (ErrUnableToReauthenticate) Error ¶ 

func (e ErrUnableToReauthenticate) Error() string

type ErrUnexpectedResponseCode ¶ 

type ErrUnexpectedResponseCode struct {
	BaseError
	URL      string
	Method   string
	Expected []int
	Actual   int
	Body     []byte
}

ErrUnexpectedResponseCode is returned by the Request method when a response code other than those listed in OkCodes is encountered.

func (ErrUnexpectedResponseCode) Error ¶ 

func (e ErrUnexpectedResponseCode) Error() string

type ErrUnexpectedType ¶ 

type ErrUnexpectedType struct {
	BaseError
	Expected string
	Actual   string
}

ErrUnexpectedType is the error when an unexpected type is encountered

func (ErrUnexpectedType) Error ¶ 

func (e ErrUnexpectedType) Error() string

type ErrUserIDWithToken ¶ 

type ErrUserIDWithToken struct{ BaseError }

ErrUserIDWithToken indicates that a UserID was provided, but token authentication is being used instead.

func (ErrUserIDWithToken) Error ¶ 

func (e ErrUserIDWithToken) Error() string

type ErrUsernameOrUserID ¶ 

type ErrUsernameOrUserID struct{ BaseError }

ErrUsernameOrUserID indicates that neither username nor userID are specified, or both are at once.

func (ErrUsernameOrUserID) Error ¶ 

func (e ErrUsernameOrUserID) Error() string

type ErrUsernameWithToken ¶ 

type ErrUsernameWithToken struct{ BaseError }

ErrUsernameWithToken indicates that a Username was provided, but token authentication is being used instead.

func (ErrUsernameWithToken) Error ¶ 

func (e ErrUsernameWithToken) Error() string

type HeaderResult ¶ 

type HeaderResult struct {
	Result
}

HeaderResult is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.

It represents a result that only contains an error (possibly nil) and an http.Header. This is used, for example, by the objectstorage packages in Enterprise Cloud, because most of the operations don't return response bodies, but do have relevant information in headers.

func (HeaderResult) ExtractInto ¶ 

func (r HeaderResult) ExtractInto(to interface{}) error

ExtractInto allows users to provide an object into which `Extract` will extract the http.Header headers of the result.

type IPVersion ¶ 

type IPVersion int

IPVersion is a type for the possible IP address versions. Valid instances are IPv4 and IPv6 

const (
	// IPv4 is used for IP version 4 addresses
	IPv4 IPVersion = 4
	// IPv6 is used for IP version 6 addresses
	IPv6 IPVersion = 6
)

type JSONISO8601 ¶ 

type JSONISO8601 time.Time

func (*JSONISO8601) UnmarshalJSON ¶ 

func (jt *JSONISO8601) UnmarshalJSON(data []byte) error

type JSONRFC1123 ¶ 

type JSONRFC1123 time.Time

func (*JSONRFC1123) UnmarshalJSON ¶ 

func (jt *JSONRFC1123) UnmarshalJSON(data []byte) error

type JSONRFC3339Milli ¶ 

type JSONRFC3339Milli time.Time

func (*JSONRFC3339Milli) UnmarshalJSON ¶ 

func (jt *JSONRFC3339Milli) UnmarshalJSON(data []byte) error

type JSONRFC3339MilliNoZ ¶ 

type JSONRFC3339MilliNoZ time.Time

func (*JSONRFC3339MilliNoZ) UnmarshalJSON ¶ 

func (jt *JSONRFC3339MilliNoZ) UnmarshalJSON(data []byte) error

type JSONRFC3339NoZ ¶ 

type JSONRFC3339NoZ time.Time

func (*JSONRFC3339NoZ) UnmarshalJSON ¶ 

func (jt *JSONRFC3339NoZ) UnmarshalJSON(data []byte) error

type JSONRFC3339ZNoT ¶ 

type JSONRFC3339ZNoT time.Time

func (*JSONRFC3339ZNoT) UnmarshalJSON ¶ 

func (jt *JSONRFC3339ZNoT) UnmarshalJSON(data []byte) error

type JSONRFC3339ZNoTNoZ ¶ 

type JSONRFC3339ZNoTNoZ time.Time

func (*JSONRFC3339ZNoTNoZ) UnmarshalJSON ¶ 

func (jt *JSONRFC3339ZNoTNoZ) UnmarshalJSON(data []byte) error

type JSONUnix ¶ 

type JSONUnix time.Time

func (*JSONUnix) UnmarshalJSON ¶ 

func (jt *JSONUnix) UnmarshalJSON(data []byte) error
type Link struct {
	Href string `json:"href"`
	Rel  string `json:"rel"`
}

Link is an internal type to be used in packages of collection resources that are paginated in a certain way.

It's a response substructure common to many paginated collection results that is used to point to related pages. Usually, the one we care about is the one with Rel field set to "next".

type ProviderClient ¶ 

type ProviderClient struct {
	// IdentityBase is the base URL used for a particular provider's identity
	// service - it will be used when issuing authenticatation requests. It
	// should point to the root resource of the identity service, not a specific
	// identity version.
	IdentityBase string

	// IdentityEndpoint is the identity endpoint. This may be a specific version
	// of the identity service. If this is the case, this endpoint is used rather
	// than querying versions first.
	IdentityEndpoint string

	// TokenID is the ID of the most recently issued valid token.
	// NOTE: Aside from within a custom ReauthFunc, this field shouldn't be set by an application.
	// To safely read or write this value, call `Token` or `SetToken`, respectively
	TokenID string

	// EndpointLocator describes how this provider discovers the endpoints for
	// its constituent services.
	EndpointLocator EndpointLocator

	// HTTPClient allows users to interject arbitrary http, https, or other transit behaviors.
	HTTPClient http.Client

	// UserAgent represents the User-Agent header in the HTTP request.
	UserAgent UserAgent

	// ReauthFunc is the function used to re-authenticate the user if the request
	// fails with a 401 HTTP response code. This a needed because there may be multiple
	// authentication functions for different Identity service versions.
	ReauthFunc func() error
	// contains filtered or unexported fields
}

ProviderClient stores details that are required to interact with any services within a specific provider's API.

Generally, you acquire a ProviderClient by calling the NewClient method in the appropriate provider's child package, providing whatever authentication credentials are required.

func (*ProviderClient) AuthenticatedHeaders ¶ 

func (client *ProviderClient) AuthenticatedHeaders() (m map[string]string)

AuthenticatedHeaders returns a map of HTTP headers that are common for all authenticated service requests.

func (*ProviderClient) Reauthenticate ¶ 

func (client *ProviderClient) Reauthenticate(previousToken string) (err error)

Reauthenticate calls client.ReauthFunc in a thread-safe way. If this is called because of a 401 response, the caller may pass the previous token. In this case, the reauthentication can be skipped if another thread has already reauthenticated in the meantime. If no previous token is known, an empty string should be passed instead to force unconditional reauthentication.

func (*ProviderClient) Request ¶ 

func (client *ProviderClient) Request(method, url string, options *RequestOpts) (*http.Response, error)

Request performs an HTTP request using the ProviderClient's current HTTPClient. An authentication header will automatically be provided.

func (*ProviderClient) SetToken ¶ 

func (client *ProviderClient) SetToken(t string)

SetToken safely sets the value of the auth token in the ProviderClient. Applications may use this method in a custom ReauthFunc

func (*ProviderClient) Token ¶ 

func (client *ProviderClient) Token() string

Token safely reads the value of the auth token from the ProviderClient. Applications should call this method to access the token instead of the TokenID field

func (*ProviderClient) UseTokenLock ¶ 

func (client *ProviderClient) UseTokenLock()

UseTokenLock creates a mutex that is used to allow safe concurrent access to the auth token. If the application's ProviderClient is not used concurrently, this doesn't need to be called.

type RequestOpts ¶ 

type RequestOpts struct {
	// JSONBody, if provided, will be encoded as JSON and used as the body of the HTTP request. The
	// content type of the request will default to "application/json" unless overridden by MoreHeaders.
	// It's an error to specify both a JSONBody and a RawBody.
	JSONBody interface{}
	// RawBody contains an io.Reader that will be consumed by the request directly. No content-type
	// will be set unless one is provided explicitly by MoreHeaders.
	RawBody io.Reader
	// JSONResponse, if provided, will be populated with the contents of the response body parsed as
	// JSON.
	JSONResponse interface{}
	// OkCodes contains a list of numeric HTTP status codes that should be interpreted as success. If
	// the response has a different code, an error will be returned.
	OkCodes []int
	// MoreHeaders specifies additional HTTP headers to be provide on the request. If a header is
	// provided with a blank value (""), that header will be *omitted* instead: use this to suppress
	// the default Accept header or an inferred Content-Type, for example.
	MoreHeaders map[string]string
	// ErrorContext specifies the resource error type to return if an error is encountered.
	// This lets resources override default error messages based on the response status code.
	ErrorContext error
}

RequestOpts customizes the behavior of the provider.Request() method.

type Result ¶ 

type Result struct {
	// Body is the payload of the HTTP response from the server. In most cases,
	// this will be the deserialized JSON structure.
	Body interface{}

	// Header contains the HTTP header structure from the original response.
	Header http.Header

	// Err is an error that occurred during the operation. It's deferred until
	// extraction to make it easier to chain the Extract call.
	Err error
}

Result is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.

It acts as a base struct that other Result types, returned from request functions, can embed for convenience. All Results capture basic information from the HTTP transaction that was performed, including the response body, HTTP headers, and any errors that happened.

Generally, each Result type will have an Extract method that can be used to further interpret the result's payload in a specific context. Extensions or providers can then provide additional extraction functions to pull out provider- or extension-specific information as well.

func (Result) ExtractInto ¶ 

func (r Result) ExtractInto(to interface{}) error

ExtractInto allows users to provide an object into which `Extract` will extract the `Result.Body`. This would be useful for Enterprise Cloud providers that have different fields in the response object than Enterprise Cloud proper.

func (Result) ExtractIntoSlicePtr ¶ 

func (r Result) ExtractIntoSlicePtr(to interface{}, label string) error

ExtractIntoSlicePtr will unmarshal the Result (r) into the provided interface{} (to).

NOTE: For internal use only

`to` must be a pointer to an underlying slice type

If provided, `label` will be filtered out of the response body prior to `r` being unmarshalled into `to`.

func (Result) ExtractIntoStructPtr ¶ 

func (r Result) ExtractIntoStructPtr(to interface{}, label string) error

ExtractIntoStructPtr will unmarshal the Result (r) into the provided interface{} (to).

NOTE: For internal use only

`to` must be a pointer to an underlying struct type

If provided, `label` will be filtered out of the response body prior to `r` being unmarshalled into `to`.

func (Result) PrettyPrintJSON ¶ 

func (r Result) PrettyPrintJSON() string

PrettyPrintJSON creates a string containing the full response body as pretty-printed JSON. It's useful for capturing test fixtures and for debugging extraction bugs. If you include its output in an issue related to a buggy extraction function, we will all love you forever.

type ServiceClient ¶ 

type ServiceClient struct {
	// ProviderClient is a reference to the provider that implements this service.
	*ProviderClient

	// Endpoint is the base URL of the service's API, acquired from a service catalog.
	// It MUST end with a /.
	Endpoint string

	// ResourceBase is the base URL shared by the resources within a service's API. It should include
	// the API version and, like Endpoint, MUST end with a / if set. If not set, the Endpoint is used
	// as-is, instead.
	ResourceBase string

	// This is the service client type (e.g. compute, network).
	Type string

	// The microversion of the service to use. Set this to use a particular microversion.
	Microversion string

	// MoreHeaders allows users (or Eclcloud) to set service-wide headers on requests. Put another way,
	// values set in this field will be set on all the HTTP requests the service client sends.
	MoreHeaders map[string]string
}

ServiceClient stores details required to interact with a specific service API implemented by a provider. Generally, you'll acquire these by calling the appropriate `New` method on a ProviderClient.

func (*ServiceClient) Delete ¶ 

func (client *ServiceClient) Delete(url string, opts *RequestOpts) (*http.Response, error)

Delete calls `Request` with the "DELETE" HTTP verb.

func (*ServiceClient) Get ¶ 

func (client *ServiceClient) Get(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Get calls `Request` with the "GET" HTTP verb.

func (*ServiceClient) Head ¶ 

func (client *ServiceClient) Head(url string, opts *RequestOpts) (*http.Response, error)

Head calls `Request` with the "HEAD" HTTP verb.

func (*ServiceClient) Patch ¶ 

func (client *ServiceClient) Patch(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Patch calls `Request` with the "PATCH" HTTP verb.

func (*ServiceClient) Post ¶ 

func (client *ServiceClient) Post(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Post calls `Request` with the "POST" HTTP verb.

func (*ServiceClient) Put ¶ 

func (client *ServiceClient) Put(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)

Put calls `Request` with the "PUT" HTTP verb.

func (*ServiceClient) Request ¶ 

func (client *ServiceClient) Request(method, url string, options *RequestOpts) (*http.Response, error)

Request carries out the HTTP operation for the service client

func (*ServiceClient) ResourceBaseURL ¶ 

func (client *ServiceClient) ResourceBaseURL() string

ResourceBaseURL returns the base URL of any resources used by this service. It MUST end with a /.

func (*ServiceClient) ServiceURL ¶ 

func (client *ServiceClient) ServiceURL(parts ...string) string

ServiceURL constructs a URL for a resource belonging to this provider.

type UserAgent ¶ 

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

UserAgent represents a User-Agent header.

func (*UserAgent) Join ¶ 

func (ua *UserAgent) Join() string

Join concatenates all the user-defined User-Agend strings with the default Eclcloud User-Agent string.

func (*UserAgent) Prepend ¶ 

func (ua *UserAgent) Prepend(s ...string)

Prepend prepends a user-defined string to the default User-Agent string. Users may pass in one or more strings to prepend.

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
ecl
Package ecl contains resources for the individual Enterprise Cloud projects supported in eclcloud.
 Package ecl contains resources for the individual Enterprise Cloud projects supported in eclcloud.
baremetal/v2/availabilityzones
Package availabilityzones provides the ability to get lists and detailed availability zone information and to extend a server result with availability zone information.
 Package availabilityzones provides the ability to get lists and detailed availability zone information and to extend a server result with availability zone information.
baremetal/v2/availabilityzones/testing
Package testing contains baremetal availability zone unit tests
 Package testing contains baremetal availability zone unit tests
baremetal/v2/flavors
Package flavors contains functionality for working with ECL Baremetal Server's flavor resources.
 Package flavors contains functionality for working with ECL Baremetal Server's flavor resources.
baremetal/v2/flavors/testing
Package testing contains baremetal flavor unit tests
 Package testing contains baremetal flavor unit tests
baremetal/v2/keypairs
Package keypairs provides the ability to manage key pairs.
 Package keypairs provides the ability to manage key pairs.
baremetal/v2/keypairs/testing
Package testing contains keypairs unit tests
 Package testing contains keypairs unit tests
baremetal/v2/servers
Package servers contains functionality for working with ECL Baremetal Server resources.
 Package servers contains functionality for working with ECL Baremetal Server resources.
baremetal/v2/servers/testing
Package testing contains baremetal server unit tests
 Package testing contains baremetal server unit tests
compute/v2/extensions/availabilityzones
Package availabilityzones provides the ability to get lists and detailed availability zone information and to extend a server result with availability zone information.
 Package availabilityzones provides the ability to get lists and detailed availability zone information and to extend a server result with availability zone information.
compute/v2/extensions/availabilityzones/testing
availabilityzones unittests
 availabilityzones unittests
compute/v2/extensions/bootfromvolume
Package bootfromvolume extends a server create request with the ability to specify block device options.
 Package bootfromvolume extends a server create request with the ability to specify block device options.
compute/v2/extensions/bootfromvolume/testing
Package testing contains bootfromvolume unit tests
 Package testing contains bootfromvolume unit tests
compute/v2/extensions/keypairs
Package keypairs provides the ability to manage key pairs as well as create servers with a specified key pair.
 Package keypairs provides the ability to manage key pairs as well as create servers with a specified key pair.
compute/v2/extensions/keypairs/testing
Package testing contains keypairs unit tests
 Package testing contains keypairs unit tests
compute/v2/extensions/startstop
Package startstop provides functionality to start and stop servers that have been provisioned by the Enterprise Cloud Compute service.
 Package startstop provides functionality to start and stop servers that have been provisioned by the Enterprise Cloud Compute service.
compute/v2/extensions/startstop/testing
Package testing contains startstop unit tests
 Package testing contains startstop unit tests
compute/v2/extensions/volumeattach
Package volumeattach provides the ability to attach and detach volumes from servers.
 Package volumeattach provides the ability to attach and detach volumes from servers.
compute/v2/extensions/volumeattach/testing
Package testing contains volumeattach unit tests
 Package testing contains volumeattach unit tests
compute/v2/flavors
Package flavors provides information and interaction with the flavor API in the Enterprise Cloud Compute service.
 Package flavors provides information and interaction with the flavor API in the Enterprise Cloud Compute service.
compute/v2/images
Package images provides information and interaction with the images through the Enterprise Cloud Compute service.
 Package images provides information and interaction with the images through the Enterprise Cloud Compute service.
compute/v2/servers
Package servers provides information and interaction with the server API resource in the Enterprise Cloud Compute service.
 Package servers provides information and interaction with the server API resource in the Enterprise Cloud Compute service.
compute/v2/servers/testing
Compute Server unit tests
 Compute Server unit tests
computevolume/extensions/volumeactions
Package volumeactions provides information and interaction with volumes in the Enterprise Cloud Block Storage service.
 Package volumeactions provides information and interaction with volumes in the Enterprise Cloud Block Storage service.
computevolume/extensions/volumeactions/testing
volumeactions unit tests
 volumeactions unit tests
computevolume/v2/volumes
Package volumes provides information and interaction with volumes in the Enterprise Cloud Block Storage service.
 Package volumes provides information and interaction with volumes in the Enterprise Cloud Block Storage service.
computevolume/v2/volumes/testing
volumes_v2 unittest
 volumes_v2 unittest
dedicated_hypervisor/v1/license_types
Package license_types manages and retrieves license type in the Enterprise Cloud Dedicated Hypervisor Service.
 Package license_types manages and retrieves license type in the Enterprise Cloud Dedicated Hypervisor Service.
dedicated_hypervisor/v1/license_types/testing
dedicated_hypervisor/v1/licenses
Package licenses manages and retrieves license in the Enterprise Cloud Dedicated Hypervisor Service.
 Package licenses manages and retrieves license in the Enterprise Cloud Dedicated Hypervisor Service.
dedicated_hypervisor/v1/licenses/testing
dedicated_hypervisor/v1/servers
Package servers manages and retrieves servers in the Enterprise Cloud Dedicated Hypervisor Service.
 Package servers manages and retrieves servers in the Enterprise Cloud Dedicated Hypervisor Service.
dedicated_hypervisor/v1/servers/testing
dedicated_hypervisor/v1/usages
Package usages manages and retrieves usage in the Enterprise Cloud Dedicated Hypervisor Service.
 Package usages manages and retrieves usage in the Enterprise Cloud Dedicated Hypervisor Service.
dedicated_hypervisor/v1/usages/testing
dns/v2/recordsets
Package recordsets provides information and interaction with the zone API resource for the Enterprise Cloud DNS service.
 Package recordsets provides information and interaction with the zone API resource for the Enterprise Cloud DNS service.
dns/v2/recordsets/testing
recordsets unit tests
 recordsets unit tests
dns/v2/zones
Package zones provides information and interaction with the zone API resource for the Enterprise Cloud DNS service.
 Package zones provides information and interaction with the zone API resource for the Enterprise Cloud DNS service.
dns/v2/zones/testing
zones unit tests
 zones unit tests
identity/v3/endpoints
Package endpoints provides information and interaction with the service endpoints API resource in the Enterprise Cloud Identity service.
 Package endpoints provides information and interaction with the service endpoints API resource in the Enterprise Cloud Identity service.
identity/v3/groups
Package groups manages and retrieves Groups in the Enterprise Cloud Identity Service.
 Package groups manages and retrieves Groups in the Enterprise Cloud Identity Service.
identity/v3/projects
Package projects manages and retrieves Projects in the Enterprise Cloud Identity Service.
 Package projects manages and retrieves Projects in the Enterprise Cloud Identity Service.
identity/v3/roles
Package roles provides information and interaction with the roles API resource for the Enterprise Cloud Identity service.
 Package roles provides information and interaction with the roles API resource for the Enterprise Cloud Identity service.
identity/v3/services
Package services provides information and interaction with the services API resource for the Enterprise Cloud Identity service.
 Package services provides information and interaction with the services API resource for the Enterprise Cloud Identity service.
identity/v3/tokens
Package tokens provides information and interaction with the token API resource for the Enterprise Cloud Identity service.
 Package tokens provides information and interaction with the token API resource for the Enterprise Cloud Identity service.
identity/v3/users
Package users manages and retrieves Users in the Enterprise Cloud Identity Service.
 Package users manages and retrieves Users in the Enterprise Cloud Identity Service.
imagestorage/v2/imagedata
Package imagedata enables management of image data.
 Package imagedata enables management of image data.
imagestorage/v2/imagedata/testing
imagedata unit tests
 imagedata unit tests
imagestorage/v2/images
Package images enables management and retrieval of images from the Enterprise Cloud Image Service.
 Package images enables management and retrieval of images from the Enterprise Cloud Image Service.
imagestorage/v2/images/testing
Package testing contains images unit tests
 Package testing contains images unit tests
imagestorage/v2/members
imagestorage/v2/members/testing
members unit tests
 members unit tests
network/v2/common
network/v2/common_function_gateways
Package common_function_gateways contains functionality for working with ECL Commnon Function Gateway resources.
 Package common_function_gateways contains functionality for working with ECL Commnon Function Gateway resources.
network/v2/common_function_gateways/testing
Package testing contains common function gateways unit tests
 Package testing contains common function gateways unit tests
network/v2/common_function_pool
Package common_function_pool contains functionality for working with ECL Common Function Pool resources.
 Package common_function_pool contains functionality for working with ECL Common Function Pool resources.
network/v2/common_function_pool/testing
Common Function Pool unit tests
 Common Function Pool unit tests
network/v2/fic_gateways
Package fic_gateways provides information of several service in the Enterprise Cloud Compute service Example to List FIC Gateways listOpts := fic_gateways.ListOpts{ Status: "ACTIVE", } allPages, err := fic_gateways.List(client, listOpts).AllPages() if err != nil { panic(err) } allFICGateways, err := fic_gateways.ExtractFICGateways(allPages) if err != nil { panic(err) } for _, ficGateway := range allFICGateways { fmt.Printf("%+v", ficGateway) } Example to Show FIC Gateway id := "02dc9a22-129c-4b12-9936-4080f6a7ae44" ficGateway, err := fic_gateways.Get(client, id).Extract() if err != nil { panic(err) } fmt.Print(ficGateway)
 Package fic_gateways provides information of several service in the Enterprise Cloud Compute service Example to List FIC Gateways listOpts := fic_gateways.ListOpts{ Status: "ACTIVE", } allPages, err := fic_gateways.List(client, listOpts).AllPages() if err != nil { panic(err) } allFICGateways, err := fic_gateways.ExtractFICGateways(allPages) if err != nil { panic(err) } for _, ficGateway := range allFICGateways { fmt.Printf("%+v", ficGateway) } Example to Show FIC Gateway id := "02dc9a22-129c-4b12-9936-4080f6a7ae44" ficGateway, err := fic_gateways.Get(client, id).Extract() if err != nil { panic(err) } fmt.Print(ficGateway)
network/v2/fic_gateways/testing
ports unit tests
 ports unit tests
network/v2/gateway_interfaces
network/v2/gateway_interfaces/testing
gateway_interfaces unit tests
 gateway_interfaces unit tests
network/v2/internet_gateways
network/v2/internet_gateways/testing
internet_gateways unit tests
 internet_gateways unit tests
network/v2/internet_services
network/v2/internet_services/testing
network/v2/load_balancer_actions
Package load_balancer_actions contains functionality for working with ECL Load Balancer/Actions resources.
 Package load_balancer_actions contains functionality for working with ECL Load Balancer/Actions resources.
network/v2/load_balancer_actions/testing
Load Balancer/Actions unit tests
 Load Balancer/Actions unit tests
network/v2/load_balancer_interfaces
Package load_balancer_interfaces contains functionality for working with ECL Load Balancer Interface resources.
 Package load_balancer_interfaces contains functionality for working with ECL Load Balancer Interface resources.
network/v2/load_balancer_interfaces/testing
Load Balancer Interfaces unit tests
 Load Balancer Interfaces unit tests
network/v2/load_balancer_plans
Package load_balancer_plans contains functionality for working with ECL Load Balancer Plan resources.
 Package load_balancer_plans contains functionality for working with ECL Load Balancer Plan resources.
network/v2/load_balancer_plans/testing
Load Balancer Plans unit tests
 Load Balancer Plans unit tests
network/v2/load_balancer_syslog_servers
Package load_balancer_syslog_servers contains functionality for working with ECL Load Balancer Syslog Server resources.
 Package load_balancer_syslog_servers contains functionality for working with ECL Load Balancer Syslog Server resources.
network/v2/load_balancer_syslog_servers/testing
Load Balancer Syslog Servers unit tests
 Load Balancer Syslog Servers unit tests
network/v2/load_balancers
Package load_balancers contains functionality for working with ECL Load Balancer resources.
 Package load_balancers contains functionality for working with ECL Load Balancer resources.
network/v2/load_balancers/testing
Load Balancers unit tests
 Load Balancers unit tests
network/v2/networks
Package networks contains functionality for working with Neutron network resources.
 Package networks contains functionality for working with Neutron network resources.
network/v2/networks/testing
ports unit tests
 ports unit tests
network/v2/ports
Package ports contains functionality for working with Neutron port resources.
 Package ports contains functionality for working with Neutron port resources.
network/v2/ports/testing
ports unit tests
 ports unit tests
network/v2/public_ips
network/v2/public_ips/testing
public_ips unit tests
 public_ips unit tests
network/v2/qos_options
Package qos_options provides information of several service in the Enterprise Cloud Compute service Example to List QoS Options listOpts := qos_options.ListOpts{ QoSType: "guarantee", } allPages, err := qos_options.List(client, listOpts).AllPages() if err != nil { panic(err) } allQoSOptions, err := qos_options.ExtractQoSOptions(allPages) if err != nil { panic(err) } for _, qosOption := range allQoSOptions { fmt.Printf("%+v", qosOption) } Example to Show QoS Option id := "02dc9a22-129c-4b12-9936-4080f6a7ae44" qosOption, err := qos_options.Get(client, id).Extract() if err != nil { panic(err) } fmt.Print(qosOption)
 Package qos_options provides information of several service in the Enterprise Cloud Compute service Example to List QoS Options listOpts := qos_options.ListOpts{ QoSType: "guarantee", } allPages, err := qos_options.List(client, listOpts).AllPages() if err != nil { panic(err) } allQoSOptions, err := qos_options.ExtractQoSOptions(allPages) if err != nil { panic(err) } for _, qosOption := range allQoSOptions { fmt.Printf("%+v", qosOption) } Example to Show QoS Option id := "02dc9a22-129c-4b12-9936-4080f6a7ae44" qosOption, err := qos_options.Get(client, id).Extract() if err != nil { panic(err) } fmt.Print(qosOption)
network/v2/qos_options/testing
ports unit tests
 ports unit tests
network/v2/static_routes
network/v2/static_routes/testing
public_ips unit tests
 public_ips unit tests
network/v2/subnets
Package subnets contains functionality for working with Neutron subnet resources.
 Package subnets contains functionality for working with Neutron subnet resources.
network/v2/subnets/testing
ports unit tests
 ports unit tests
provider_connectivity/v2/tenant_connection_requests
Package tenant_connection_requests manages and retrieves Tenant Connection Request in the Enterprise Cloud Provider Connectivity Service.
 Package tenant_connection_requests manages and retrieves Tenant Connection Request in the Enterprise Cloud Provider Connectivity Service.
provider_connectivity/v2/tenant_connection_requests/testing
Tenant Connection Request unit tests
 Tenant Connection Request unit tests
provider_connectivity/v2/tenant_connections
Package tenant_connections manages and retrieves Tenant Connection in the Enterprise Cloud Provider Connectivity Service.
 Package tenant_connections manages and retrieves Tenant Connection in the Enterprise Cloud Provider Connectivity Service.
provider_connectivity/v2/tenant_connections/testing
Tenant Connection unit tests
 Tenant Connection unit tests
rca/v1/users
Package users manages and retrieves users in the Enterprise Cloud Remote Console Access Service.
 Package users manages and retrieves users in the Enterprise Cloud Remote Console Access Service.
rca/v1/users/testing
security_order/v1/host_based
Package host_based contains Host Based Security functionality.
 Package host_based contains Host Based Security functionality.
security_order/v1/host_based/testing
Package testing contains host based security unittests
 Package testing contains host based security unittests
security_order/v1/network_based_device_ha
Package network_based_device_ha contains HA device functionality on security.
 Package network_based_device_ha contains HA device functionality on security.
security_order/v1/network_based_device_ha/testing
Package testing contains network based security HA device unittests
 Package testing contains network based security HA device unittests
security_order/v1/network_based_device_single
Package network_based_device_single contains single device functionality on security.
 Package network_based_device_single contains single device functionality on security.
security_order/v1/network_based_device_single/testing
Package testing contains network based security single device unittests
 Package testing contains network based security single device unittests
security_order/v1/service_order_status
Package service_order_status contains order management functionality on security
 Package service_order_status contains order management functionality on security
security_order/v1/service_order_status/testing
Package testing contains service order status unit tests
 Package testing contains service order status unit tests
security_portal/v1/device_interfaces
Package device_interfaces contains device management functionality in security portal API
 Package device_interfaces contains device management functionality in security portal API
security_portal/v1/device_interfaces/testing
Package testing contains device interfaces unit tests
 Package testing contains device interfaces unit tests
security_portal/v1/devices
Package devices contains device management functionality in security portal API
 Package devices contains device management functionality in security portal API
security_portal/v1/devices/testing
Package testing contains devices unit tests
 Package testing contains devices unit tests
security_portal/v1/ha_ports
Package ha_ports contains port management functionality in security portal API
 Package ha_ports contains port management functionality in security portal API
security_portal/v1/ha_ports/testing
Package testing contains ports unit tests
 Package testing contains ports unit tests
security_portal/v1/ports
Package ports contains port management functionality in security portal API
 Package ports contains port management functionality in security portal API
security_portal/v1/ports/testing
Package testing contains ports unit tests
 Package testing contains ports unit tests
security_portal/v1/processes
Package process contains port management functionality on security
 Package process contains port management functionality on security
security_portal/v1/processes/testing
Package testing contains processes unit tests
 Package testing contains processes unit tests
sss/v1/approval_requests
Package approval_requests manages and retrieves approval requests in the Enterprise Cloud.
 Package approval_requests manages and retrieves approval requests in the Enterprise Cloud.
sss/v1/approval_requests/testing
sss approval request unit tests
 sss approval request unit tests
sss/v1/tenants
Package projects manages and retrieves Projects in the ECL SSS Service.
 Package projects manages and retrieves Projects in the ECL SSS Service.
sss/v1/tenants/testing
sss tenant unit tests
 sss tenant unit tests
sss/v1/users
Package users contains user management functionality on SSS
 Package users contains user management functionality on SSS
sss/v1/users/testing
sss user unit tests
 sss user unit tests
storage/v1/virtualstorages
Package virtualstorages provides information and interaction with virtualstorage in the Enterprise Cloud Block Storage service.
 Package virtualstorages provides information and interaction with virtualstorage in the Enterprise Cloud Block Storage service.
storage/v1/virtualstorages/testing
Package testing contains virtual storage unit tests
 Package testing contains virtual storage unit tests
storage/v1/volumes
Package volume provides information and interaction with volume in the Storage service.
 Package volume provides information and interaction with volume in the Storage service.
storage/v1/volumes/testing
Package testing contains volume unit tests
 Package testing contains volume unit tests
storage/v1/volumetypes
storage/v1/volumetypes/testing
Package testing contains volume type unit tests
 Package testing contains volume type unit tests
utils
vna/v1/appliances
Package appliances contains functionality for working with ECL Commnon Function Gateway resources.
 Package appliances contains functionality for working with ECL Commnon Function Gateway resources.
vna/v1/appliances/testing
Package testing contains virtual network appliance unit tests
 Package testing contains virtual network appliance unit tests
testing
Package pagination contains utilities and convenience structs that implement common pagination idioms within Enterprise Cloud APIs.
 Package pagination contains utilities and convenience structs that implement common pagination idioms within Enterprise Cloud APIs.
testing
pagination
 pagination
Package testhelper container methods that are useful for writing unit tests.
 Package testhelper container methods that are useful for writing unit tests.
client
fixture
Package testing contains eclcloud tests.
 Package testing contains eclcloud tests.

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.