README
¶
Octavia amphorae
amphorae.API wraps Gophercloud v2.15.0 loadbalancer/v2/amphorae for the administrative /octavia/amphorae routes. Python openstacksdk Resource and workflow equivalence is tracked separately.
| Operation | Route | Success codes | Notes |
|---|---|---|---|
Get |
GET .../{id} |
200 | Typed model; CertExpiration, CreatedAt and UpdatedAt decode zone-less timestamps; native 404 stays an HTTP response error |
List |
GET /octavia/amphorae |
200 | Follows amphorae_links; typed filters are LoadbalancerID, ImageID, Role, Status, HAPortID, VRRPPortID plus paging/sort keys |
Failover |
PUT .../{id}/failover |
202 only | No request body |
Extension queries use WithListQuery; a nil option fails with resource.ErrInvalidOption before any request. There are no create, update or delete operations.
Find, All, WaitFor and WaitForDeletion use the common resource.Collection with status as the wait status. Amphorae have no native delete, so Remove is not a supported deletion path.
Failover acknowledgement does not imply completion; wait on status explicitly. Cancelling a context stops the local call and does not roll back remote work; a failover is never replayed automatically.
Configure
API.Configure(ctx, id) sends PUT /octavia/amphorae/{id}/config with no request body and accepts only 202; it is implemented directly on the service client because the pinned Gophercloud release has no binding for this route. Native 404 and other rejections stay HTTP response errors. Acknowledgement does not imply the amphora agent has applied the configuration; observe status explicitly. The call is never replayed automatically.
Documentation
¶
Overview ¶
Code generated by sdkgen from Gophercloud v2.15.0; DO NOT EDIT.
Code generated by sdkgen from Gophercloud v2.15.0; DO NOT EDIT.
Index ¶
- type API
- func (a *API) All(ctx context.Context, options ...resource.ListOption) ([]*Amphora, error)
- func (a *API) Configure(ctx context.Context, id string) error
- func (a *API) Failover(ctx context.Context, id string) error
- func (a *API) Find(ctx context.Context, ref resource.Ref, options ...resource.LookupOption) (*Amphora, error)
- func (a *API) Get(ctx context.Context, id string) (*Amphora, error)
- func (a *API) List(ctx context.Context, options ...ListOption) iter.Seq2[*Amphora, error]
- func (a *API) RawClient() *gophercloud.ServiceClient
- func (a *API) Remove(ctx context.Context, ref resource.Ref, options ...resource.LookupOption) error
- func (a *API) WaitFor(ctx context.Context, ref resource.Ref, status string, ...) (*Amphora, error)
- func (a *API) WaitForDeletion(ctx context.Context, ref resource.Ref, options ...resource.WaitOption) error
- type Amphora
- type AmphoraPage
- type FailoverResult
- type GetResult
- type ListOption
- type ListOpts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type API ¶
type API struct {
Resources *resource.Collection[Amphora]
// contains filtered or unexported fields
}
API owns typed operations and their shared resource policies.
func New ¶
func New(client *gophercloud.ServiceClient) *API
func (*API) Configure ¶
Configure asks Octavia to push the current configuration to one amphora agent (PUT /octavia/amphorae/{id}/config). The request has no body and only 202 is accepted. The pinned Gophercloud release has no native binding for this route, so the call goes through the service client directly.
Acknowledgement is not completion: the amphora is reconfigured asynchronously and callers must observe its status explicitly. The call is never replayed automatically and cancelling the context does not roll back remote work.
func (*API) Failover ¶
Failover invokes the upstream API with library-owned builders and result handling.
func (*API) RawClient ¶
func (a *API) RawClient() *gophercloud.ServiceClient
func (*API) WaitForDeletion ¶
type AmphoraPage ¶
type AmphoraPage = upstream.AmphoraPage
type FailoverResult ¶
type FailoverResult = upstream.FailoverResult
type ListOption ¶
func WithListOptions ¶
func WithListOptions(value ListOpts) ListOption
func WithListQuery ¶
func WithListQuery(key, value string) ListOption
Source Files