golangsdk

README

GopherTelekomCloud: a OpenTelekomCloud SDK for Golang

GopherTelekomCloud is a OpenTelekomCloud clouds Go SDK. GopherTelekomCloud is based on Gophercloud which is an OpenStack Go SDK and has a great design. GopherTelekomCloud has added and removed some features to support OpenTelekomCloud.

Useful links

• Reference documentation
• Effective Go

How to install

Installation with modern Go and go mod is really simple:

Just run go mod download to install all dependencies.

Getting started

Credentials

Because you'll be hitting an API, you will need to retrieve your OpenTelekomCloud credentials and store them using standard Openstack approaches: either clouds.yaml file (recommended) or environment variables.

You will need to retrieve the following:

• domain name
• username
• password
• project name/id (for most of the services)
• a valid IAM identity URL

Authentication

Once you have access to your credentials, you can begin plugging them into Golangsdk. 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 Golangsdk to use environment variables:

Option 1: Pass in the values yourself

opts := golangsdk.AuthOptions{
IdentityEndpoint: "https://openstack.example.com:5000/v2.0",
Username:         "{username}",
Password:         "{password}",
}
client, err := openstack.AuthenticatedClient(opts)

Option 2: Use a utility function to retrieve cloud configuration from env variables and configuration files

env := openstack.NewEnv("OS_") // use OS_ prefixed env variables
client, err := env.AuthenticatedClient()

The ProviderClient is the top-level client that all of your OpenTelekomCloud 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 rds instance

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

client, err := openstack.NewRdsServiceV1(provider, golangsdk.EndpointOpts{
	Region: utils.GetRegion(ao),
})

We then use this client for any rds API operation we want. In our case, we want to provision a rds instance - so we invoke the Create method and pass in the name and the flavor ID (database specification) we're interested in:

import "github.com/opentelekomcloud/gophertelekomcloud/openstack/rds/v1/instances"

instance, err := instances.Create(client, instances.CreateOpts{
	Name:      "My new rds instance!",
	FlavorRef: "flavor_id",
}).Extract()

The above code sample creates a new rds instance with the parameters, and embodies the new resource in the instance variable (ainstances.Instance struct).

Advanced Usage

Have a look at the FAQ for some tips on customizing the way Golangsdk 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 golangsdk provides a multi-vendor interface to OpenStack-compatible clouds. 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 OpenStack cloud.

Use your OpenStack credentials to create a Provider client. The IdentityEndpoint is typically refered 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 := golangsdk.AuthOptions{
  IdentityEndpoint: "https://openstack.example.com:5000/v2.0",
  Username: "{username}",
  Password: "{password}",
  TenantID: "{tenant_id}",
}

provider, err := openstack.AuthenticatedClient(opts)

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

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

Service Clients

Service structs are specific to a provider and handle all of the logic and operations for a particular OpenStack 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 := golangsdk.EndpointOpts{Region: "RegionOne"}

client := openstack.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
• func BuildHeaders(opts interface{}) (map[string]string, error)
• func BuildQueryString(opts interface{}) (*url.URL, error)
• func BuildRequestBody(opts interface{}, parent string) (map[string]interface{}, error)
• func ExtractNextURL(links []Link) (string, error)
• func GetJobEndpoint(endpoint string) string
• func GetJobEntity(client *ServiceClient, uri string, label string) (interface{}, error)
• func HashSha256(msg []byte) []byte
• func HmacSha256(data string, key []byte) []byte
• func IntToPointer(i int) *int
• func MaybeInt(original int) *int
• func MaybeString(original string) *string
• func NormalizePathURL(basePath, rawPath string) (string, error)
• func NormalizeURL(url string) string
• func PrettyPrintJSON(body interface{}) string
• func ReSign(req *http.Request, signOptions SignOptions)
• func Sign(req *http.Request, signOptions SignOptions)
• func WaitFor(timeout int, predicate func() (bool, error)) error
• func WaitForJobSuccess(client *ServiceClient, uri string, secs int) error
• type AKSKAuthOptions
  • func (opts AKSKAuthOptions) GetIdentityEndpoint() string
• type AgencyAuthOptions
  • func (opts *AgencyAuthOptions) AuthHeaderDomainID() string
  • func (opts *AgencyAuthOptions) AuthTokenID() string
  • func (opts *AgencyAuthOptions) CanReauth() bool
  • func (opts *AgencyAuthOptions) ToTokenV3CreateMap(scope map[string]interface{}) (map[string]interface{}, error)
  • func (opts *AgencyAuthOptions) ToTokenV3ScopeMap() (map[string]interface{}, error)
• type AuthOptions
  • func (opts *AuthOptions) AuthHeaderDomainID() string
  • func (opts *AuthOptions) AuthTokenID() string
  • func (opts *AuthOptions) CanReauth() bool
  • func (opts AuthOptions) GetIdentityEndpoint() string
  • func (opts AuthOptions) ToTokenV2CreateMap() (map[string]interface{}, error)
  • func (opts *AuthOptions) ToTokenV3CreateMap(scope map[string]interface{}) (map[string]interface{}, error)
  • func (opts *AuthOptions) ToTokenV3ScopeMap() (map[string]interface{}, error)
• type AuthOptionsProvider
• type Availability
• type BaseError
  • func (e BaseError) Error() string
• type EnabledState
• type EndpointLocator
• type EndpointOpts
  • func (eo *EndpointOpts) ApplyDefaults(t string)
• type Err400er
• type Err401er
• type Err403er
• type Err404er
• type Err405er
• type Err408er
• type Err409er
• type Err429er
• type Err500er
• type Err503er
• type ErrAPIKeyProvided
  • func (e ErrAPIKeyProvided) Error() string
• type ErrDefault400
  • func (e ErrDefault400) Error() string
• type ErrDefault401
  • func (e ErrDefault401) Error() string
• type ErrDefault403
  • func (e ErrDefault403) Error() string
• type ErrDefault404
  • func (e ErrDefault404) Error() string
• type ErrDefault405
  • func (e ErrDefault405) Error() string
• type ErrDefault408
  • func (e ErrDefault408) Error() string
• type ErrDefault409
• type ErrDefault429
  • func (e ErrDefault429) Error() string
• type ErrDefault500
  • func (e ErrDefault500) Error() string
• type ErrDefault503
  • func (e ErrDefault503) Error() string
• type ErrDomainIDOrDomainName
  • func (e ErrDomainIDOrDomainName) Error() string
• type ErrDomainIDWithToken
  • func (e ErrDomainIDWithToken) Error() string
• type ErrDomainNameWithToken
  • func (e ErrDomainNameWithToken) Error() string
• type ErrEndpointNotFound
  • func (e ErrEndpointNotFound) Error() string
• type ErrErrorAfterReauthentication
  • func (e ErrErrorAfterReauthentication) Error() string
• type ErrInvalidInput
  • func (e ErrInvalidInput) Error() string
• type ErrMissingInput
  • func (e ErrMissingInput) Error() string
• type ErrMissingPassword
  • func (e ErrMissingPassword) Error() string
• type ErrMultipleResourcesFound
  • func (e ErrMultipleResourcesFound) Error() string
• type ErrResourceNotFound
  • func (e ErrResourceNotFound) Error() string
• type ErrRespond
• type ErrResult
  • func (r ErrResult) ExtractErr() error
• type ErrScopeDomainIDOrDomainName
  • func (e ErrScopeDomainIDOrDomainName) Error() string
• type ErrScopeEmpty
  • func (e ErrScopeEmpty) Error() string
• type ErrScopeProjectIDAlone
  • func (e ErrScopeProjectIDAlone) Error() string
• type ErrScopeProjectIDOrProjectName
  • func (e ErrScopeProjectIDOrProjectName) Error() string
• type ErrServiceNotFound
  • func (e ErrServiceNotFound) Error() string
• type ErrTenantIDProvided
  • func (e ErrTenantIDProvided) Error() string
• type ErrTenantNameProvided
  • func (e ErrTenantNameProvided) Error() string
• type ErrTimeOut
  • func (e ErrTimeOut) Error() string
• type ErrUnableToReauthenticate
  • func (e ErrUnableToReauthenticate) Error() string
• type ErrUnexpectedResponseCode
  • func (e ErrUnexpectedResponseCode) Error() string
• type ErrUnexpectedType
  • func (e ErrUnexpectedType) Error() string
• type ErrUserIDNotFound
  • func (e ErrUserIDNotFound) Error() string
• type ErrUserIDWithToken
  • func (e ErrUserIDWithToken) Error() string
• type ErrUsernameOrUserID
  • func (e ErrUsernameOrUserID) Error() string
• type ErrUsernameWithToken
  • func (e ErrUsernameWithToken) Error() string
• type ErrWithResult
• type HeaderResult
  • func (r HeaderResult) ExtractInto(to interface{}) error
• type IPVersion
• type JSONRFC1123
  • func (jt *JSONRFC1123) UnmarshalJSON(data []byte) error
• type JSONRFC3339Milli
  • func (jt *JSONRFC3339Milli) UnmarshalJSON(data []byte) error
• type JSONRFC3339MilliNoZ
  • func (jt *JSONRFC3339MilliNoZ) UnmarshalJSON(data []byte) error
• type JSONRFC3339NoZ
  • func (jt *JSONRFC3339NoZ) UnmarshalJSON(data []byte) error
• type JSONRFC3339ZNoT
  • func (jt *JSONRFC3339ZNoT) UnmarshalJSON(data []byte) error
• type JSONRFC3339ZNoTNoZ
  • func (jt *JSONRFC3339ZNoTNoZ) UnmarshalJSON(data []byte) error
• type JSONUnix
  • func (jt *JSONUnix) UnmarshalJSON(data []byte) error
• type Job
• type JobResponse
• type JobStatus
• type JsonRDSInstanceField
• type JsonRDSInstanceStatus
• type Link
• type MemoryCache
  • func NewCache(maxCount int) *MemoryCache
  • func (cache *MemoryCache) Add(cacheKey string, cacheData string)
  • func (cache *MemoryCache) Get(cacheKey string) string
• type ProviderClient
  • func (client *ProviderClient) AuthenticatedHeaders() (m map[string]string)
  • func (client *ProviderClient) Request(method, url string, options *RequestOpts) (*http.Response, error)
  • func (client *ProviderClient) SetToken(t string)
  • func (client *ProviderClient) Token() string
  • func (client *ProviderClient) UseTokenLock()
• type RDSJobInstance
• type RDSJobStatus
• type RequestOpts
• type Result
  • func (r Result) BodyReader() io.Reader
  • func (r Result) Extract() (*ErrRespond, error)
  • func (r Result) ExtractInto(to interface{}) error
  • func (r Result) ExtractIntoSlicePtr(to interface{}, label string) error
  • func (r Result) ExtractIntoStructPtr(to interface{}, label string) error
  • func (r Result) ExtractJobResponse() (*JobResponse, error)
  • func (r Result) ExtractJobStatus() (*JobStatus, error)
  • func (r Result) PrettyPrintJSON() string
• type ServiceClient
  • func (client *ServiceClient) Delete(url string, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) Delete2(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) DeleteWithBody(url string, JSONBody interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) DeleteWithBodyResp(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) DeleteWithResponse(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) Get(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) Patch(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) Post(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) Put(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
  • func (client *ServiceClient) ResourceBaseURL() string
  • func (client *ServiceClient) ServiceURL(parts ...string) string
• type ServiceClientExtension
• type SignOptions
• type StringBuilder
  • func (buff *StringBuilder) GetBytes() []byte
  • func (buff *StringBuilder) ToString() string
  • func (buff *StringBuilder) Write(s string) *StringBuilder
• type UserAgent
  • func (ua *UserAgent) Join() string
  • func (ua *UserAgent) Prepend(s ...string)

Constants

const ContentSha256HeaderKey = "x-sdk-content-sha256"

The header key of content hash value

const DefaultUserAgent = "golangsdk/2.0.0"

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

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

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

const RFC3339MilliNoZ = "2006-01-02T15:04:05.999999"

const RFC3339NoZ = "2006-01-02T15:04:05"

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

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

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

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

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

const SignAlgorithmHMACSHA256 = "SDK-HMAC-SHA256"

The default sign algorithm

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 := golangsdk.BuildRequestBody(createOpts, "flavor")

The above example can be run as-is, however it is recommended to look at how BuildRequestBody is used within Gophercloud 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 GetJobEndpoint

func GetJobEndpoint(endpoint string) string

func GetJobEntity

func GetJobEntity(client *ServiceClient, uri string, label string) (interface{}, error)

func HashSha256

func HashSha256(msg []byte) []byte

HashSha256 is a wrapper for sha256 implementation

func HmacSha256

func HmacSha256(data string, key []byte) []byte

HmacSha256 implements the Keyed-Hash Message Authentication Code computation

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 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 PrettyPrintJSON

func PrettyPrintJSON(body interface{}) string

func ReSign

func ReSign(req *http.Request, signOptions SignOptions)

ReSign manipulates the http.Request instance with some required authentication headers for SK/SK auth

func Sign

func Sign(req *http.Request, signOptions SignOptions)

Sign manipulates the http.Request instance with some required authentication headers for SK/SK auth

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.

func WaitForJobSuccess

func WaitForJobSuccess(client *ServiceClient, uri string, secs int) error

Types

type AKSKAuthOptions

type AKSKAuthOptions 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:"-"`

	// user project id
	ProjectId string

	ProjectName string

	// region
	Region string

	// cloud service domain
	Domain   string
	DomainID string

	// cloud service domain for BSS
	BssDomain   string
	BssDomainID string

	AccessKey     string // Access Key
	SecretKey     string // Secret key
	SecurityToken string // Security token (part of temporary AK/SK)

	// AgencyName is the name of agency
	AgencyName string

	// AgencyDomainName is the name of domain who created the agency
	AgencyDomainName string

	// DelegatedProject is the name of delegated project
	DelegatedProject string
}

AKSKAuthOptions presents the required information for AK/SK auth

func (AKSKAuthOptions) GetIdentityEndpoint

func (opts AKSKAuthOptions) GetIdentityEndpoint() string

GetIdentityEndpoint implements the method of AKSKAuthOptions

type AgencyAuthOptions

type AgencyAuthOptions struct {
	TokenID          string
	DomainID         string
	AgencyName       string
	AgencyDomainName string
	DelegatedProject string
}

func (*AgencyAuthOptions) AuthHeaderDomainID

func (opts *AgencyAuthOptions) AuthHeaderDomainID() string

func (*AgencyAuthOptions) AuthTokenID

func (opts *AgencyAuthOptions) AuthTokenID() string

func (*AgencyAuthOptions) CanReauth

func (opts *AgencyAuthOptions) CanReauth() bool

func (*AgencyAuthOptions) ToTokenV3CreateMap

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

func (*AgencyAuthOptions) ToTokenV3ScopeMap

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

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 Gophercloud to
	// cache your credentials in memory, and to allow Gophercloud 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:"-"`

	// AgencyName is the name of agency
	AgencyName string `json:"-"`

	// AgencyDomainName is the name of domain who created the agency
	AgencyDomainName string `json:"-"`

	// DelegatedProject is the name of delegated project
	DelegatedProject string `json:"-"`

	// Passcode is a Virtual MFA device verification code, which can be obtained on the MFA app.
	Passcode string `json:"-"`
}

AuthOptions stores information needed to authenticate to an OpenStack 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 := golangsdk.AuthOptions{
  IdentityEndpoint: "https://openstack.example.com:5000/v2.0",
  Username: "{username}",
  Password: "{password}",
  TenantID: "{tenant_id}",
}

provider, err := openstack.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 := openstack.AuthOptionsFromEnv()
provider, err := openstack.AuthenticatedClient(opts)

func (*AuthOptions) AuthHeaderDomainID

func (opts *AuthOptions) AuthHeaderDomainID() string

func (*AuthOptions) AuthTokenID

func (opts *AuthOptions) AuthTokenID() string

func (*AuthOptions) CanReauth

func (opts *AuthOptions) CanReauth() bool

func (AuthOptions) GetIdentityEndpoint

func (opts AuthOptions) GetIdentityEndpoint() string

Implements the method of AuthOptionsProvider

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 AuthOptionsProvider

type AuthOptionsProvider interface {
	GetIdentityEndpoint() string
}

AuthOptionsProvider presents the base of an auth options implementation

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 (
	// AvailabilityAdmin indicates that an endpoint is only available to
	// administrators.
	AvailabilityAdmin Availability = "admin"

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

	// AvailabilityInternal indicates that an endpoint is only available within
	// the cluster's internal network.
	AvailabilityInternal Availability = "internal"
)

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 OpenStack 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 "openstack.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 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.

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 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 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 Gophercloud errors.

func (ErrInvalidInput) Error

func (e ErrInvalidInput) 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 ErrRespond

type ErrRespond struct {
	ErrorCode string `json:"error_code"`
	ErrorMsg  string `json:"error_msg"`
}

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.

Deprecated: use plain err return instead

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 ErrUserIDNotFound

type ErrUserIDNotFound struct{ BaseError }

func (ErrUserIDNotFound) Error

func (e ErrUserIDNotFound) 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 ErrWithResult

type ErrWithResult struct {
	ErrResult
}

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 openstack, 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 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 Job

type Job struct {
	Id       string         `json:"id"`
	Name     string         `json:"name"`
	Status   string         `json:"status"`
	Created  string         `json:"created"`
	Process  string         `json:"process"`
	Instance RDSJobInstance `json:"instance"`
}

type JobResponse

type JobResponse struct {
	URI   string `json:"uri"`
	JobID string `json:"job_id"`
}

type JobStatus

type JobStatus struct {
	Status     string                 `json:"status"`
	Entities   map[string]interface{} `json:"entities"`
	JobID      string                 `json:"job_id"`
	JobType    string                 `json:"job_type"`
	ErrorCode  string                 `json:"error_code"`
	FailReason string                 `json:"fail_reason"`
}

type JsonRDSInstanceField

type JsonRDSInstanceField struct {
	Id     string `json:"id"`
	Name   string `json:"name"`
	Status string `json:"status"`
}

type JsonRDSInstanceStatus

type JsonRDSInstanceStatus struct {
	Instances  []JsonRDSInstanceField `json:"instances"`
	TotalCount int                    `json:"total_count"`
}

type Link

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 MemoryCache

type MemoryCache struct {
	sync.Mutex // handling r/w for cache

	MaxCount int // max cache entry count
	// contains filtered or unexported fields
}

MemoryCache presents a thread safe memory cache

func NewCache

func NewCache(maxCount int) *MemoryCache

NewCache inits an new MemoryCache

func (*MemoryCache) Add

func (cache *MemoryCache) Add(cacheKey string, cacheData string)

Add an new cache item

func (*MemoryCache) Get

func (cache *MemoryCache) Get(cacheKey string) string

Get a cache item by its key

type ProviderClient

type ProviderClient struct {
	// IdentityBase is the base URL used for a particular provider's identity
	// service - it will be used when issuing authentication 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

	// ProjectID is the ID of project to which User is authorized.
	ProjectID string

	// UserID is the ID of the authorized user
	UserID string

	// DomainID is the ID of project to which User is authorized.
	DomainID string

	// RegionID is the Name of region to which User is authorized.
	RegionID 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

	// AKSKAuthOptions provides the value for AK/SK authentication, it should be nil if you use token authentication,
	// Otherwise, it must have a value
	AKSKAuthOptions AKSKAuthOptions
	// 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) 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 RDSJobInstance

type RDSJobInstance struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

type RDSJobStatus

type RDSJobStatus struct {
	Job Job `json:"job"`
}

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.
	// Not that setting it will drain and close Response.Body.
	// Deprecated: Use http.Response Body instead.
	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

	// RetryCount specifies number of times retriable errors (502, 504) will be retried
	RetryCount *int
	// RetryTimeout specifies time before next retry
	RetryTimeout *time.Duration
}

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.
	Body []byte

	// 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.

Deprecated: use functions from internal/extract package instead

func (Result) BodyReader

func (r Result) BodyReader() io.Reader

BodyReader returns cached body as *bytes.Reader

func (Result) Extract

func (r Result) Extract() (*ErrRespond, error)

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 OpenStack providers that have different fields in the response object than OpenStack proper.

Deprecated: use extract.Into function instead

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`.

Deprecated: use extract.IntoSlicePtr function instead

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`.

Deprecated: use extract.IntoStructPtr function instead

func (Result) ExtractJobResponse

func (r Result) ExtractJobResponse() (*JobResponse, error)

func (Result) ExtractJobStatus

func (r Result) ExtractJobStatus() (*JobStatus, error)

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, sharev2).
	// NOTE: FOR INTERNAL USE ONLY. DO NOT SET. GOPHERCLOUD WILL SET THIS.
	// It is only exported because it gets set in a different package.
	Type string

	// The microversion of the service to use. Set this to use a particular microversion.
	Microversion 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. Def 202, 204

func (*ServiceClient) Delete2

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

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

func (*ServiceClient) DeleteWithBody

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

DeleteWithBody calls `Request` with the "DELETE" HTTP verb. Def 202, 204 Deprecated

func (*ServiceClient) DeleteWithBodyResp

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

DeleteWithBodyResp calls `Request` with the "DELETE" HTTP verb. Def 202, 204 Deprecated

func (*ServiceClient) DeleteWithResponse

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

DeleteWithResponse calls `Request` with the "DELETE" HTTP verb. Def 202, 204 Deprecated

func (*ServiceClient) Get

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

Get calls `Request` with the "GET" HTTP verb. Def 200 JSONResponse Deprecated

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. Def 200, 204 JSONResponse Deprecated

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. Def 201, 202 JSONResponse Deprecated

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. Def 201, 202 JSONResponse Deprecated

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 ServiceClientExtension

type ServiceClientExtension struct {

	// ServiceClient is a reference to the ServiceClient.
	*ServiceClient

	// ProjectID is the ID of project to which User is authorized.
	ProjectID string
}

type SignOptions

type SignOptions struct {
	AccessKey          string // Access Key
	SecretKey          string // Secret key
	RegionName         string // Region name
	ServiceName        string // Service Name
	EnableCacheSignKey bool   // Cache sign key for one day or not cache, cache is disabled by default

	SignAlgorithm       string // The algorithm used for sign, the default value is "SDK-HMAC-SHA256" if you don't set its value
	TimeOffsetInSeconds int64  // TimeOffsetInSeconds is used for adjust x-sdk-date if set its value
	// contains filtered or unexported fields
}

SignOptions represents the options during signing http request, it is concurency safely

type StringBuilder

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

StringBuilder wraps bytes.Buffer to implement a high performance string builder

func (*StringBuilder) GetBytes

func (buff *StringBuilder) GetBytes() []byte

func (*StringBuilder) ToString

func (buff *StringBuilder) ToString() string

func (*StringBuilder) Write

func (buff *StringBuilder) Write(s string) *StringBuilder

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-Agent strings with the default Gophercloud 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.