Documentation ¶
Overview ¶
Package gophercloud 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.
It is now recommended to use the `clientconfig` package found at https://github.com/gophercloud/utils/tree/master/openstack/clientconfig for all authentication purposes. The below documentation is still relevant. clientconfig simply implements the below and presents it in an easier and more flexible way.
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 := gophercloud.AuthOptions{ IdentityEndpoint: "https://openstack.example.com:5000/v2.0", Username: "{username}", Password: "{password}", TenantID: "{tenant_id}", } provider, err := openstack.AuthenticatedClient(opts)
You can authenticate with a token by doing:
opts := gophercloud.AuthOptions{ IdentityEndpoint: "https://openstack.example.com:5000/v2.0", TokenID: "{token_id}", 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 := gophercloud.EndpointOpts{Region: "RegionOne"} client, err := openstack.NewComputeV2(provider, opts)
Resources ¶
Resource structs are the domain models that services make use of in order to work with and represent the state of API resources:
server, err := servers.Get(client, "{serverId}").Extract()
Intermediate Result structs are returned for API operations, which allow generic access to the HTTP headers, response body, and any errors associated with the network transaction. To turn a result into a usable resource struct, you must call the Extract method which is chained to the response, or an Extract function from an applicable extension:
result := servers.Get(client, "{serverId}") // Attempt to extract the disk configuration from the OS-DCF disk config // extension: config, err := diskconfig.ExtractGet(result)
All requests that enumerate a collection return a Pager struct that is used to iterate through the results one page at a time. Use the EachPage method on that Pager to handle each successive Page in a closure, then use the appropriate extraction method from that request's package to interpret that Page as a slice of results:
err := servers.List(client, nil).EachPage(func (page pagination.Page) (bool, error) { s, err := servers.ExtractServers(page) if err != nil { return false, err } // Handle the []servers.Server slice. // Return "false" or an error to prematurely stop fetching new pages. return true, nil })
If you want to obtain the entire collection of pages without doing any intermediary processing on each page, you can use the AllPages method:
allPages, err := servers.List(client, nil).AllPages() allServers, err := servers.ExtractServers(allPages)
This top-level package contains utility functions and data types that are used throughout the provider and service packages. Of particular note for end users are the AuthOptions and EndpointOpts structs.
Index ¶
- Constants
- func BuildHeaders(opts interface{}) (map[string]string, error)
- func BuildQueryString(opts interface{}) (*url.URL, error)
- func BuildRequestBody(opts interface{}, parent string) (map[string]interface{}, error)
- func ExtractNextURL(links []Link) (string, error)
- func IDSliceToQueryString(name string, ids []int) string
- func IntToPointer(i int) *int
- func IntWithinRange(val, min, max int) bool
- func MaybeInt(original int) *int
- func MaybeString(original string) *string
- func NormalizePathURL(basePath, rawPath string) (string, error)
- func NormalizeURL(url string) string
- func WaitFor(timeout int, predicate func() (bool, error)) error
- type AuthOptions
- func (opts AuthOptions) CanReauth() bool
- func (opts AuthOptions) ToTokenV2CreateMap() (map[string]interface{}, error)
- func (opts *AuthOptions) ToTokenV3CreateMap(scope map[string]interface{}) (map[string]interface{}, error)
- func (opts *AuthOptions) ToTokenV3ScopeMap() (map[string]interface{}, error)
- type AuthResult
- type AuthScope
- type Availability
- type BaseError
- type EnabledState
- type EndpointLocator
- type EndpointOpts
- type Err400er
- type Err401er
- type Err403er
- type Err404er
- type Err405er
- type Err408er
- type Err409er
- type Err429er
- type Err500er
- type Err503er
- type ErrAPIKeyProvided
- type ErrAppCredMissingSecret
- type ErrDefault400
- type ErrDefault401
- type ErrDefault403
- type ErrDefault404
- type ErrDefault405
- type ErrDefault408
- type ErrDefault409
- type ErrDefault429
- type ErrDefault500
- type ErrDefault503
- type ErrDomainIDOrDomainName
- type ErrDomainIDWithToken
- type ErrDomainIDWithUserID
- type ErrDomainNameWithToken
- type ErrDomainNameWithUserID
- type ErrEndpointNotFound
- type ErrErrorAfterReauthentication
- type ErrInvalidInput
- type ErrMissingAnyoneOfEnvironmentVariables
- type ErrMissingEnvironmentVariable
- type ErrMissingInput
- type ErrMissingPassword
- type ErrMultipleResourcesFound
- type ErrResourceNotFound
- type ErrResult
- type ErrScopeDomainIDOrDomainName
- type ErrScopeEmpty
- type ErrScopeProjectIDAlone
- type ErrScopeProjectIDOrProjectName
- type ErrServiceNotFound
- type ErrTenantIDProvided
- type ErrTenantNameProvided
- type ErrTimeOut
- type ErrUnableToReauthenticate
- type ErrUnexpectedResponseCode
- type ErrUnexpectedType
- type ErrUserIDWithToken
- type ErrUsernameOrUserID
- type ErrUsernameWithToken
- type HeaderResult
- type IPVersion
- type JSONRFC1123
- type JSONRFC3339Milli
- type JSONRFC3339MilliNoZ
- type JSONRFC3339NoZ
- type JSONRFC3339ZNoT
- type JSONRFC3339ZNoTNoZ
- type JSONUnix
- type Link
- type ProviderClient
- func (client *ProviderClient) AuthenticatedHeaders() (m map[string]string)
- func (client *ProviderClient) CopyTokenFrom(other *ProviderClient)
- func (client *ProviderClient) GetAuthResult() AuthResult
- func (client *ProviderClient) IsThrowaway() bool
- func (client *ProviderClient) Reauthenticate(previousToken string) (err error)
- func (client *ProviderClient) Request(method, url string, options *RequestOpts) (*http.Response, error)
- func (client *ProviderClient) SetThrowaway(v bool)
- func (client *ProviderClient) SetToken(t string)
- func (client *ProviderClient) SetTokenAndAuthResult(r AuthResult) error
- func (client *ProviderClient) Token() string
- func (client *ProviderClient) UseTokenLock()
- type RequestOpts
- type Result
- type ServiceClient
- func (client *ServiceClient) Delete(url string, opts *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) Get(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) Head(url string, opts *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) Patch(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) Post(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) Put(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) Request(method, url string, options *RequestOpts) (*http.Response, error)
- func (client *ServiceClient) ResourceBaseURL() string
- func (client *ServiceClient) ServiceURL(parts ...string) string
- type UserAgent
Constants ¶
const DefaultUserAgent = "gophercloud/2.0.0"
DefaultUserAgent is the default User-Agent string set in the request header.
const RFC3339Milli = "2006-01-02T15:04:05.999999Z"
RFC3339Milli describes a common time format used by some API responses.
const RFC3339MilliNoZ = "2006-01-02T15:04:05.999999"
const RFC3339NoZ = "2006-01-02T15:04:05"
RFC3339NoZ is the time format used in Heat (Orchestration).
const RFC3339ZNoT = "2006-01-02 15:04:05-07:00"
RFC3339ZNoT is the time format used in Zun (Containers Service).
const RFC3339ZNoTNoZ = "2006-01-02 15:04:05"
RFC3339ZNoTNoZ is another time format used in Zun (Containers Service).
Variables ¶
This section is empty.
Functions ¶
func BuildHeaders ¶
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 ¶
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 ¶
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 := gophercloud.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 ¶
ExtractNextURL is an internal function useful for packages of collection resources that are paginated in a certain way.
It attempts to extract the "next" URL from slice of Link structs, or "" if no such URL is present.
func IDSliceToQueryString ¶
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 ¶
IntToPointer is a function for converting integers into integer pointers. This is useful when passing in options to operations.
func IntWithinRange ¶
IntWithinRange returns TRUE if an integer falls within a defined range, and FALSE if not.
func MaybeInt ¶
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 ¶
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 ¶
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 ¶
NormalizeURL is an internal function to be used by provider clients.
It ensures that each endpoint URL has a closing `/`, as expected by ServiceClient's methods.
func WaitFor ¶
WaitFor polls a predicate function, once per second, up to a timeout limit. This is useful to wait for a resource to transition to a certain state. To handle situations when the predicate might hang indefinitely, the predicate will be prematurely cancelled after the timeout. Resource packages will wrap this in a more convenient function that's specific to a certain resource, but it can also be useful on its own.
Types ¶
type AuthOptions ¶
type AuthOptions struct { // IdentityEndpoint specifies the HTTP endpoint that is required to work with // the Identity API of the appropriate version. While it's ultimately needed by // all of the identity services, it will often be populated by a provider-level // function. // // The IdentityEndpoint is typically referred to as the "auth_url" or // "OS_AUTH_URL" in the information provided by the cloud operator. IdentityEndpoint string `json:"-"` // Username is required if using Identity V2 API. Consult with your provider's // control panel to discover your account's username. In Identity V3, either // UserID or a combination of Username and DomainID or DomainName are needed. Username string `json:"username,omitempty"` UserID string `json:"-"` Password string `json:"password,omitempty"` // At most one of DomainID and DomainName must be provided if using Username // with Identity V3. Otherwise, either are optional. DomainID string `json:"-"` DomainName string `json:"name,omitempty"` // The TenantID and TenantName fields are optional for the Identity V2 API. // The same fields are known as project_id and project_name in the Identity // V3 API, but are collected as TenantID and TenantName here in both cases. // Some providers allow you to specify a TenantName instead of the TenantId. // Some require both. Your provider's authentication policies will determine // how these fields influence authentication. // If DomainID or DomainName are provided, they will also apply to TenantName. // It is not currently possible to authenticate with Username and a Domain // and scope to a Project in a different Domain by using TenantName. To // accomplish that, the ProjectID will need to be provided as the TenantID // option. TenantID string `json:"tenantId,omitempty"` TenantName string `json:"tenantName,omitempty"` // AllowReauth should be set to true if you grant permission for 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:"-"` // Scope determines the scoping of the authentication request. Scope *AuthScope `json:"-"` // Authentication through Application Credentials requires supplying name, project and secret // For project we can use TenantID ApplicationCredentialID string `json:"-"` ApplicationCredentialName string `json:"-"` ApplicationCredentialSecret string `json:"-"` }
AuthOptions stores information needed to authenticate to an 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 := gophercloud.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) CanReauth ¶
func (opts AuthOptions) CanReauth() bool
func (AuthOptions) ToTokenV2CreateMap ¶
func (opts AuthOptions) ToTokenV2CreateMap() (map[string]interface{}, error)
ToTokenV2CreateMap allows AuthOptions to satisfy the AuthOptionsBuilder interface in the v2 tokens package
func (*AuthOptions) ToTokenV3CreateMap ¶
func (opts *AuthOptions) ToTokenV3CreateMap(scope map[string]interface{}) (map[string]interface{}, error)
func (*AuthOptions) ToTokenV3ScopeMap ¶
func (opts *AuthOptions) ToTokenV3ScopeMap() (map[string]interface{}, error)
type AuthResult ¶
AuthResult is the result from the request that was used to obtain a provider client's Keystone token. It is returned from ProviderClient.GetAuthResult().
The following types satisfy this interface:
github.com/gophercloud/gophercloud/openstack/identity/v2/tokens.CreateResult github.com/gophercloud/gophercloud/openstack/identity/v3/tokens.CreateResult
Usage example:
import ( "github.com/gophercloud/gophercloud" tokens2 "github.com/gophercloud/gophercloud/openstack/identity/v2/tokens" tokens3 "github.com/gophercloud/gophercloud/openstack/identity/v3/tokens" ) func GetAuthenticatedUserID(providerClient *gophercloud.ProviderClient) (string, error) { r := providerClient.GetAuthResult() if r == nil { //ProviderClient did not use openstack.Authenticate(), e.g. because token //was set manually with ProviderClient.SetToken() return "", errors.New("no AuthResult available") } switch r := r.(type) { case tokens2.CreateResult: u, err := r.ExtractUser() if err != nil { return "", err } return u.ID, nil case tokens3.CreateResult: u, err := r.ExtractUser() if err != nil { return "", err } return u.ID, nil default: panic(fmt.Sprintf("got unexpected AuthResult type %t", r)) } }
Both implementing types share a lot of methods by name, like ExtractUser() in this example. But those methods cannot be part of the AuthResult interface because the return types are different (in this case, type tokens2.User vs. type tokens3.User).
type AuthScope ¶
AuthScope allows a created token to be limited to a specific domain or project.
type Availability ¶
type Availability string
Availability indicates to whom a specific service endpoint is accessible: the internet at large, internal networks only, or only to administrators. Different identity services use different terminology for these. Identity v2 lists them as different kinds of URLs within the service catalog ("adminURL", "internalURL", and "publicURL"), while v3 lists them as "Interfaces" in an endpoint's response.
const ( // 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 ¶
BaseError is an error type that all other error types embed.
type EnabledState ¶
type EnabledState *bool
EnabledState is a convenience type, mostly used in Create and Update operations. Because the zero value of a bool is FALSE, we need to use a pointer instead to indicate zero-ness.
var ( Enabled EnabledState = &iTrue Disabled EnabledState = &iFalse )
Convenience vars for EnabledState values.
type EndpointLocator ¶
type EndpointLocator func(EndpointOpts) (string, error)
EndpointLocator is an internal function to be used by provider implementations.
It provides an implementation that locates a single endpoint from a service catalog for a specific ProviderClient based on user-provided EndpointOpts. The provider then uses it to discover related ServiceClients.
type EndpointOpts ¶
type EndpointOpts struct { // Type [required] is the service type for the client (e.g., "compute", // "object-store"). Generally, this will be supplied by the service client // function, but a user-given value will be honored if provided. Type string // Name [optional] is the service name for the client (e.g., "nova") as it // appears in the service catalog. Services can have the same Type but a // different Name, which is why both Type and Name are sometimes needed. Name string // Region [required] is the geographic region in which the endpoint resides, // generally specifying which datacenter should house your resources. // Required only for services that span multiple regions. Region string // Availability [optional] is the visibility of the endpoint to be returned. // Valid types include the constants AvailabilityPublic, AvailabilityInternal, // or AvailabilityAdmin from this package. // // Availability is not required, and defaults to AvailabilityPublic. Not all // providers or services offer all Availability options. Availability Availability }
EndpointOpts specifies search criteria used by queries against an OpenStack service catalog. The options must contain enough information to unambiguously identify one, and only one, endpoint within the catalog.
Usually, these are passed to service client factory functions in a provider package, like "openstack.NewComputeV2()".
func (*EndpointOpts) ApplyDefaults ¶
func (eo *EndpointOpts) ApplyDefaults(t string)
ApplyDefaults is an internal method to be used by provider implementations.
It sets EndpointOpts fields if not already set, including a default type. Currently, EndpointOpts.Availability defaults to the public endpoint.
type Err400er ¶
type Err400er interface {
Error400(ErrUnexpectedResponseCode) error
}
Err400er is the interface resource error types implement to override the error message from a 400 error.
type Err401er ¶
type Err401er interface {
Error401(ErrUnexpectedResponseCode) error
}
Err401er is the interface resource error types implement to override the error message from a 401 error.
type Err403er ¶
type Err403er interface {
Error403(ErrUnexpectedResponseCode) error
}
Err403er is the interface resource error types implement to override the error message from a 403 error.
type Err404er ¶
type Err404er interface {
Error404(ErrUnexpectedResponseCode) error
}
Err404er is the interface resource error types implement to override the error message from a 404 error.
type Err405er ¶
type Err405er interface {
Error405(ErrUnexpectedResponseCode) error
}
Err405er is the interface resource error types implement to override the error message from a 405 error.
type Err408er ¶
type Err408er interface {
Error408(ErrUnexpectedResponseCode) error
}
Err408er is the interface resource error types implement to override the error message from a 408 error.
type Err409er ¶
type Err409er interface {
Error409(ErrUnexpectedResponseCode) error
}
Err409er is the interface resource error types implement to override the error message from a 409 error.
type Err429er ¶
type Err429er interface {
Error429(ErrUnexpectedResponseCode) error
}
Err429er is the interface resource error types implement to override the error message from a 429 error.
type Err500er ¶
type Err500er interface {
Error500(ErrUnexpectedResponseCode) error
}
Err500er is the interface resource error types implement to override the error message from a 500 error.
type Err503er ¶
type Err503er interface {
Error503(ErrUnexpectedResponseCode) error
}
Err503er is the interface resource error types implement to override the error message from a 503 error.
type ErrAPIKeyProvided ¶
type ErrAPIKeyProvided struct{ BaseError }
ErrAPIKeyProvided indicates that an APIKey was provided but can't be used.
func (ErrAPIKeyProvided) Error ¶
func (e ErrAPIKeyProvided) Error() string
type ErrAppCredMissingSecret ¶
type ErrAppCredMissingSecret struct{ BaseError }
ErrAppCredMissingSecret indicates that no Application Credential Secret was provided with Application Credential ID or Name
func (ErrAppCredMissingSecret) Error ¶
func (e ErrAppCredMissingSecret) Error() string
type ErrDefault400 ¶
type ErrDefault400 struct {
ErrUnexpectedResponseCode
}
ErrDefault400 is the default error type returned on a 400 HTTP response code.
func (ErrDefault400) Error ¶
func (e ErrDefault400) Error() string
type ErrDefault401 ¶
type ErrDefault401 struct {
ErrUnexpectedResponseCode
}
ErrDefault401 is the default error type returned on a 401 HTTP response code.
func (ErrDefault401) Error ¶
func (e ErrDefault401) Error() string
type ErrDefault403 ¶
type ErrDefault403 struct {
ErrUnexpectedResponseCode
}
ErrDefault403 is the default error type returned on a 403 HTTP response code.
func (ErrDefault403) Error ¶
func (e ErrDefault403) Error() string
type ErrDefault404 ¶
type ErrDefault404 struct {
ErrUnexpectedResponseCode
}
ErrDefault404 is the default error type returned on a 404 HTTP response code.
func (ErrDefault404) Error ¶
func (e ErrDefault404) Error() string
type ErrDefault405 ¶
type ErrDefault405 struct {
ErrUnexpectedResponseCode
}
ErrDefault405 is the default error type returned on a 405 HTTP response code.
func (ErrDefault405) Error ¶
func (e ErrDefault405) Error() string
type ErrDefault408 ¶
type ErrDefault408 struct {
ErrUnexpectedResponseCode
}
ErrDefault408 is the default error type returned on a 408 HTTP response code.
func (ErrDefault408) Error ¶
func (e ErrDefault408) Error() string
type ErrDefault409 ¶
type ErrDefault409 struct {
ErrUnexpectedResponseCode
}
ErrDefault409 is the default error type returned on a 409 HTTP response code.
type ErrDefault429 ¶
type ErrDefault429 struct {
ErrUnexpectedResponseCode
}
ErrDefault429 is the default error type returned on a 429 HTTP response code.
func (ErrDefault429) Error ¶
func (e ErrDefault429) Error() string
type ErrDefault500 ¶
type ErrDefault500 struct {
ErrUnexpectedResponseCode
}
ErrDefault500 is the default error type returned on a 500 HTTP response code.
func (ErrDefault500) Error ¶
func (e ErrDefault500) Error() string
type ErrDefault503 ¶
type ErrDefault503 struct {
ErrUnexpectedResponseCode
}
ErrDefault503 is the default error type returned on a 503 HTTP response code.
func (ErrDefault503) Error ¶
func (e ErrDefault503) Error() string
type ErrDomainIDOrDomainName ¶
type ErrDomainIDOrDomainName struct{ BaseError }
ErrDomainIDOrDomainName indicates that a username was provided, but no domain to scope it. It may also indicate that both a DomainID and a DomainName were provided at once.
func (ErrDomainIDOrDomainName) Error ¶
func (e ErrDomainIDOrDomainName) Error() string
type ErrDomainIDWithToken ¶
type ErrDomainIDWithToken struct{ BaseError }
ErrDomainIDWithToken indicates that a DomainID was provided, but token authentication is being used instead.
func (ErrDomainIDWithToken) Error ¶
func (e ErrDomainIDWithToken) Error() string
type ErrDomainIDWithUserID ¶
type ErrDomainIDWithUserID struct{ BaseError }
ErrDomainIDWithUserID indicates that a DomainID was provided, but unnecessary because a UserID is being used.
func (ErrDomainIDWithUserID) Error ¶
func (e ErrDomainIDWithUserID) Error() string
type ErrDomainNameWithToken ¶
type ErrDomainNameWithToken struct{ BaseError }
ErrDomainNameWithToken indicates that a DomainName was provided, but token authentication is being used instead.s
func (ErrDomainNameWithToken) Error ¶
func (e ErrDomainNameWithToken) Error() string
type ErrDomainNameWithUserID ¶
type ErrDomainNameWithUserID struct{ BaseError }
ErrDomainNameWithUserID indicates that a DomainName was provided, but unnecessary because a UserID is being used.
func (ErrDomainNameWithUserID) Error ¶
func (e ErrDomainNameWithUserID) Error() string
type ErrEndpointNotFound ¶
type ErrEndpointNotFound struct {
BaseError
}
ErrEndpointNotFound is returned when no available endpoints match the provided EndpointOpts. This is also generally returned by provider service factory methods, and usually indicates that a region was specified incorrectly.
func (ErrEndpointNotFound) Error ¶
func (e ErrEndpointNotFound) Error() string
type ErrErrorAfterReauthentication ¶
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 ErrMissingAnyoneOfEnvironmentVariables ¶
ErrMissingAnyoneOfEnvironmentVariables is the error when anyone of the environment variables is required in a particular situation but not provided by the user
func (ErrMissingAnyoneOfEnvironmentVariables) Error ¶
func (e ErrMissingAnyoneOfEnvironmentVariables) Error() string
type ErrMissingEnvironmentVariable ¶
ErrMissingEnvironmentVariable is the error when environment variable is required in a particular situation but not provided by the user
func (ErrMissingEnvironmentVariable) Error ¶
func (e ErrMissingEnvironmentVariable) Error() string
type ErrMissingInput ¶
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 ¶
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 ¶
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.
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 ¶
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 ¶
ErrUnexpectedType is the error when an unexpected type is encountered
func (ErrUnexpectedType) Error ¶
func (e ErrUnexpectedType) Error() string
type ErrUserIDWithToken ¶
type ErrUserIDWithToken struct{ BaseError }
ErrUserIDWithToken indicates that a UserID was provided, but token authentication is being used instead.
func (ErrUserIDWithToken) Error ¶
func (e ErrUserIDWithToken) Error() string
type ErrUsernameOrUserID ¶
type ErrUsernameOrUserID struct{ BaseError }
ErrUsernameOrUserID indicates that neither username nor userID are specified, or both are at once.
func (ErrUsernameOrUserID) Error ¶
func (e ErrUsernameOrUserID) Error() string
type ErrUsernameWithToken ¶
type ErrUsernameWithToken struct{ BaseError }
ErrUsernameWithToken indicates that a Username was provided, but token authentication is being used instead.
func (ErrUsernameWithToken) Error ¶
func (e ErrUsernameWithToken) Error() string
type HeaderResult ¶
type HeaderResult struct {
Result
}
HeaderResult is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.
It represents a result that only contains an error (possibly nil) and an http.Header. This is used, for example, by the objectstorage packages in 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
type JSONRFC1123 ¶
func (*JSONRFC1123) UnmarshalJSON ¶
func (jt *JSONRFC1123) UnmarshalJSON(data []byte) error
type JSONRFC3339Milli ¶
func (*JSONRFC3339Milli) UnmarshalJSON ¶
func (jt *JSONRFC3339Milli) UnmarshalJSON(data []byte) error
type JSONRFC3339MilliNoZ ¶
func (*JSONRFC3339MilliNoZ) UnmarshalJSON ¶
func (jt *JSONRFC3339MilliNoZ) UnmarshalJSON(data []byte) error
type JSONRFC3339NoZ ¶
func (*JSONRFC3339NoZ) UnmarshalJSON ¶
func (jt *JSONRFC3339NoZ) UnmarshalJSON(data []byte) error
type JSONRFC3339ZNoT ¶
func (*JSONRFC3339ZNoT) UnmarshalJSON ¶
func (jt *JSONRFC3339ZNoT) UnmarshalJSON(data []byte) error
type JSONRFC3339ZNoTNoZ ¶
func (*JSONRFC3339ZNoTNoZ) UnmarshalJSON ¶
func (jt *JSONRFC3339ZNoTNoZ) UnmarshalJSON(data []byte) error
type JSONUnix ¶
type Link ¶
Link is an internal type to be used in packages of collection resources that are paginated in a certain way.
It's a response substructure common to many paginated collection results that is used to point to related pages. Usually, the one we care about is the one with Rel field set to "next".
type ProviderClient ¶
type ProviderClient struct { // IdentityBase is the base URL used for a particular provider's identity // service - it will be used when issuing authenticatation requests. It // should point to the root resource of the identity service, not a specific // identity version. IdentityBase string // IdentityEndpoint is the identity endpoint. This may be a specific version // of the identity service. If this is the case, this endpoint is used rather // than querying versions first. IdentityEndpoint string // TokenID is the ID of the most recently issued valid token. // NOTE: Aside from within a custom ReauthFunc, this field shouldn't be set by an application. // To safely read or write this value, call `Token` or `SetToken`, respectively TokenID string // EndpointLocator describes how this provider discovers the endpoints for // its constituent services. EndpointLocator EndpointLocator // HTTPClient allows users to interject arbitrary http, https, or other transit behaviors. HTTPClient http.Client // UserAgent represents the User-Agent header in the HTTP request. UserAgent UserAgent // ReauthFunc is the function used to re-authenticate the user if the request // fails with a 401 HTTP response code. This a needed because there may be multiple // authentication functions for different Identity service versions. ReauthFunc func() error // Throwaway determines whether if this client is a throw-away client. It's a copy of user's provider client // with the token and reauth func zeroed. Such client can be used to perform reauthorization. Throwaway bool // Context is the context passed to the HTTP request. Context context.Context // 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. Blocks if Reauthenticate is in progress.
func (*ProviderClient) CopyTokenFrom ¶
func (client *ProviderClient) CopyTokenFrom(other *ProviderClient)
CopyTokenFrom safely copies the token from another ProviderClient into the this one.
func (*ProviderClient) GetAuthResult ¶
func (client *ProviderClient) GetAuthResult() AuthResult
GetAuthResult returns the result from the request that was used to obtain a provider client's Keystone token.
The result is nil when authentication has not yet taken place, when the token was set manually with SetToken(), or when a ReauthFunc was used that does not record the AuthResult.
func (*ProviderClient) IsThrowaway ¶
func (client *ProviderClient) IsThrowaway() bool
IsThrowaway safely reads the value of the client Throwaway field.
func (*ProviderClient) Reauthenticate ¶
func (client *ProviderClient) Reauthenticate(previousToken string) (err error)
Reauthenticate calls client.ReauthFunc in a thread-safe way. If this is called because of a 401 response, the caller may pass the previous token. In this case, the reauthentication can be skipped if another thread has already reauthenticated in the meantime. If no previous token is known, an empty string should be passed instead to force unconditional reauthentication.
func (*ProviderClient) Request ¶
func (client *ProviderClient) Request(method, url string, options *RequestOpts) (*http.Response, error)
Request performs an HTTP request using the ProviderClient's current HTTPClient. An authentication header will automatically be provided.
func (*ProviderClient) SetThrowaway ¶
func (client *ProviderClient) SetThrowaway(v bool)
SetThrowaway safely sets the value of the client Throwaway field.
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.
WARNING: This function is deprecated. Use SetTokenAndAuthResult() instead.
func (*ProviderClient) SetTokenAndAuthResult ¶
func (client *ProviderClient) SetTokenAndAuthResult(r AuthResult) error
SetTokenAndAuthResult safely sets the value of the auth token in the ProviderClient and also records the AuthResult that was returned from the token creation request. Applications may call this in a custom ReauthFunc.
func (*ProviderClient) Token ¶
func (client *ProviderClient) Token() string
Token safely reads the value of the auth token from the ProviderClient. Applications should call this method to access the token instead of the TokenID field
func (*ProviderClient) UseTokenLock ¶
func (client *ProviderClient) UseTokenLock()
UseTokenLock creates a mutex that is used to allow safe concurrent access to the auth token. If the application's ProviderClient is not used concurrently, this doesn't need to be called.
type RequestOpts ¶
type RequestOpts struct { // JSONBody, if provided, will be encoded as JSON and used as the body of the HTTP request. The // content type of the request will default to "application/json" unless overridden by MoreHeaders. // It's an error to specify both a JSONBody and a RawBody. JSONBody interface{} // RawBody contains an io.Reader that will be consumed by the request directly. No content-type // will be set unless one is provided explicitly by MoreHeaders. RawBody io.Reader // JSONResponse, if provided, will be populated with the contents of the response body parsed as // JSON. JSONResponse interface{} // OkCodes contains a list of numeric HTTP status codes that should be interpreted as success. If // the response has a different code, an error will be returned. OkCodes []int // MoreHeaders specifies additional HTTP headers to be provide on the request. If a header is // provided with a blank value (""), that header will be *omitted* instead: use this to suppress // the default Accept header or an inferred Content-Type, for example. MoreHeaders map[string]string // ErrorContext specifies the resource error type to return if an error is encountered. // This lets resources override default error messages based on the response status code. ErrorContext error }
RequestOpts customizes the behavior of the provider.Request() method.
type Result ¶
type Result struct { // Body is the payload of the HTTP response from the server. In most cases, // this will be the deserialized JSON structure. Body interface{} // Header contains the HTTP header structure from the original response. Header http.Header // Err is an error that occurred during the operation. It's deferred until // extraction to make it easier to chain the Extract call. Err error }
Result is an internal type to be used by individual resource packages, but its methods will be available on a wide variety of user-facing embedding types.
It acts as a base struct that other Result types, returned from request functions, can embed for convenience. All Results capture basic information from the HTTP transaction that was performed, including the response body, HTTP headers, and any errors that happened.
Generally, each Result type will have an Extract method that can be used to further interpret the result's payload in a specific context. Extensions or providers can then provide additional extraction functions to pull out provider- or extension-specific information as well.
func (Result) ExtractInto ¶
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 ¶
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 ¶
ExtractIntoStructPtr will unmarshal the Result (r) into the provided interface{} (to).
NOTE: For internal use only
`to` must be a pointer to an underlying struct type
If provided, `label` will be filtered out of the response body prior to `r` being unmarshalled into `to`.
func (Result) PrettyPrintJSON ¶
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 // MoreHeaders allows users (or Gophercloud) to set service-wide headers on requests. Put another way, // values set in this field will be set on all the HTTP requests the service client sends. MoreHeaders map[string]string }
ServiceClient stores details required to interact with a specific service API implemented by a provider. Generally, you'll acquire these by calling the appropriate `New` method on a ProviderClient.
func (*ServiceClient) Delete ¶
func (client *ServiceClient) Delete(url string, opts *RequestOpts) (*http.Response, error)
Delete calls `Request` with the "DELETE" HTTP verb.
func (*ServiceClient) Get ¶
func (client *ServiceClient) Get(url string, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
Get calls `Request` with the "GET" HTTP verb.
func (*ServiceClient) Head ¶
func (client *ServiceClient) Head(url string, opts *RequestOpts) (*http.Response, error)
Head calls `Request` with the "HEAD" HTTP verb.
func (*ServiceClient) Patch ¶
func (client *ServiceClient) Patch(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
Patch calls `Request` with the "PATCH" HTTP verb.
func (*ServiceClient) Post ¶
func (client *ServiceClient) Post(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
Post calls `Request` with the "POST" HTTP verb.
func (*ServiceClient) Put ¶
func (client *ServiceClient) Put(url string, JSONBody interface{}, JSONResponse interface{}, opts *RequestOpts) (*http.Response, error)
Put calls `Request` with the "PUT" HTTP verb.
func (*ServiceClient) Request ¶
func (client *ServiceClient) Request(method, url string, options *RequestOpts) (*http.Response, error)
Request carries out the HTTP operation for the service client
func (*ServiceClient) ResourceBaseURL ¶
func (client *ServiceClient) ResourceBaseURL() string
ResourceBaseURL returns the base URL of any resources used by this service. It MUST end with a /.
func (*ServiceClient) ServiceURL ¶
func (client *ServiceClient) ServiceURL(parts ...string) string
ServiceURL constructs a URL for a resource belonging to this provider.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package openstack contains resources for the individual OpenStack projects supported in Gophercloud.
|
Package openstack contains resources for the individual OpenStack projects supported in Gophercloud. |
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/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/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/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. |
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. |
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/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/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/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/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. |
identity/v2/tenants
Package tenants provides information and interaction with the tenants API resource for the OpenStack Identity service.
|
Package tenants provides information and interaction with the tenants API resource for the OpenStack Identity service. |
identity/v2/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/extensions/trusts
Package trusts enables management of OpenStack Identity Trusts.
|
Package trusts enables management of OpenStack Identity Trusts. |
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. |
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/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/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/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/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/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/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/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/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/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/networks
Package networks contains functionality for working with Neutron network resources.
|
Package networks contains functionality for working with Neutron network resources. |
networking/v2/ports
Package ports contains functionality for working with Neutron port resources.
|
Package ports contains functionality for working with Neutron port resources. |
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. |