golangsdk

package module
v0.5.3 Latest Latest
Warning

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

 Go to latest Published: Oct 20, 2021 License: Apache-2.0 Imports: 20 Imported by: 59

README ¶

GopherTelekomCloud: a OpenTelekomCloud SDK for Golang

Go Report Card Zuul Gated LICENSE

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.

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 ¶

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

The header key of content hash value

View Source 
const DefaultUserAgent = "golangsdk/2.0.0"

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

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

View Source 
const SignAlgorithmHMACSHA256 = "SDK-HMAC-SHA256"

The default sign algorithm

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 := 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 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 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 ¶ added in v0.1.0 

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 ¶ added in v0.1.0 

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 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 ErrUserIDNotFound ¶ added in v0.4.0 

type ErrUserIDNotFound struct{ BaseError }

func (ErrUserIDNotFound) Error ¶ added in v0.4.0 

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 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 ¶ added in v0.1.0 

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 ¶ added in v0.1.0 

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

type JsonRDSInstanceStatus ¶ added in v0.1.0 

type JsonRDSInstanceStatus struct {
	Instances  []JsonRDSInstanceField `json:"instances"`
	TotalCount int                    `json:"total_count"`
}
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 ¶ added in v0.1.0 

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

type RDSJobStatus ¶ added in v0.1.0 

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

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.

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.

func (*ServiceClient) DeleteWithResponse ¶ 

func (client *ServiceClient) DeleteWithResponse(url string, JSONResponse interface{}, 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) 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) 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.

Source Files ¶

View all Source files

Directories ¶

Path Synopsis
acceptance
clients
Package clients contains functions for creating OpenStack service clients for use in acceptance tests.
 Package clients contains functions for creating OpenStack service clients for use in acceptance tests.
openstack
Package openstack contains common functions that can be used across all OpenStack components for acceptance testing.
 Package openstack contains common functions that can be used across all OpenStack components for acceptance testing.
openstack/autoscaling
openstack/cce
openstack/cts/v1
openstack/dcs/v1
openstack/elb/v3
openstack/identity/v3
openstack/networking/v1
openstack/networking/v2/extensions
openstack/networking/v2/extensions/lbaas_v2
openstack/networking/v2/peering
openstack/networking/v2/routes
openstack/rds/v3
openstack/sdrs/v1
openstack/sfs_turbo/v1
openstack/smn/v2
openstack/swr/v2
tools
testing
Package openstack contains resources for the individual OpenStack projects supported in Gophercloud.
 Package openstack contains resources for the individual OpenStack projects supported in Gophercloud.
antiddos/v1/antiddos
The Anti-DDoS traffic cleaning service (Anti-DDoS for short) defends resources (Elastic Cloud Servers (ECSs), Elastic Load Balance (ELB) instances, and Bare Metal Servers (BMSs)) on OpenTelekomCloud against network- and application-layer distributed denial of service (DDoS) attacks and sends alarms immediately when detecting an attack.
 The Anti-DDoS traffic cleaning service (Anti-DDoS for short) defends resources (Elastic Cloud Servers (ECSs), Elastic Load Balance (ELB) instances, and Bare Metal Servers (BMSs)) on OpenTelekomCloud against network- and application-layer distributed denial of service (DDoS) attacks and sends alarms immediately when detecting an attack.
antiddos/v1/antiddos/testing
autoscaling/v1/configurations
autoscaling/v1/groups
autoscaling/v1/groups_hcs
autoscaling/v1/instances
autoscaling/v1/policies
autoscaling/v1/tags
autoscaling/v2/policies
blockstorage/extensions/quotasets
Package quotasets enables retrieving and managing Block Storage quotas.
 Package quotasets enables retrieving and managing Block Storage quotas.
blockstorage/extensions/quotasets/testing
quotasets unit tests
 quotasets unit tests
blockstorage/extensions/schedulerstats
Package schedulerstats returns information about block storage pool capacity and utilisation.
 Package schedulerstats returns information about block storage pool capacity and utilisation.
blockstorage/extensions/schedulerstats/testing
blockstorage/extensions/services
blockstorage/extensions/services/testing
blockstorage/extensions/volumeactions
Package volumeactions provides information and interaction with volumes in the OpenStack Block Storage service.
 Package volumeactions provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/extensions/volumeactions/testing
volumeactions unit tests
 volumeactions unit tests
blockstorage/extensions/volumetenants
Package volumetenants provides the ability to extend a volume result with tenant/project information.
 Package volumetenants provides the ability to extend a volume result with tenant/project information.
blockstorage/noauth
Package noauth creates a "noauth" *golangsdk.ServiceClient for use in Cinder environments configured with the noauth authentication middleware.
 Package noauth creates a "noauth" *golangsdk.ServiceClient for use in Cinder environments configured with the noauth authentication middleware.
blockstorage/noauth/testing
noauth unit tests
 noauth unit tests
blockstorage/v1/apiversions
Package apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.
 Package apiversions provides information and interaction with the different API versions for the OpenStack Block Storage service, code-named Cinder.
blockstorage/v1/apiversions/testing
apiversions_v1
 apiversions_v1
blockstorage/v1/snapshots
Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
 Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
blockstorage/v1/snapshots/testing
snapshots_v1
 snapshots_v1
blockstorage/v1/volumes
Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
 Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/v1/volumes/testing
volumes_v1
 volumes_v1
blockstorage/v1/volumetypes
Package volumetypes provides information and interaction with volume types in the OpenStack Block Storage service.
 Package volumetypes provides information and interaction with volume types in the OpenStack Block Storage service.
blockstorage/v1/volumetypes/testing
volumetypes_v1
 volumetypes_v1
blockstorage/v2/snapshots
Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
 Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
blockstorage/v2/snapshots/testing
snapshots_v2
 snapshots_v2
blockstorage/v2/volumes
Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
 Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/v2/volumes/testing
volumes_v2
 volumes_v2
blockstorage/v3/snapshots
Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
 Package snapshots provides information and interaction with snapshots in the OpenStack Block Storage service.
blockstorage/v3/snapshots/testing
snapshots_v3
 snapshots_v3
blockstorage/v3/volumes
Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
 Package volumes provides information and interaction with volumes in the OpenStack Block Storage service.
blockstorage/v3/volumes/testing
volumes_v3
 volumes_v3
blockstorage/v3/volumetypes
blockstorage/v3/volumetypes/testing
volume_types
 volume_types
bms/v2/flavors
Package flavors enables management and retrieval of Flavors BMS service.
 Package flavors enables management and retrieval of Flavors BMS service.
bms/v2/keypairs
Package keypairs provides the ability to manage key pairs as well as create bms with a specified key pair.
 Package keypairs provides the ability to manage key pairs as well as create bms with a specified key pair.
bms/v2/keypairs/testing
bms/v2/nics
Package nics enables management and retrieval of NICs BMS service.
 Package nics enables management and retrieval of NICs BMS service.
bms/v2/servers
Package servers enables management and retrieval of Servers BMS service.
 Package servers enables management and retrieval of Servers BMS service.
bms/v2/tags
Package tags enables management and retrieval of Tags BMS service.
 Package tags enables management and retrieval of Tags BMS service.
cbr/v3/policies
cbr/v3/policies/testing
cbr/v3/tasks
cbr/v3/vaults
cce/v1/nodes
cce/v3/addons
cce/v3/clusters
Package Clusters enables management and retrieval of Clusters CCE service.
 Package Clusters enables management and retrieval of Clusters CCE service.
cce/v3/clusters/testing
cluster unit tests
 cluster unit tests
cce/v3/common
cce/v3/nodepools
cce/v3/nodes
cce/v3/nodes/testing
node unit tests
 node unit tests
ces/v1/metricdata
ces/v1/metrics
cloudeyeservice/alarmrule
common/extensions
Package extensions provides information and interaction with the different extensions available for an OpenStack service.
 Package extensions provides information and interaction with the different extensions available for an OpenStack service.
common/extensions/testing
common extensions unit tests
 common extensions unit tests
common/structs
common/tags
compute/v2/extensions
Package extensions provides information and interaction with the different extensions available for the OpenStack Compute service.
 Package extensions provides information and interaction with the different extensions available for the OpenStack Compute service.
compute/v2/extensions/aggregates
Package aggregates manages information about the host aggregates in the OpenStack cloud.
 Package aggregates manages information about the host aggregates in the OpenStack cloud.
compute/v2/extensions/aggregates/testing
compute/v2/extensions/attachinterfaces
Package attachinterfaces provides the ability to retrieve and manage network interfaces through Nova.
 Package attachinterfaces provides the ability to retrieve and manage network interfaces through Nova.
compute/v2/extensions/attachinterfaces/testing
attachinterfaces unit tests
 attachinterfaces 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
bootfromvolume unit tests
 bootfromvolume unit tests
compute/v2/extensions/defsecrules
Package defsecrules enables management of default security group rules.
 Package defsecrules enables management of default security group rules.
compute/v2/extensions/defsecrules/testing
defsecrules unit tests
 defsecrules unit tests
compute/v2/extensions/diskconfig
Package diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service.
 Package diskconfig provides information and interaction with the Disk Config extension that works with the OpenStack Compute service.
compute/v2/extensions/diskconfig/testing
diskconfig unit tests
 diskconfig unit tests
compute/v2/extensions/evacuate
Package evacuate provides functionality to evacuates servers that have been provisioned by the OpenStack Compute service from a failed host to a new host.
 Package evacuate provides functionality to evacuates servers that have been provisioned by the OpenStack Compute service from a failed host to a new host.
compute/v2/extensions/evacuate/testing
compute_extensions_evacuate_v2
 compute_extensions_evacuate_v2
compute/v2/extensions/extendedserverattributes
Package extendedserverattributes provides the ability to extend a server result with the extended usage information.
 Package extendedserverattributes provides the ability to extend a server result with the extended usage information.
compute/v2/extensions/extendedserverattributes/testing
compute/v2/extensions/extendedstatus
Package extendedstatus provides the ability to extend a server result with the extended status information.
 Package extendedstatus provides the ability to extend a server result with the extended status information.
compute/v2/extensions/floatingips
Package floatingips provides the ability to manage floating ips through the Nova API.
 Package floatingips provides the ability to manage floating ips through the Nova API.
compute/v2/extensions/floatingips/testing
floatingips unit tests
 floatingips unit tests
compute/v2/extensions/hypervisors
Package hypervisors returns details about list of hypervisors, shows details for a hypervisor and shows summary statistics for all hypervisors over all compute nodes in the OpenStack cloud.
 Package hypervisors returns details about list of hypervisors, shows details for a hypervisor and shows summary statistics for all hypervisors over all compute nodes in the OpenStack cloud.
compute/v2/extensions/hypervisors/testing
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
keypairs unit tests
 keypairs unit tests
compute/v2/extensions/limits
Package limits shows rate and limit information for a tenant/project.
 Package limits shows rate and limit information for a tenant/project.
compute/v2/extensions/limits/testing
compute/v2/extensions/lockunlock
Package lockunlock provides functionality to lock and unlock servers that have been provisioned by the OpenStack Compute service.
 Package lockunlock provides functionality to lock and unlock servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/lockunlock/testing
unlocklock unit tests
 unlocklock unit tests
compute/v2/extensions/migrate
Package migrate provides functionality to migrate servers that have been provisioned by the OpenStack Compute service.
 Package migrate provides functionality to migrate servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/migrate/testing
compute_extensions_startstop_v2
 compute_extensions_startstop_v2
compute/v2/extensions/networks
Package networks provides the ability to create and manage networks in cloud environments using nova-network.
 Package networks provides the ability to create and manage networks in cloud environments using nova-network.
compute/v2/extensions/networks/testing
networks unit tests
 networks unit tests
compute/v2/extensions/pauseunpause
Package pauseunpause provides functionality to pause and unpause servers that have been provisioned by the OpenStack Compute service.
 Package pauseunpause provides functionality to pause and unpause servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/pauseunpause/testing
pauseunpause unit tests
 pauseunpause unit tests
compute/v2/extensions/quotasets
Package quotasets enables retrieving and managing Compute quotas.
 Package quotasets enables retrieving and managing Compute quotas.
compute/v2/extensions/quotasets/testing
quotasets unit tests
 quotasets unit tests
compute/v2/extensions/rescueunrescue
Package rescueunrescue provides the ability to place a server into rescue mode and to return it back.
 Package rescueunrescue provides the ability to place a server into rescue mode and to return it back.
compute/v2/extensions/rescueunrescue/testing
compute/v2/extensions/resetstate
Package resetstate provides functionality to reset the state of a server that has been provisioned by the OpenStack Compute service.
 Package resetstate provides functionality to reset the state of a server that has been provisioned by the OpenStack Compute service.
compute/v2/extensions/resetstate/testing
compute/v2/extensions/schedulerhints
Package schedulerhints extends the server create request with the ability to specify additional parameters which determine where the server will be created in the OpenStack cloud.
 Package schedulerhints extends the server create request with the ability to specify additional parameters which determine where the server will be created in the OpenStack cloud.
compute/v2/extensions/schedulerhints/testing
schedulerhints unit tests
 schedulerhints unit tests
compute/v2/extensions/secgroups
Package secgroups provides the ability to manage security groups through the Nova API.
 Package secgroups provides the ability to manage security groups through the Nova API.
compute/v2/extensions/secgroups/testing
secgroups unit tests
 secgroups unit tests
compute/v2/extensions/servergroups
Package servergroups provides the ability to manage server groups.
 Package servergroups provides the ability to manage server groups.
compute/v2/extensions/servergroups/testing
servergroups unit tests
 servergroups unit tests
compute/v2/extensions/serverusage
Package serverusage provides the ability the ability to extend a server result with the extended usage information.
 Package serverusage provides the ability the ability to extend a server result with the extended usage information.
compute/v2/extensions/serverusage/testing
compute/v2/extensions/services
compute/v2/extensions/services/testing
compute/v2/extensions/startstop
Package startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service.
 Package startstop provides functionality to start and stop servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/startstop/testing
startstop unit tests
 startstop unit tests
compute/v2/extensions/suspendresume
Package suspendresume provides functionality to suspend and resume servers that have been provisioned by the OpenStack Compute service.
 Package suspendresume provides functionality to suspend and resume servers that have been provisioned by the OpenStack Compute service.
compute/v2/extensions/suspendresume/testing
suspendresume unit tests
 suspendresume unit tests
compute/v2/extensions/tags
compute/v2/extensions/tenantnetworks
Package tenantnetworks provides the ability for tenants to see information about the networks they have access to.
 Package tenantnetworks provides the ability for tenants to see information about the networks they have access to.
compute/v2/extensions/tenantnetworks/testing
tenantnetworks unit tests
 tenantnetworks unit tests
compute/v2/extensions/testing
extensions unit tests
 extensions unit tests
compute/v2/extensions/usage
Package usage provides information and interaction with the SimpleTenantUsage extension for the OpenStack Compute service.
 Package usage provides information and interaction with the SimpleTenantUsage extension for the OpenStack Compute service.
compute/v2/extensions/usage/testing
simple tenant usage unit tests
 simple tenant usage 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
volumeattach unit tests
 volumeattach unit tests
compute/v2/flavors
Package flavors provides information and interaction with the flavor API in the OpenStack Compute service.
 Package flavors provides information and interaction with the flavor API in the OpenStack Compute service.
compute/v2/flavors/testing
flavors unit tests
 flavors unit tests
compute/v2/images
Package images provides information and interaction with the images through the OpenStack Compute service.
 Package images provides information and interaction with the images through the OpenStack Compute service.
compute/v2/images/testing
images unit tests
 images unit tests
compute/v2/servers
Package servers provides information and interaction with the server API resource in the OpenStack Compute service.
 Package servers provides information and interaction with the server API resource in the OpenStack Compute service.
compute/v2/servers/testing
servers unit tests
 servers unit tests
csbs/v1/backup
Package backup enables management and retrieval of back up resources.
 Package backup enables management and retrieval of back up resources.
csbs/v1/backup/testing
csbs/v1/policies
Package backup policies enables management and retrieval of backup servers periodically.
 Package backup policies enables management and retrieval of backup servers periodically.
csbs/v1/policies/testing
css/v1/clusters
css/v1/clusters/testing
css/v1/flavors
css/v1/flavors/testing
css/v1/snapshots
cts/v1/tracker
Package tracker provides operation records for cloud service resources.
 Package tracker provides operation records for cloud service resources.
cts/v1/tracker/testing
dcs/v1/availablezones
dcs/v1/configs
dcs/v1/instances
dcs/v1/maintainwindows
dcs/v1/products
dcs/v2/whitelists
dds/v3/flavors
dds/v3/instances
deh/v1/common
deh/v1/hosts
deh/v1/hosts/testing
dms/v1/availablezones
dms/v1/groups
dms/v1/instances
dms/v1/maintainwindows
dms/v1/products
dms/v1/queues
dns/v2/ptrrecords
dns/v2/recordsets
Package recordsets provides information and interaction with the zone API resource for the OpenStack DNS service.
 Package recordsets provides information and interaction with the zone API resource for the OpenStack 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 OpenStack DNS service.
 Package zones provides information and interaction with the zone API resource for the OpenStack DNS service.
dns/v2/zones/testing
zones unit tests
 zones unit tests
ecs/v1/auto_recovery
ecs/v1/block_devices
ecs/v1/cloudservers
ecs/v1/cloudservertags
ecs/v1/tags
elb/v3/certificates
elb/v3/flavors
elb/v3/listeners
elb/v3/loadbalancers
elb/v3/pools
evs/v2/snapshots
evs/v2/snapshots/testing
evs/v2/tags
evs/v3/volumes
identity/v3/agency
identity/v3/catalog
identity/v3/catalog/testing
identity/v3/credentials
identity/v3/domains
Package domains manages and retrieves Domains in the OpenStack Identity Service.
 Package domains manages and retrieves Domains in the OpenStack Identity Service.
identity/v3/domains/testing
identity/v3/endpoints
Package endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service.
 Package endpoints provides information and interaction with the service endpoints API resource in the OpenStack Identity service.
identity/v3/endpoints/testing
endpoints unit tests
 endpoints unit tests
identity/v3/extensions/trusts
Package trusts enables management of OpenStack Identity Trusts.
 Package trusts enables management of OpenStack Identity Trusts.
identity/v3/extensions/trusts/testing
trusts unit tests
 trusts unit tests
identity/v3/federation
identity/v3/federation/mappings
identity/v3/federation/mappings/testing
identity/v3/federation/metadata
identity/v3/federation/metadata/testing
identity/v3/federation/protocols
identity/v3/federation/protocols/testing
identity/v3/federation/providers
identity/v3/federation/providers/testing
identity/v3/groups
Package groups manages and retrieves Groups in the OpenStack Identity Service.
 Package groups manages and retrieves Groups in the OpenStack Identity Service.
identity/v3/groups/testing
identity/v3/projects
Package projects manages and retrieves Projects in the OpenStack Identity Service.
 Package projects manages and retrieves Projects in the OpenStack Identity Service.
identity/v3/projects/testing
identity/v3/regions
Package regions manages and retrieves Regions in the OpenStack Identity Service.
 Package regions manages and retrieves Regions in the OpenStack Identity Service.
identity/v3/regions/testing
identity/v3/roles
Package roles provides information and interaction with the roles API resource for the OpenStack Identity service.
 Package roles provides information and interaction with the roles API resource for the OpenStack Identity service.
identity/v3/roles/testing
roles unit tests
 roles unit tests
identity/v3/services
Package services provides information and interaction with the services API resource for the OpenStack Identity service.
 Package services provides information and interaction with the services API resource for the OpenStack Identity service.
identity/v3/services/testing
services unit tests
 services unit tests
identity/v3/tokens
Package tokens provides information and interaction with the token API resource for the OpenStack Identity service.
 Package tokens provides information and interaction with the token API resource for the OpenStack Identity service.
identity/v3/tokens/testing
tokens unit tests
 tokens unit tests
identity/v3/users
Package users manages and retrieves Users in the OpenStack Identity Service.
 Package users manages and retrieves Users in the OpenStack Identity Service.
identity/v3/users/testing
imageservice/v2/imagedata
Package imagedata enables management of image data.
 Package imagedata enables management of image data.
imageservice/v2/imagedata/testing
imagedata unit tests
 imagedata unit tests
imageservice/v2/imageimport
Package imageimport enables management of images import and retrieval of the Imageservice Import API information.
 Package imageimport enables management of images import and retrieval of the Imageservice Import API information.
imageservice/v2/imageimport/testing
imageservice/v2/images
Package images enables management and retrieval of images from the OpenStack Image Service.
 Package images enables management and retrieval of images from the OpenStack Image Service.
imageservice/v2/images/testing
images unit tests
 images unit tests
imageservice/v2/members
Package members enables management and retrieval of image members.
 Package members enables management and retrieval of image members.
imageservice/v2/members/testing
members unit tests
 members unit tests
imageservice/v2/tasks
Package tasks enables management and retrieval of tasks from the OpenStack Imageservice.
 Package tasks enables management and retrieval of tasks from the OpenStack Imageservice.
imageservice/v2/tasks/testing
tasks unit tests
 tasks unit tests
ims/v2/cloudimages
ims/v2/tags
kms/v1/grants
kms/v1/keys
Package keys provides information and interaction with keys in the Key Management Service service.
 Package keys provides information and interaction with keys in the Key Management Service service.
lts/v2/loggroups
lts/v2/logtopics
mrs/v1/cluster
mrs/v1/job
mrs/v1/tags
networking/v1/bandwidths
networking/v1/common
networking/v1/eips
networking/v1/flowlogs
networking/v1/subnets
networking/v1/subnets/testing
networking/v1/vpcs
Package vpcs enables management and retrieval of Vpcs VPC service.
 Package vpcs enables management and retrieval of Vpcs VPC service.
networking/v1/vpcs/testing
vpcs unit tests
 vpcs unit tests
networking/v2/apiversions
Package apiversions provides information and interaction with the different API versions for the OpenStack Neutron service.
 Package apiversions provides information and interaction with the different API versions for the OpenStack Neutron service.
networking/v2/apiversions/testing
apiversions unit tests
 apiversions unit tests
networking/v2/bandwidths
networking/v2/common
networking/v2/extensions
networking/v2/extensions/dnatrules
networking/v2/extensions/elb
networking/v2/extensions/elb/backendecs
networking/v2/extensions/elb/certificate
networking/v2/extensions/elb/healthcheck
networking/v2/extensions/elb/listeners
networking/v2/extensions/elb/loadbalancers
networking/v2/extensions/elb/quotas
networking/v2/extensions/elbaas
Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service.
 Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service.
networking/v2/extensions/elbaas/backendmember
networking/v2/extensions/elbaas/healthcheck
networking/v2/extensions/elbaas/listeners
networking/v2/extensions/elbaas/loadbalancer_elbs
networking/v2/extensions/external
Package external provides information and interaction with the external extension for the OpenStack Networking service.
 Package external provides information and interaction with the external extension for the OpenStack Networking service.
networking/v2/extensions/external/testing
external unit tests
 external unit tests
networking/v2/extensions/extradhcpopts
Package extradhcpopts allow to work with extra DHCP functionality of Neutron ports.
 Package extradhcpopts allow to work with extra DHCP functionality of Neutron ports.
networking/v2/extensions/fwaas
Package fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
 Package fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
networking/v2/extensions/fwaas/firewalls
Package firewalls allows management and retrieval of firewalls from the OpenStack Networking Service.
 Package firewalls allows management and retrieval of firewalls from the OpenStack Networking Service.
networking/v2/extensions/fwaas/firewalls/testing
firewalls unit tests
 firewalls unit tests
networking/v2/extensions/fwaas/policies
Package policies allows management and retrieval of Firewall Policies in the OpenStack Networking Service.
 Package policies allows management and retrieval of Firewall Policies in the OpenStack Networking Service.
networking/v2/extensions/fwaas/policies/testing
policies unit tests
 policies unit tests
networking/v2/extensions/fwaas/routerinsertion
Package routerinsertion implements the fwaasrouterinsertion Firewall extension.
 Package routerinsertion implements the fwaasrouterinsertion Firewall extension.
networking/v2/extensions/fwaas/routerinsertion/testing
routerinsertion unit tests
 routerinsertion unit tests
networking/v2/extensions/fwaas/rules
Package rules enables management and retrieval of Firewall Rules in the OpenStack Networking Service.
 Package rules enables management and retrieval of Firewall Rules in the OpenStack Networking Service.
networking/v2/extensions/fwaas/rules/testing
rules unit tests
 rules unit tests
networking/v2/extensions/fwaas_v2
Package fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
 Package fwaas provides information and interaction with the Firewall as a Service extension for the OpenStack Networking service.
networking/v2/extensions/fwaas_v2/firewall_groups
networking/v2/extensions/fwaas_v2/policies
networking/v2/extensions/fwaas_v2/routerinsertion
Package routerinsertion implements the fwaasrouterinsertion FWaaS extension.
 Package routerinsertion implements the fwaasrouterinsertion FWaaS extension.
networking/v2/extensions/fwaas_v2/rules
networking/v2/extensions/hw_snatrules
networking/v2/extensions/layer3
Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service.
 Package layer3 provides access to the Layer-3 networking extension for the OpenStack Neutron service.
networking/v2/extensions/layer3/floatingips
package floatingips enables management and retrieval of Floating IPs from the OpenStack Networking service.
 package floatingips enables management and retrieval of Floating IPs from the OpenStack Networking service.
networking/v2/extensions/layer3/floatingips/testing
floatingips unit tests
 floatingips unit tests
networking/v2/extensions/layer3/routers
Package routers enables management and retrieval of Routers from the OpenStack Networking service.
 Package routers enables management and retrieval of Routers from the OpenStack Networking service.
networking/v2/extensions/layer3/routers/testing
routers unit tests
 routers unit tests
networking/v2/extensions/lbaas
Package lbaas provides information and interaction with the Load Balancer as a Service extension for the OpenStack Networking service.
 Package lbaas provides information and interaction with the Load Balancer as a Service extension for the OpenStack Networking service.
networking/v2/extensions/lbaas/members
Package members provides information and interaction with Members of the Load Balancer as a Service extension for the OpenStack Networking service.
 Package members provides information and interaction with Members of the Load Balancer as a Service extension for the OpenStack Networking service.
networking/v2/extensions/lbaas/members/testing
members unit tests
 members unit tests
networking/v2/extensions/lbaas/monitors
Package monitors provides information and interaction with the Monitors of the Load Balancer as a Service extension for the OpenStack Networking Service.
 Package monitors provides information and interaction with the Monitors of the Load Balancer as a Service extension for the OpenStack Networking Service.
networking/v2/extensions/lbaas/monitors/testing
monitors unit tests
 monitors unit tests
networking/v2/extensions/lbaas/pools
Package pools provides information and interaction with the Pools of the Load Balancing as a Service extension for the OpenStack Networking service.
 Package pools provides information and interaction with the Pools of the Load Balancing as a Service extension for the OpenStack Networking service.
networking/v2/extensions/lbaas/pools/testing
pools unit tests
 pools unit tests
networking/v2/extensions/lbaas/vips
Package vips provides information and interaction with the Virtual IPs of the Load Balancing as a Service extension for the OpenStack Networking service.
 Package vips provides information and interaction with the Virtual IPs of the Load Balancing as a Service extension for the OpenStack Networking service.
networking/v2/extensions/lbaas/vips/testing
vips unit tests
 vips unit tests
networking/v2/extensions/lbaas_v2
Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service.
 Package lbaas_v2 provides information and interaction with the Load Balancer as a Service v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/certificates
networking/v2/extensions/lbaas_v2/l7policies
Package l7policies provides information and interaction with L7Policies and Rules of the LBaaS v2 extension for the OpenStack Networking service.
 Package l7policies provides information and interaction with L7Policies and Rules of the LBaaS v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/l7policies/testing
l7policies unit tests
 l7policies unit tests
networking/v2/extensions/lbaas_v2/listeners
Package listeners provides information and interaction with Listeners of the LBaaS v2 extension for the OpenStack Networking service.
 Package listeners provides information and interaction with Listeners of the LBaaS v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/listeners/testing
listeners unit tests
 listeners unit tests
networking/v2/extensions/lbaas_v2/loadbalancers
Package loadbalancers provides information and interaction with Load Balancers of the LBaaS v2 extension for the OpenStack Networking service.
 Package loadbalancers provides information and interaction with Load Balancers of the LBaaS v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/loadbalancers/testing
loadbalancers unit tests
 loadbalancers unit tests
networking/v2/extensions/lbaas_v2/monitors
Package monitors provides information and interaction with Monitors of the LBaaS v2 extension for the OpenStack Networking service.
 Package monitors provides information and interaction with Monitors of the LBaaS v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/monitors/testing
monitors unit tests
 monitors unit tests
networking/v2/extensions/lbaas_v2/pools
Package pools provides information and interaction with Pools and Members of the LBaaS v2 extension for the OpenStack Networking service.
 Package pools provides information and interaction with Pools and Members of the LBaaS v2 extension for the OpenStack Networking service.
networking/v2/extensions/lbaas_v2/pools/testing
pools unit tests
 pools unit tests
networking/v2/extensions/lbaas_v2/whitelists
networking/v2/extensions/natgateways
networking/v2/extensions/networkipavailabilities
Package networkipavailabilities provides the ability to retrieve and manage networkipavailabilities through the Neutron API.
 Package networkipavailabilities provides the ability to retrieve and manage networkipavailabilities through the Neutron API.
networking/v2/extensions/networkipavailabilities/testing
networkipavailabilities unit tests
 networkipavailabilities unit tests
networking/v2/extensions/portsbinding
Package portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service.
 Package portsbinding provides information and interaction with the port binding extension for the OpenStack Networking service.
networking/v2/extensions/portsbinding/testing
portsbindings unit tests
 portsbindings unit tests
networking/v2/extensions/portsecurity
Package portsecurity provides information and interaction with the port security extension for the OpenStack Networking service.
 Package portsecurity provides information and interaction with the port security extension for the OpenStack Networking service.
networking/v2/extensions/provider
Package provider gives access to the provider Neutron plugin, allowing network extended attributes.
 Package provider gives access to the provider Neutron plugin, allowing network extended attributes.
networking/v2/extensions/provider/testing
provider unit tests
 provider unit tests
networking/v2/extensions/qos/ruletypes
Package ruletypes contains functionality for working with Neutron 'quality of service' rule-type resources.
 Package ruletypes contains functionality for working with Neutron 'quality of service' rule-type resources.
networking/v2/extensions/qos/ruletypes/testing
qos unit tests
 qos unit tests
networking/v2/extensions/rbacpolicies
Package rbacpolicies contains functionality for working with Neutron RBAC Policies.
 Package rbacpolicies contains functionality for working with Neutron RBAC Policies.
networking/v2/extensions/rbacpolicies/testing
Package testing includes rbac unit tests
 Package testing includes rbac unit tests
networking/v2/extensions/security
Package security contains functionality to work with security group and security group rules Neutron resources.
 Package security contains functionality to work with security group and security group rules Neutron resources.
networking/v2/extensions/security/groups
Package groups provides information and interaction with Security Groups for the OpenStack Networking service.
 Package groups provides information and interaction with Security Groups for the OpenStack Networking service.
networking/v2/extensions/security/groups/testing
groups unit tests
 groups unit tests
networking/v2/extensions/security/rules
Package rules provides information and interaction with Security Group Rules for the OpenStack Networking service.
 Package rules provides information and interaction with Security Group Rules for the OpenStack Networking service.
networking/v2/extensions/security/rules/testing
rules unit tests
 rules unit tests
networking/v2/extensions/snatrules
networking/v2/extensions/subnetpools
Package subnetpools provides the ability to retrieve and manage subnetpools through the Neutron API.
 Package subnetpools provides the ability to retrieve and manage subnetpools through the Neutron API.
networking/v2/extensions/subnetpools/testing
subnetpools unit tests
 subnetpools unit tests
networking/v2/extensions/testing
extensions unit tests
 extensions unit tests
networking/v2/extensions/vpnaas/endpointgroups
Package endpointgroups allows management of endpoint groups in the Openstack Network Service Example to create an Endpoint Group createOpts := endpointgroups.CreateOpts{ Name: groupName, Type: endpointgroups.TypeCIDR, Endpoints: []string{ "10.2.0.0/24", "10.3.0.0/24", }, } group, err := endpointgroups.Create(client, createOpts).Extract() if err != nil { return group, err } Example to retrieve an Endpoint Group group, err := endpointgroups.Get(client, "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a").Extract() if err != nil { panic(err) } Example to Delete an Endpoint Group err := endpointgroups.Delete(client, "5291b189-fd84-46e5-84bd-78f40c05d69c").ExtractErr() if err != nil { panic(err) } Example to List Endpoint groups allPages, err := endpointgroups.List(client, nil).AllPages() if err != nil { panic(err) } allGroups, err := endpointgroups.ExtractEndpointGroups(allPages) if err != nil { panic(err) } Example to Update an endpoint group name := "updatedname" description := "updated description" updateOpts := endpointgroups.UpdateOpts{ Name: &name, Description: &description, } updatedPolicy, err := endpointgroups.Update(client, "5c561d9d-eaea-45f6-ae3e-08d1a7080828", updateOpts).Extract() if err != nil { panic(err) }
 Package endpointgroups allows management of endpoint groups in the Openstack Network Service Example to create an Endpoint Group createOpts := endpointgroups.CreateOpts{ Name: groupName, Type: endpointgroups.TypeCIDR, Endpoints: []string{ "10.2.0.0/24", "10.3.0.0/24", }, } group, err := endpointgroups.Create(client, createOpts).Extract() if err != nil { return group, err } Example to retrieve an Endpoint Group group, err := endpointgroups.Get(client, "6ecd9cf3-ca64-46c7-863f-f2eb1b9e838a").Extract() if err != nil { panic(err) } Example to Delete an Endpoint Group err := endpointgroups.Delete(client, "5291b189-fd84-46e5-84bd-78f40c05d69c").ExtractErr() if err != nil { panic(err) } Example to List Endpoint groups allPages, err := endpointgroups.List(client, nil).AllPages() if err != nil { panic(err) } allGroups, err := endpointgroups.ExtractEndpointGroups(allPages) if err != nil { panic(err) } Example to Update an endpoint group name := "updatedname" description := "updated description" updateOpts := endpointgroups.UpdateOpts{ Name: &name, Description: &description, } updatedPolicy, err := endpointgroups.Update(client, "5c561d9d-eaea-45f6-ae3e-08d1a7080828", updateOpts).Extract() if err != nil { panic(err) }
networking/v2/extensions/vpnaas/ikepolicies
Package ikepolicies allows management and retrieval of IKE policies in the OpenStack Networking Service.
 Package ikepolicies allows management and retrieval of IKE policies in the OpenStack Networking Service.
networking/v2/extensions/vpnaas/ipsecpolicies
Package ipsecpolicies allows management and retrieval of IPSec Policies in the OpenStack Networking Service.
 Package ipsecpolicies allows management and retrieval of IPSec Policies in the OpenStack Networking Service.
networking/v2/extensions/vpnaas/services
Package services allows management and retrieval of VPN services in the OpenStack Networking Service.
 Package services allows management and retrieval of VPN services in the OpenStack Networking Service.
networking/v2/extensions/vpnaas/siteconnections
Package siteconnections allows management and retrieval of IPSec site connections in the OpenStack Networking Service.
 Package siteconnections allows management and retrieval of IPSec site connections in the OpenStack Networking Service.
networking/v2/networks
Package networks contains functionality for working with Neutron network resources.
 Package networks contains functionality for working with Neutron network resources.
networking/v2/networks/testing
networks unit tests
 networks unit tests
networking/v2/peerings
Package peerings enables management and retrieval of vpc peering connections Example to List a Vpc Peering Connections listOpts:=peerings.ListOpts{} peering,err :=peerings.List(client,sub).AllPages() peerings,err:=peerings.ExtractPeerings(peering) if err != nil{ fmt.Println(err) } Example to Get a Vpc Peering Connection peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" peering,err :=peerings.Get(client,peeringID).Extract() if err != nil{ fmt.Println(err) } Example to Accept a Vpc Peering Connection Request // Note:- The TenantId should be of accepter peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" peering,err:=peerings.Accept(client,peeringID).ExtractResult() if err != nil{ fmt.Println(err) } Example to Reject a Vpc Peering Connection Request // Note:- The TenantId should be of accepter peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" peering,err:=peerings.Reject(client,peeringID).ExtractResult() if err != nil{ fmt.Println(err) } Example to Create a Vpc Peering Connection RequestVpcInfo:=peerings.VpcInfo{VpcId:"3127e30b-5f8e-42d1-a3cc-fdadf412c5bf"} AcceptVpcInfo:=peerings.VpcInfo{"c6efbdb7-dca4-4178-b3ec-692f125c1e25","17fbda95add24720a4038ba4b1c705ed"} opt:=peerings.CreateOpts{"C2C_test",RequestVpcInfo,AcceptVpcInfo} peering,err:=peerings.Create(client,opt).Extract() if err != nil{ fmt.Println(err) } Example to Update a VpcPeeringConnection peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" updateOpts:=peerings.UpdateOpts{"C2C_tes1"} peering,err:=peerings.Update(client,peeringID,updateOpts).Extract() if err != nil{ fmt.Println(err) } Example to Delete a VpcPeeringConnection peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" err := peerings.Delete(client,"6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3") if err != nil { panic(err) }
 Package peerings enables management and retrieval of vpc peering connections Example to List a Vpc Peering Connections listOpts:=peerings.ListOpts{} peering,err :=peerings.List(client,sub).AllPages() peerings,err:=peerings.ExtractPeerings(peering) if err != nil{ fmt.Println(err) } Example to Get a Vpc Peering Connection peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" peering,err :=peerings.Get(client,peeringID).Extract() if err != nil{ fmt.Println(err) } Example to Accept a Vpc Peering Connection Request // Note:- The TenantId should be of accepter peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" peering,err:=peerings.Accept(client,peeringID).ExtractResult() if err != nil{ fmt.Println(err) } Example to Reject a Vpc Peering Connection Request // Note:- The TenantId should be of accepter peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" peering,err:=peerings.Reject(client,peeringID).ExtractResult() if err != nil{ fmt.Println(err) } Example to Create a Vpc Peering Connection RequestVpcInfo:=peerings.VpcInfo{VpcId:"3127e30b-5f8e-42d1-a3cc-fdadf412c5bf"} AcceptVpcInfo:=peerings.VpcInfo{"c6efbdb7-dca4-4178-b3ec-692f125c1e25","17fbda95add24720a4038ba4b1c705ed"} opt:=peerings.CreateOpts{"C2C_test",RequestVpcInfo,AcceptVpcInfo} peering,err:=peerings.Create(client,opt).Extract() if err != nil{ fmt.Println(err) } Example to Update a VpcPeeringConnection peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" updateOpts:=peerings.UpdateOpts{"C2C_tes1"} peering,err:=peerings.Update(client,peeringID,updateOpts).Extract() if err != nil{ fmt.Println(err) } Example to Delete a VpcPeeringConnection peeringID := "6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3" err := peerings.Delete(client,"6bbacb0f-9f94-4fe8-a6b6-1818bdccb2a3") if err != nil { panic(err) }
networking/v2/peerings/testing
peerings unit tests
 peerings unit tests
networking/v2/ports
Package ports contains functionality for working with Neutron port resources.
 Package ports contains functionality for working with Neutron port resources.
networking/v2/ports/testing
ports unit tests
 ports unit tests
networking/v2/routes
Package routes enables management and retrieval of Routes Route service.
 Package routes enables management and retrieval of Routes Route service.
networking/v2/routes/testing
networking/v2/subnets
Package subnets contains functionality for working with Neutron subnet resources.
 Package subnets contains functionality for working with Neutron subnet resources.
networking/v2/subnets/testing
subnets unit tests
 subnets unit tests
objectstorage/v1/accounts
Package accounts contains functionality for working with Object Storage account resources.
 Package accounts contains functionality for working with Object Storage account resources.
objectstorage/v1/containers
Package containers contains functionality for working with Object Storage container resources.
 Package containers contains functionality for working with Object Storage container resources.
objectstorage/v1/objects
Package objects contains functionality for working with Object Storage object resources.
 Package objects contains functionality for working with Object Storage object resources.
objectstorage/v1/swauth
Package swauth implements Swift's built-in authentication.
 Package swauth implements Swift's built-in authentication.
obs
rds/v1/datastores
rds/v1/flavors
rds/v1/instances
rds/v1/tags
rds/v3/backups
rds/v3/configurations
rds/v3/datastores
rds/v3/flavors
rds/v3/instances
rts/v1/softwareconfig
Package softwareconfig enables management and retrieval of Software Configs Example to List Software Configs listOpts := softwareconfig.ListOpts{} allConfigs, err := softwareconfig.List(client,listOpts) if err != nil { panic(err) } for _, config := range allConfigs { fmt.Printf("%+v\n", config) } Example to Get Software Deployment configID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" configs,err:=softwareconfig.Get(client,configID).Extract() if err != nil { panic(err) } Example to Create a Software Configs createOpts := softwareconfig.CreateOpts{ Name: "config_test", } config, err := softwareconfig.Create(client, createOpts).Extract() if err != nil { panic(err) } Example to Delete a Software Configs configID := "8de48948-b6d6-4417-82a5-071f7811af91" del:=softwareconfig.Delete(client,configID).ExtractErr() if err != nil { panic(err) }
 Package softwareconfig enables management and retrieval of Software Configs Example to List Software Configs listOpts := softwareconfig.ListOpts{} allConfigs, err := softwareconfig.List(client,listOpts) if err != nil { panic(err) } for _, config := range allConfigs { fmt.Printf("%+v\n", config) } Example to Get Software Deployment configID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" configs,err:=softwareconfig.Get(client,configID).Extract() if err != nil { panic(err) } Example to Create a Software Configs createOpts := softwareconfig.CreateOpts{ Name: "config_test", } config, err := softwareconfig.Create(client, createOpts).Extract() if err != nil { panic(err) } Example to Delete a Software Configs configID := "8de48948-b6d6-4417-82a5-071f7811af91" del:=softwareconfig.Delete(client,configID).ExtractErr() if err != nil { panic(err) }
rts/v1/softwareconfig/testing
rts/v1/softwaredeployment
Package softwaredeployment enables management and retrieval of Software Deployments Example to List Software Deployments listOpts := softwaredeployment.ListOpts{} allDeployments, err := softwaredeployment.List(client,listOpts) if err != nil { panic(err) } for _, deployment := range allDeployments { fmt.Printf("%+v\n", allDeployments) } Example to Get Software Deployment deploymentID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" deployments,err:=softwaredeployment.Get(client,deploymentID).Extract() if err != nil { panic(err) } Example to Create a Software Deployments input:=map[string]interface{}{"name":"foo"} createOpts := softwaredeployment.CreateOpts{ Status:"IN_PROGRESS", ServerId:"f274ac7d-334d-41ff-83bd-1de669f7781b", ConfigId:"a6ff3598-f2e0-4111-81b0-aa3e1cac2529", InputValues:input, TenantId:"17fbda95add24720a4038ba4b1c705ed", Action:"CREATE" } deployment, err := softwaredeployment.Create(client, createOpts).Extract() if err != nil { panic(err) } Example to Update a Software Deployments deploymentID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" ouput:=map[string]interface{}{"deploy_stdout":"Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n","deploy_stderr":"+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n", "deploy_status_code":0,"result":"The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"} updateOpts := softwaredeployment.UpdateOpts{ Status:"COMPLETE", ConfigId:"a6ff3598-f2e0-4111-81b0-aa3e1cac2529", OutputValues:ouput, StatusReason:"Outputs received"} deployment, err := softwaredeployment.Update(client, deploymentID, updateOpts).Extract() if err != nil { panic(err) } Example to Delete a Software Deployments deploymentID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" del:=softwaredeployment.Delete(client,deploymentID).ExtractErr() if err != nil { panic(err) }
 Package softwaredeployment enables management and retrieval of Software Deployments Example to List Software Deployments listOpts := softwaredeployment.ListOpts{} allDeployments, err := softwaredeployment.List(client,listOpts) if err != nil { panic(err) } for _, deployment := range allDeployments { fmt.Printf("%+v\n", allDeployments) } Example to Get Software Deployment deploymentID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" deployments,err:=softwaredeployment.Get(client,deploymentID).Extract() if err != nil { panic(err) } Example to Create a Software Deployments input:=map[string]interface{}{"name":"foo"} createOpts := softwaredeployment.CreateOpts{ Status:"IN_PROGRESS", ServerId:"f274ac7d-334d-41ff-83bd-1de669f7781b", ConfigId:"a6ff3598-f2e0-4111-81b0-aa3e1cac2529", InputValues:input, TenantId:"17fbda95add24720a4038ba4b1c705ed", Action:"CREATE" } deployment, err := softwaredeployment.Create(client, createOpts).Extract() if err != nil { panic(err) } Example to Update a Software Deployments deploymentID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" ouput:=map[string]interface{}{"deploy_stdout":"Writing to /tmp/baaaaa\nWritten to /tmp/baaaaa\n","deploy_stderr":"+ echo Writing to /tmp/baaaaa\n+ echo fooooo\n+ cat /tmp/baaaaa\n+ echo -n The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE\n+ echo Written to /tmp/baaaaa\n+ echo Output to stderr\nOutput to stderr\n", "deploy_status_code":0,"result":"The file /tmp/baaaaa contains fooooo for server ec14c864-096e-4e27-bb8a-2c2b4dc6f3f5 during CREATE"} updateOpts := softwaredeployment.UpdateOpts{ Status:"COMPLETE", ConfigId:"a6ff3598-f2e0-4111-81b0-aa3e1cac2529", OutputValues:ouput, StatusReason:"Outputs received"} deployment, err := softwaredeployment.Update(client, deploymentID, updateOpts).Extract() if err != nil { panic(err) } Example to Delete a Software Deployments deploymentID:="bd7d48a5-6e33-4b95-aa28-d0d3af46c635" del:=softwaredeployment.Delete(client,deploymentID).ExtractErr() if err != nil { panic(err) }
rts/v1/softwaredeployment/testing
rts/v1/stackevents
Package stackevents provides operations for finding, listing, and retrieving stack events.
 Package stackevents provides operations for finding, listing, and retrieving stack events.
rts/v1/stackevents/testing
orchestration_stackevents_v1
 orchestration_stackevents_v1
rts/v1/stackresources
Package stackresources provides operations for working with stack resources.
 Package stackresources provides operations for working with stack resources.
rts/v1/stackresources/testing
orchestration_stackresources_v1
 orchestration_stackresources_v1
rts/v1/stacks
rts/v1/stacks/testing
rts/v1/stacktemplates
Package stacktemplates provides operations for working with Heat templates.
 Package stacktemplates provides operations for working with Heat templates.
rts/v1/stacktemplates/testing
sdrs/v1/attachreplication
sdrs/v1/domains
sdrs/v1/drill
sdrs/v1/protectedinstances
sdrs/v1/protectiongroups
sdrs/v1/replications
sfs/v2/common
sfs/v2/shares
Package shares enables management and retrieval of shares Share service.
 Package shares enables management and retrieval of shares Share service.
sfs/v2/shares/testing
sfs_turbo/v1/shares
smn/v2/subscriptions
smn/v2/topicattributes
smn/v2/topics
swr/v2
swr/v2/domains
swr/v2/organizations
swr/v2/repositories
testing
openstack
 openstack
tms/v1/tags
utils
utils/testing
utils
 utils
vbs/v2/backups
Package backups enables management and retrieval of Backups VBS service.
 Package backups enables management and retrieval of Backups VBS service.
vbs/v2/backups/testing
vbs/v2/common
vbs/v2/policies
vbs/v2/policies/testing
vbs/v2/shares
Package shares enables management and retrieval of Shares VBS service.
 Package shares enables management and retrieval of Shares VBS service.
vbs/v2/shares/testing
vbs/v2/tags
vbs/v2/tags/testing
vpc/v1/bandwidths
You can allocate bandwidth when assigning an EIP so that the ECS bound with the EIP can use the bandwidth to access the Internet.
 You can allocate bandwidth when assigning an EIP so that the ECS bound with the EIP can use the bandwidth to access the Internet.
vpc/v1/bandwidths/testing
vpc/v1/publicips
vpc/v1/publicips/testing
vpcep/v1/endpoints
vpcep/v1/endpoints/testing
vpcep/v1/services
vpcep/v1/services/testing
waf/v1/alarmnotifications
waf/v1/ccattackprotection_rules
waf/v1/certificates
waf/v1/datamasking_rules
waf/v1/domains
waf/v1/falsealarmmasking_rules
waf/v1/policies
waf/v1/preciseprotection_rules
waf/v1/webtamperprotection_rules
waf/v1/whiteblackip_rules
Package pagination contains utilities and convenience structs that implement common pagination idioms within OpenStack APIs.
 Package pagination contains utilities and convenience structs that implement common pagination idioms within OpenStack 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
golangsdk
 golangsdk

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.