Golangsdk

Package openstack contains resources for the individual OpenStack projects supported in Gophercloud.

Package pagination contains utilities and convenience structs that implement common pagination idioms within OpenStack APIs.

Package testhelper container methods that are useful for writing unit tests.

golangsdk.

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

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

BuildRequestBody builds a map[string]interface from the given `struct`.

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

HashSha256 is a wrapper for sha256 implementation.

HmacSha256 implements the Keyed-Hash Message Authentication Code computation.

IDSliceToQueryString takes a slice of elements and converts them into a query string.

IntToPointer is a function for converting integers into integer pointers.

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

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

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

NewCache inits an new MemoryCache.

NormalizePathURL is used to convert rawPath to a fqdn, using basePath as a reference in the filesystem, if necessary.

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

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

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

WaitFor polls a predicate function, once per second, up to a timeout limit.

AvailabilityAdmin indicates that an endpoint is only available to administrators.

AvailabilityInternal indicates that an endpoint is only available within the cluster's internal network.

AvailabilityPublic indicates that an endpoint is available to everyone on the internet.

The header key of content hash value.

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

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

IPv4 is used for IP version 4 addresses.

IPv6 is used for IP version 6 addresses.

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

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

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

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

The default sign algorithm.

Convenience vars for EnabledState values.

Convenience vars for EnabledState values.

AKSKAuthOptions presents the required information for AK/SK auth.

AuthOptions stores information needed to authenticate to an OpenStack Cloud.

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

EndpointOpts specifies search criteria used by queries against an OpenStack service catalog.

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

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

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

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

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

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

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

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

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

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

ErrDomainIDOrDomainName indicates that a username was provided, but no domain to scope it.

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

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

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

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

ErrEndpointNotFound is returned when no available endpoints match the provided EndpointOpts.

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

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

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

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

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

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

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.

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

ErrScopeEmpty indicates that no credentials were provided in a Scope.

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

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

ErrServiceNotFound is returned when no service in a service catalog matches the provided EndpointOpts.

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

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

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

ErrUnableToReauthenticate is the error type returned when reauthentication fails.

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

ErrUnexpectedType is the error when an unexpected type is encountered.

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

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

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

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.

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

MemoryCache presents a thread safe memory cache.

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

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

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.

ServiceClient stores details required to interact with a specific service API implemented by a provider.

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

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

UserAgent represents a User-Agent header.

AuthOptionsProvider presents the base of an auth options implementation.

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

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

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

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

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

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

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

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

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

Availability indicates to whom a specific service endpoint is accessible: the internet at large, internal networks only, or only to administrators.

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

IPVersion is a type for the possible IP address versions.