server

package
v0.6.2 Latest Latest
Warning

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

 Go to latest Published: Dec 22, 2025 License: PostgreSQL Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BackupDatabaseNodeControlPlanePath 

func BackupDatabaseNodeControlPlanePath(databaseID string, nodeName string) string

BackupDatabaseNodeControlPlanePath returns the URL path to the control-plane service backup-database-node HTTP endpoint.

func CancelDatabaseTaskControlPlanePath 

func CancelDatabaseTaskControlPlanePath(databaseID string, taskID string) string

CancelDatabaseTaskControlPlanePath returns the URL path to the control-plane service cancel-database-task HTTP endpoint.

func CreateDatabaseControlPlanePath 

func CreateDatabaseControlPlanePath() string

CreateDatabaseControlPlanePath returns the URL path to the control-plane service create-database HTTP endpoint.

func DecodeBackupDatabaseNodeRequest 

func DecodeBackupDatabaseNodeRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeBackupDatabaseNodeRequest returns a decoder for requests sent to the control-plane backup-database-node endpoint.

func DecodeCancelDatabaseTaskRequest 

func DecodeCancelDatabaseTaskRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeCancelDatabaseTaskRequest returns a decoder for requests sent to the control-plane cancel-database-task endpoint.

func DecodeCreateDatabaseRequest 

func DecodeCreateDatabaseRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeCreateDatabaseRequest returns a decoder for requests sent to the control-plane create-database endpoint.

func DecodeDeleteDatabaseRequest 

func DecodeDeleteDatabaseRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeDeleteDatabaseRequest returns a decoder for requests sent to the control-plane delete-database endpoint.

func DecodeFailoverDatabaseNodeRequest 

func DecodeFailoverDatabaseNodeRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeFailoverDatabaseNodeRequest returns a decoder for requests sent to the control-plane failover-database-node endpoint.

func DecodeGetDatabaseRequest 

func DecodeGetDatabaseRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeGetDatabaseRequest returns a decoder for requests sent to the control-plane get-database endpoint.

func DecodeGetDatabaseTaskLogRequest 

func DecodeGetDatabaseTaskLogRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeGetDatabaseTaskLogRequest returns a decoder for requests sent to the control-plane get-database-task-log endpoint.

func DecodeGetDatabaseTaskRequest 

func DecodeGetDatabaseTaskRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeGetDatabaseTaskRequest returns a decoder for requests sent to the control-plane get-database-task endpoint.

func DecodeGetHostRequest 

func DecodeGetHostRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeGetHostRequest returns a decoder for requests sent to the control-plane get-host endpoint.

func DecodeGetJoinOptionsRequest 

func DecodeGetJoinOptionsRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeGetJoinOptionsRequest returns a decoder for requests sent to the control-plane get-join-options endpoint.

func DecodeInitClusterRequest 

func DecodeInitClusterRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeInitClusterRequest returns a decoder for requests sent to the control-plane init-cluster endpoint.

func DecodeJoinClusterRequest 

func DecodeJoinClusterRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeJoinClusterRequest returns a decoder for requests sent to the control-plane join-cluster endpoint.

func DecodeListDatabaseTasksRequest 

func DecodeListDatabaseTasksRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeListDatabaseTasksRequest returns a decoder for requests sent to the control-plane list-database-tasks endpoint.

func DecodeRemoveHostRequest 

func DecodeRemoveHostRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeRemoveHostRequest returns a decoder for requests sent to the control-plane remove-host endpoint.

func DecodeRestartInstanceRequest 

func DecodeRestartInstanceRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeRestartInstanceRequest returns a decoder for requests sent to the control-plane restart-instance endpoint.

func DecodeRestoreDatabaseRequest 

func DecodeRestoreDatabaseRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeRestoreDatabaseRequest returns a decoder for requests sent to the control-plane restore-database endpoint.

func DecodeStartInstanceRequest 

func DecodeStartInstanceRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeStartInstanceRequest returns a decoder for requests sent to the control-plane start-instance endpoint.

func DecodeStopInstanceRequest 

func DecodeStopInstanceRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeStopInstanceRequest returns a decoder for requests sent to the control-plane stop-instance endpoint.

func DecodeSwitchoverDatabaseNodeRequest 

func DecodeSwitchoverDatabaseNodeRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeSwitchoverDatabaseNodeRequest returns a decoder for requests sent to the control-plane switchover-database-node endpoint.

func DecodeUpdateDatabaseRequest 

func DecodeUpdateDatabaseRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (any, error)

DecodeUpdateDatabaseRequest returns a decoder for requests sent to the control-plane update-database endpoint.

func DeleteDatabaseControlPlanePath 

func DeleteDatabaseControlPlanePath(databaseID string) string

DeleteDatabaseControlPlanePath returns the URL path to the control-plane service delete-database HTTP endpoint.

func EncodeBackupDatabaseNodeError 

func EncodeBackupDatabaseNodeError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeBackupDatabaseNodeError returns an encoder for errors returned by the backup-database-node control-plane endpoint.

func EncodeBackupDatabaseNodeResponse 

func EncodeBackupDatabaseNodeResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeBackupDatabaseNodeResponse returns an encoder for responses returned by the control-plane backup-database-node endpoint.

func EncodeCancelDatabaseTaskError 

func EncodeCancelDatabaseTaskError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeCancelDatabaseTaskError returns an encoder for errors returned by the cancel-database-task control-plane endpoint.

func EncodeCancelDatabaseTaskResponse 

func EncodeCancelDatabaseTaskResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeCancelDatabaseTaskResponse returns an encoder for responses returned by the control-plane cancel-database-task endpoint.

func EncodeCreateDatabaseError 

func EncodeCreateDatabaseError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeCreateDatabaseError returns an encoder for errors returned by the create-database control-plane endpoint.

func EncodeCreateDatabaseResponse 

func EncodeCreateDatabaseResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeCreateDatabaseResponse returns an encoder for responses returned by the control-plane create-database endpoint.

func EncodeDeleteDatabaseError 

func EncodeDeleteDatabaseError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeDeleteDatabaseError returns an encoder for errors returned by the delete-database control-plane endpoint.

func EncodeDeleteDatabaseResponse 

func EncodeDeleteDatabaseResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeDeleteDatabaseResponse returns an encoder for responses returned by the control-plane delete-database endpoint.

func EncodeFailoverDatabaseNodeError 

func EncodeFailoverDatabaseNodeError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeFailoverDatabaseNodeError returns an encoder for errors returned by the failover-database-node control-plane endpoint.

func EncodeFailoverDatabaseNodeResponse 

func EncodeFailoverDatabaseNodeResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeFailoverDatabaseNodeResponse returns an encoder for responses returned by the control-plane failover-database-node endpoint.

func EncodeGetClusterError 

func EncodeGetClusterError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetClusterError returns an encoder for errors returned by the get-cluster control-plane endpoint.

func EncodeGetClusterResponse 

func EncodeGetClusterResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetClusterResponse returns an encoder for responses returned by the control-plane get-cluster endpoint.

func EncodeGetDatabaseError 

func EncodeGetDatabaseError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetDatabaseError returns an encoder for errors returned by the get-database control-plane endpoint.

func EncodeGetDatabaseResponse 

func EncodeGetDatabaseResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetDatabaseResponse returns an encoder for responses returned by the control-plane get-database endpoint.

func EncodeGetDatabaseTaskError 

func EncodeGetDatabaseTaskError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetDatabaseTaskError returns an encoder for errors returned by the get-database-task control-plane endpoint.

func EncodeGetDatabaseTaskLogError 

func EncodeGetDatabaseTaskLogError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetDatabaseTaskLogError returns an encoder for errors returned by the get-database-task-log control-plane endpoint.

func EncodeGetDatabaseTaskLogResponse 

func EncodeGetDatabaseTaskLogResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetDatabaseTaskLogResponse returns an encoder for responses returned by the control-plane get-database-task-log endpoint.

func EncodeGetDatabaseTaskResponse 

func EncodeGetDatabaseTaskResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetDatabaseTaskResponse returns an encoder for responses returned by the control-plane get-database-task endpoint.

func EncodeGetHostError 

func EncodeGetHostError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetHostError returns an encoder for errors returned by the get-host control-plane endpoint.

func EncodeGetHostResponse 

func EncodeGetHostResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetHostResponse returns an encoder for responses returned by the control-plane get-host endpoint.

func EncodeGetJoinOptionsError 

func EncodeGetJoinOptionsError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetJoinOptionsError returns an encoder for errors returned by the get-join-options control-plane endpoint.

func EncodeGetJoinOptionsResponse 

func EncodeGetJoinOptionsResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetJoinOptionsResponse returns an encoder for responses returned by the control-plane get-join-options endpoint.

func EncodeGetJoinTokenError 

func EncodeGetJoinTokenError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetJoinTokenError returns an encoder for errors returned by the get-join-token control-plane endpoint.

func EncodeGetJoinTokenResponse 

func EncodeGetJoinTokenResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetJoinTokenResponse returns an encoder for responses returned by the control-plane get-join-token endpoint.

func EncodeGetVersionError 

func EncodeGetVersionError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeGetVersionError returns an encoder for errors returned by the get-version control-plane endpoint.

func EncodeGetVersionResponse 

func EncodeGetVersionResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeGetVersionResponse returns an encoder for responses returned by the control-plane get-version endpoint.

func EncodeInitClusterError 

func EncodeInitClusterError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeInitClusterError returns an encoder for errors returned by the init-cluster control-plane endpoint.

func EncodeInitClusterResponse 

func EncodeInitClusterResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeInitClusterResponse returns an encoder for responses returned by the control-plane init-cluster endpoint.

func EncodeJoinClusterError 

func EncodeJoinClusterError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeJoinClusterError returns an encoder for errors returned by the join-cluster control-plane endpoint.

func EncodeJoinClusterResponse 

func EncodeJoinClusterResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeJoinClusterResponse returns an encoder for responses returned by the control-plane join-cluster endpoint.

func EncodeListDatabaseTasksError 

func EncodeListDatabaseTasksError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeListDatabaseTasksError returns an encoder for errors returned by the list-database-tasks control-plane endpoint.

func EncodeListDatabaseTasksResponse 

func EncodeListDatabaseTasksResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeListDatabaseTasksResponse returns an encoder for responses returned by the control-plane list-database-tasks endpoint.

func EncodeListDatabasesError 

func EncodeListDatabasesError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeListDatabasesError returns an encoder for errors returned by the list-databases control-plane endpoint.

func EncodeListDatabasesResponse 

func EncodeListDatabasesResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeListDatabasesResponse returns an encoder for responses returned by the control-plane list-databases endpoint.

func EncodeListHostsError 

func EncodeListHostsError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeListHostsError returns an encoder for errors returned by the list-hosts control-plane endpoint.

func EncodeListHostsResponse 

func EncodeListHostsResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeListHostsResponse returns an encoder for responses returned by the control-plane list-hosts endpoint.

func EncodeRemoveHostError 

func EncodeRemoveHostError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeRemoveHostError returns an encoder for errors returned by the remove-host control-plane endpoint.

func EncodeRemoveHostResponse 

func EncodeRemoveHostResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeRemoveHostResponse returns an encoder for responses returned by the control-plane remove-host endpoint.

func EncodeRestartInstanceError 

func EncodeRestartInstanceError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeRestartInstanceError returns an encoder for errors returned by the restart-instance control-plane endpoint.

func EncodeRestartInstanceResponse 

func EncodeRestartInstanceResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeRestartInstanceResponse returns an encoder for responses returned by the control-plane restart-instance endpoint.

func EncodeRestoreDatabaseError 

func EncodeRestoreDatabaseError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeRestoreDatabaseError returns an encoder for errors returned by the restore-database control-plane endpoint.

func EncodeRestoreDatabaseResponse 

func EncodeRestoreDatabaseResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeRestoreDatabaseResponse returns an encoder for responses returned by the control-plane restore-database endpoint.

func EncodeStartInstanceError 

func EncodeStartInstanceError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeStartInstanceError returns an encoder for errors returned by the start-instance control-plane endpoint.

func EncodeStartInstanceResponse 

func EncodeStartInstanceResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeStartInstanceResponse returns an encoder for responses returned by the control-plane start-instance endpoint.

func EncodeStopInstanceError 

func EncodeStopInstanceError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeStopInstanceError returns an encoder for errors returned by the stop-instance control-plane endpoint.

func EncodeStopInstanceResponse 

func EncodeStopInstanceResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeStopInstanceResponse returns an encoder for responses returned by the control-plane stop-instance endpoint.

func EncodeSwitchoverDatabaseNodeError 

func EncodeSwitchoverDatabaseNodeError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeSwitchoverDatabaseNodeError returns an encoder for errors returned by the switchover-database-node control-plane endpoint.

func EncodeSwitchoverDatabaseNodeResponse 

func EncodeSwitchoverDatabaseNodeResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeSwitchoverDatabaseNodeResponse returns an encoder for responses returned by the control-plane switchover-database-node endpoint.

func EncodeUpdateDatabaseError 

func EncodeUpdateDatabaseError(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder, formatter func(ctx context.Context, err error) goahttp.Statuser) func(context.Context, http.ResponseWriter, error) error

EncodeUpdateDatabaseError returns an encoder for errors returned by the update-database control-plane endpoint.

func EncodeUpdateDatabaseResponse 

func EncodeUpdateDatabaseResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, any) error

EncodeUpdateDatabaseResponse returns an encoder for responses returned by the control-plane update-database endpoint.

func FailoverDatabaseNodeControlPlanePath 

func FailoverDatabaseNodeControlPlanePath(databaseID string, nodeName string) string

FailoverDatabaseNodeControlPlanePath returns the URL path to the control-plane service failover-database-node HTTP endpoint.

func GetClusterControlPlanePath 

func GetClusterControlPlanePath() string

GetClusterControlPlanePath returns the URL path to the control-plane service get-cluster HTTP endpoint.

func GetDatabaseControlPlanePath 

func GetDatabaseControlPlanePath(databaseID string) string

GetDatabaseControlPlanePath returns the URL path to the control-plane service get-database HTTP endpoint.

func GetDatabaseTaskControlPlanePath 

func GetDatabaseTaskControlPlanePath(databaseID string, taskID string) string

GetDatabaseTaskControlPlanePath returns the URL path to the control-plane service get-database-task HTTP endpoint.

func GetDatabaseTaskLogControlPlanePath 

func GetDatabaseTaskLogControlPlanePath(databaseID string, taskID string) string

GetDatabaseTaskLogControlPlanePath returns the URL path to the control-plane service get-database-task-log HTTP endpoint.

func GetHostControlPlanePath 

func GetHostControlPlanePath(hostID string) string

GetHostControlPlanePath returns the URL path to the control-plane service get-host HTTP endpoint.

func GetJoinOptionsControlPlanePath 

func GetJoinOptionsControlPlanePath() string

GetJoinOptionsControlPlanePath returns the URL path to the control-plane service get-join-options HTTP endpoint.

func GetJoinTokenControlPlanePath 

func GetJoinTokenControlPlanePath() string

GetJoinTokenControlPlanePath returns the URL path to the control-plane service get-join-token HTTP endpoint.

func GetVersionControlPlanePath 

func GetVersionControlPlanePath() string

GetVersionControlPlanePath returns the URL path to the control-plane service get-version HTTP endpoint.

func InitClusterControlPlanePath 

func InitClusterControlPlanePath() string

InitClusterControlPlanePath returns the URL path to the control-plane service init-cluster HTTP endpoint.

func JoinClusterControlPlanePath 

func JoinClusterControlPlanePath() string

JoinClusterControlPlanePath returns the URL path to the control-plane service join-cluster HTTP endpoint.

func ListDatabaseTasksControlPlanePath 

func ListDatabaseTasksControlPlanePath(databaseID string) string

ListDatabaseTasksControlPlanePath returns the URL path to the control-plane service list-database-tasks HTTP endpoint.

func ListDatabasesControlPlanePath 

func ListDatabasesControlPlanePath() string

ListDatabasesControlPlanePath returns the URL path to the control-plane service list-databases HTTP endpoint.

func ListHostsControlPlanePath 

func ListHostsControlPlanePath() string

ListHostsControlPlanePath returns the URL path to the control-plane service list-hosts HTTP endpoint.

func Mount 

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the control-plane endpoints.

func MountBackupDatabaseNodeHandler 

func MountBackupDatabaseNodeHandler(mux goahttp.Muxer, h http.Handler)

MountBackupDatabaseNodeHandler configures the mux to serve the "control-plane" service "backup-database-node" endpoint.

func MountCancelDatabaseTaskHandler 

func MountCancelDatabaseTaskHandler(mux goahttp.Muxer, h http.Handler)

MountCancelDatabaseTaskHandler configures the mux to serve the "control-plane" service "cancel-database-task" endpoint.

func MountCreateDatabaseHandler 

func MountCreateDatabaseHandler(mux goahttp.Muxer, h http.Handler)

MountCreateDatabaseHandler configures the mux to serve the "control-plane" service "create-database" endpoint.

func MountDeleteDatabaseHandler 

func MountDeleteDatabaseHandler(mux goahttp.Muxer, h http.Handler)

MountDeleteDatabaseHandler configures the mux to serve the "control-plane" service "delete-database" endpoint.

func MountFailoverDatabaseNodeHandler 

func MountFailoverDatabaseNodeHandler(mux goahttp.Muxer, h http.Handler)

MountFailoverDatabaseNodeHandler configures the mux to serve the "control-plane" service "failover-database-node" endpoint.

func MountGenHTTPOpenapi3JSON 

func MountGenHTTPOpenapi3JSON(mux goahttp.Muxer, h http.Handler)

MountGenHTTPOpenapi3JSON configures the mux to serve GET request made to "/v1/openapi.json".

func MountGetClusterHandler 

func MountGetClusterHandler(mux goahttp.Muxer, h http.Handler)

MountGetClusterHandler configures the mux to serve the "control-plane" service "get-cluster" endpoint.

func MountGetDatabaseHandler 

func MountGetDatabaseHandler(mux goahttp.Muxer, h http.Handler)

MountGetDatabaseHandler configures the mux to serve the "control-plane" service "get-database" endpoint.

func MountGetDatabaseTaskHandler 

func MountGetDatabaseTaskHandler(mux goahttp.Muxer, h http.Handler)

MountGetDatabaseTaskHandler configures the mux to serve the "control-plane" service "get-database-task" endpoint.

func MountGetDatabaseTaskLogHandler 

func MountGetDatabaseTaskLogHandler(mux goahttp.Muxer, h http.Handler)

MountGetDatabaseTaskLogHandler configures the mux to serve the "control-plane" service "get-database-task-log" endpoint.

func MountGetHostHandler 

func MountGetHostHandler(mux goahttp.Muxer, h http.Handler)

MountGetHostHandler configures the mux to serve the "control-plane" service "get-host" endpoint.

func MountGetJoinOptionsHandler 

func MountGetJoinOptionsHandler(mux goahttp.Muxer, h http.Handler)

MountGetJoinOptionsHandler configures the mux to serve the "control-plane" service "get-join-options" endpoint.

func MountGetJoinTokenHandler 

func MountGetJoinTokenHandler(mux goahttp.Muxer, h http.Handler)

MountGetJoinTokenHandler configures the mux to serve the "control-plane" service "get-join-token" endpoint.

func MountGetVersionHandler 

func MountGetVersionHandler(mux goahttp.Muxer, h http.Handler)

MountGetVersionHandler configures the mux to serve the "control-plane" service "get-version" endpoint.

func MountInitClusterHandler 

func MountInitClusterHandler(mux goahttp.Muxer, h http.Handler)

MountInitClusterHandler configures the mux to serve the "control-plane" service "init-cluster" endpoint.

func MountJoinClusterHandler 

func MountJoinClusterHandler(mux goahttp.Muxer, h http.Handler)

MountJoinClusterHandler configures the mux to serve the "control-plane" service "join-cluster" endpoint.

func MountListDatabaseTasksHandler 

func MountListDatabaseTasksHandler(mux goahttp.Muxer, h http.Handler)

MountListDatabaseTasksHandler configures the mux to serve the "control-plane" service "list-database-tasks" endpoint.

func MountListDatabasesHandler 

func MountListDatabasesHandler(mux goahttp.Muxer, h http.Handler)

MountListDatabasesHandler configures the mux to serve the "control-plane" service "list-databases" endpoint.

func MountListHostsHandler 

func MountListHostsHandler(mux goahttp.Muxer, h http.Handler)

MountListHostsHandler configures the mux to serve the "control-plane" service "list-hosts" endpoint.

func MountRemoveHostHandler 

func MountRemoveHostHandler(mux goahttp.Muxer, h http.Handler)

MountRemoveHostHandler configures the mux to serve the "control-plane" service "remove-host" endpoint.

func MountRestartInstanceHandler 

func MountRestartInstanceHandler(mux goahttp.Muxer, h http.Handler)

MountRestartInstanceHandler configures the mux to serve the "control-plane" service "restart-instance" endpoint.

func MountRestoreDatabaseHandler 

func MountRestoreDatabaseHandler(mux goahttp.Muxer, h http.Handler)

MountRestoreDatabaseHandler configures the mux to serve the "control-plane" service "restore-database" endpoint.

func MountStartInstanceHandler 

func MountStartInstanceHandler(mux goahttp.Muxer, h http.Handler)

MountStartInstanceHandler configures the mux to serve the "control-plane" service "start-instance" endpoint.

func MountStopInstanceHandler 

func MountStopInstanceHandler(mux goahttp.Muxer, h http.Handler)

MountStopInstanceHandler configures the mux to serve the "control-plane" service "stop-instance" endpoint.

func MountSwitchoverDatabaseNodeHandler 

func MountSwitchoverDatabaseNodeHandler(mux goahttp.Muxer, h http.Handler)

MountSwitchoverDatabaseNodeHandler configures the mux to serve the "control-plane" service "switchover-database-node" endpoint.

func MountUpdateDatabaseHandler 

func MountUpdateDatabaseHandler(mux goahttp.Muxer, h http.Handler)

MountUpdateDatabaseHandler configures the mux to serve the "control-plane" service "update-database" endpoint.

func NewBackupDatabaseNodeHandler 

func NewBackupDatabaseNodeHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewBackupDatabaseNodeHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "backup-database-node" endpoint.

func NewBackupDatabaseNodePayload 

func NewBackupDatabaseNodePayload(body *BackupDatabaseNodeRequestBody, databaseID string, nodeName string, force bool) *controlplane.BackupDatabaseNodePayload

NewBackupDatabaseNodePayload builds a control-plane service backup-database-node endpoint payload.

func NewCancelDatabaseTaskHandler 

func NewCancelDatabaseTaskHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewCancelDatabaseTaskHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "cancel-database-task" endpoint.

func NewCancelDatabaseTaskPayload 

func NewCancelDatabaseTaskPayload(databaseID string, taskID string) *controlplane.CancelDatabaseTaskPayload

NewCancelDatabaseTaskPayload builds a control-plane service cancel-database-task endpoint payload.

func NewCreateDatabaseHandler 

func NewCreateDatabaseHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewCreateDatabaseHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "create-database" endpoint.

func NewCreateDatabaseRequest 

func NewCreateDatabaseRequest(body *CreateDatabaseRequestBody) *controlplane.CreateDatabaseRequest

NewCreateDatabaseRequest builds a control-plane service create-database endpoint payload.

func NewDeleteDatabaseHandler 

func NewDeleteDatabaseHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewDeleteDatabaseHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "delete-database" endpoint.

func NewDeleteDatabasePayload 

func NewDeleteDatabasePayload(databaseID string, force bool) *controlplane.DeleteDatabasePayload

NewDeleteDatabasePayload builds a control-plane service delete-database endpoint payload.

func NewFailoverDatabaseNodeHandler 

func NewFailoverDatabaseNodeHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewFailoverDatabaseNodeHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "failover-database-node" endpoint.

func NewFailoverDatabaseNodeRequest 

func NewFailoverDatabaseNodeRequest(body *FailoverDatabaseNodeRequestBody, databaseID string, nodeName string) *controlplane.FailoverDatabaseNodeRequest

NewFailoverDatabaseNodeRequest builds a control-plane service failover-database-node endpoint payload.

func NewGetClusterHandler 

func NewGetClusterHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetClusterHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-cluster" endpoint.

func NewGetDatabaseHandler 

func NewGetDatabaseHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetDatabaseHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-database" endpoint.

func NewGetDatabasePayload 

func NewGetDatabasePayload(databaseID string) *controlplane.GetDatabasePayload

NewGetDatabasePayload builds a control-plane service get-database endpoint payload.

func NewGetDatabaseTaskHandler 

func NewGetDatabaseTaskHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetDatabaseTaskHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-database-task" endpoint.

func NewGetDatabaseTaskLogHandler 

func NewGetDatabaseTaskLogHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetDatabaseTaskLogHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-database-task-log" endpoint.

func NewGetDatabaseTaskLogPayload 

func NewGetDatabaseTaskLogPayload(databaseID string, taskID string, afterEntryID *string, limit *int) *controlplane.GetDatabaseTaskLogPayload

NewGetDatabaseTaskLogPayload builds a control-plane service get-database-task-log endpoint payload.

func NewGetDatabaseTaskPayload 

func NewGetDatabaseTaskPayload(databaseID string, taskID string) *controlplane.GetDatabaseTaskPayload

NewGetDatabaseTaskPayload builds a control-plane service get-database-task endpoint payload.

func NewGetHostHandler 

func NewGetHostHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetHostHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-host" endpoint.

func NewGetHostPayload 

func NewGetHostPayload(hostID string) *controlplane.GetHostPayload

NewGetHostPayload builds a control-plane service get-host endpoint payload.

func NewGetJoinOptionsClusterJoinRequest 

func NewGetJoinOptionsClusterJoinRequest(body *GetJoinOptionsRequestBody) *controlplane.ClusterJoinRequest

NewGetJoinOptionsClusterJoinRequest builds a control-plane service get-join-options endpoint payload.

func NewGetJoinOptionsHandler 

func NewGetJoinOptionsHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetJoinOptionsHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-join-options" endpoint.

func NewGetJoinTokenHandler 

func NewGetJoinTokenHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetJoinTokenHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-join-token" endpoint.

func NewGetVersionHandler 

func NewGetVersionHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewGetVersionHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "get-version" endpoint.

func NewInitClusterHandler 

func NewInitClusterHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewInitClusterHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "init-cluster" endpoint.

func NewInitClusterRequest 

func NewInitClusterRequest(clusterID *string) *controlplane.InitClusterRequest

NewInitClusterRequest builds a control-plane service init-cluster endpoint payload.

func NewJoinClusterClusterJoinToken 

func NewJoinClusterClusterJoinToken(body *JoinClusterRequestBody) *controlplane.ClusterJoinToken

NewJoinClusterClusterJoinToken builds a control-plane service join-cluster endpoint payload.

func NewJoinClusterHandler 

func NewJoinClusterHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewJoinClusterHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "join-cluster" endpoint.

func NewListDatabaseTasksHandler 

func NewListDatabaseTasksHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewListDatabaseTasksHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "list-database-tasks" endpoint.

func NewListDatabaseTasksPayload 

func NewListDatabaseTasksPayload(databaseID string, afterTaskID *string, limit *int, sortOrder *string) *controlplane.ListDatabaseTasksPayload

NewListDatabaseTasksPayload builds a control-plane service list-database-tasks endpoint payload.

func NewListDatabasesHandler 

func NewListDatabasesHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewListDatabasesHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "list-databases" endpoint.

func NewListHostsHandler 

func NewListHostsHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewListHostsHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "list-hosts" endpoint.

func NewRemoveHostHandler 

func NewRemoveHostHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewRemoveHostHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "remove-host" endpoint.

func NewRemoveHostPayload 

func NewRemoveHostPayload(hostID string, force bool) *controlplane.RemoveHostPayload

NewRemoveHostPayload builds a control-plane service remove-host endpoint payload.

func NewRestartInstanceHandler 

func NewRestartInstanceHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewRestartInstanceHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "restart-instance" endpoint.

func NewRestartInstancePayload 

func NewRestartInstancePayload(body struct {
	// The time at which the restart is scheduled.
	ScheduledAt *string `form:"scheduled_at" json:"scheduled_at" xml:"scheduled_at"`
}, databaseID string, instanceID string) *controlplane.RestartInstancePayload

NewRestartInstancePayload builds a control-plane service restart-instance endpoint payload.

func NewRestoreDatabaseHandler 

func NewRestoreDatabaseHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewRestoreDatabaseHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "restore-database" endpoint.

func NewRestoreDatabasePayload 

func NewRestoreDatabasePayload(body *RestoreDatabaseRequestBody, databaseID string, force bool) *controlplane.RestoreDatabasePayload

NewRestoreDatabasePayload builds a control-plane service restore-database endpoint payload.

func NewStartInstanceHandler 

func NewStartInstanceHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewStartInstanceHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "start-instance" endpoint.

func NewStartInstancePayload 

func NewStartInstancePayload(databaseID string, instanceID string, force bool) *controlplane.StartInstancePayload

NewStartInstancePayload builds a control-plane service start-instance endpoint payload.

func NewStopInstanceHandler 

func NewStopInstanceHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewStopInstanceHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "stop-instance" endpoint.

func NewStopInstancePayload 

func NewStopInstancePayload(databaseID string, instanceID string, force bool) *controlplane.StopInstancePayload

NewStopInstancePayload builds a control-plane service stop-instance endpoint payload.

func NewSwitchoverDatabaseNodeHandler 

func NewSwitchoverDatabaseNodeHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewSwitchoverDatabaseNodeHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "switchover-database-node" endpoint.

func NewSwitchoverDatabaseNodePayload 

func NewSwitchoverDatabaseNodePayload(body *SwitchoverDatabaseNodeRequestBody, databaseID string, nodeName string) *controlplane.SwitchoverDatabaseNodePayload

NewSwitchoverDatabaseNodePayload builds a control-plane service switchover-database-node endpoint payload.

func NewUpdateDatabaseHandler 

func NewUpdateDatabaseHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
) http.Handler

NewUpdateDatabaseHandler creates a HTTP handler which loads the HTTP request and calls the "control-plane" service "update-database" endpoint.

func NewUpdateDatabasePayload 

func NewUpdateDatabasePayload(body *UpdateDatabaseRequestBody, databaseID string, forceUpdate bool) *controlplane.UpdateDatabasePayload

NewUpdateDatabasePayload builds a control-plane service update-database endpoint payload.

func RemoveHostControlPlanePath 

func RemoveHostControlPlanePath(hostID string) string

RemoveHostControlPlanePath returns the URL path to the control-plane service remove-host HTTP endpoint.

func RestartInstanceControlPlanePath 

func RestartInstanceControlPlanePath(databaseID string, instanceID string) string

RestartInstanceControlPlanePath returns the URL path to the control-plane service restart-instance HTTP endpoint.

func RestoreDatabaseControlPlanePath 

func RestoreDatabaseControlPlanePath(databaseID string) string

RestoreDatabaseControlPlanePath returns the URL path to the control-plane service restore-database HTTP endpoint.

func StartInstanceControlPlanePath 

func StartInstanceControlPlanePath(databaseID string, instanceID string) string

StartInstanceControlPlanePath returns the URL path to the control-plane service start-instance HTTP endpoint.

func StopInstanceControlPlanePath 

func StopInstanceControlPlanePath(databaseID string, instanceID string) string

StopInstanceControlPlanePath returns the URL path to the control-plane service stop-instance HTTP endpoint.

func SwitchoverDatabaseNodeControlPlanePath 

func SwitchoverDatabaseNodeControlPlanePath(databaseID string, nodeName string) string

SwitchoverDatabaseNodeControlPlanePath returns the URL path to the control-plane service switchover-database-node HTTP endpoint.

func UpdateDatabaseControlPlanePath 

func UpdateDatabaseControlPlanePath(databaseID string) string

UpdateDatabaseControlPlanePath returns the URL path to the control-plane service update-database HTTP endpoint.

func ValidateBackupConfigSpecRequestBody 

func ValidateBackupConfigSpecRequestBody(body *BackupConfigSpecRequestBody) (err error)

ValidateBackupConfigSpecRequestBody runs the validations defined on BackupConfigSpecRequestBody

func ValidateBackupConfigSpecRequestBodyRequestBody 

func ValidateBackupConfigSpecRequestBodyRequestBody(body *BackupConfigSpecRequestBodyRequestBody) (err error)

ValidateBackupConfigSpecRequestBodyRequestBody runs the validations defined on BackupConfigSpecRequestBodyRequestBody

func ValidateBackupDatabaseNodeRequestBody 

func ValidateBackupDatabaseNodeRequestBody(body *BackupDatabaseNodeRequestBody) (err error)

ValidateBackupDatabaseNodeRequestBody runs the validations defined on Backup-Database-NodeRequestBody

func ValidateBackupRepositorySpecRequestBody 

func ValidateBackupRepositorySpecRequestBody(body *BackupRepositorySpecRequestBody) (err error)

ValidateBackupRepositorySpecRequestBody runs the validations defined on BackupRepositorySpecRequestBody

func ValidateBackupRepositorySpecRequestBodyRequestBody 

func ValidateBackupRepositorySpecRequestBodyRequestBody(body *BackupRepositorySpecRequestBodyRequestBody) (err error)

ValidateBackupRepositorySpecRequestBodyRequestBody runs the validations defined on BackupRepositorySpecRequestBodyRequestBody

func ValidateBackupScheduleSpecRequestBody 

func ValidateBackupScheduleSpecRequestBody(body *BackupScheduleSpecRequestBody) (err error)

ValidateBackupScheduleSpecRequestBody runs the validations defined on BackupScheduleSpecRequestBody

func ValidateBackupScheduleSpecRequestBodyRequestBody 

func ValidateBackupScheduleSpecRequestBodyRequestBody(body *BackupScheduleSpecRequestBodyRequestBody) (err error)

ValidateBackupScheduleSpecRequestBodyRequestBody runs the validations defined on BackupScheduleSpecRequestBodyRequestBody

func ValidateCreateDatabaseRequestBody 

func ValidateCreateDatabaseRequestBody(body *CreateDatabaseRequestBody) (err error)

ValidateCreateDatabaseRequestBody runs the validations defined on Create-DatabaseRequestBody

func ValidateDatabaseNodeSpecRequestBody 

func ValidateDatabaseNodeSpecRequestBody(body *DatabaseNodeSpecRequestBody) (err error)

ValidateDatabaseNodeSpecRequestBody runs the validations defined on DatabaseNodeSpecRequestBody

func ValidateDatabaseNodeSpecRequestBodyRequestBody 

func ValidateDatabaseNodeSpecRequestBodyRequestBody(body *DatabaseNodeSpecRequestBodyRequestBody) (err error)

ValidateDatabaseNodeSpecRequestBodyRequestBody runs the validations defined on DatabaseNodeSpecRequestBodyRequestBody

func ValidateDatabaseSpecRequestBody 

func ValidateDatabaseSpecRequestBody(body *DatabaseSpecRequestBody) (err error)

ValidateDatabaseSpecRequestBody runs the validations defined on DatabaseSpecRequestBody

func ValidateDatabaseSpecRequestBodyRequestBody 

func ValidateDatabaseSpecRequestBodyRequestBody(body *DatabaseSpecRequestBodyRequestBody) (err error)

ValidateDatabaseSpecRequestBodyRequestBody runs the validations defined on DatabaseSpecRequestBodyRequestBody

func ValidateDatabaseUserSpecRequestBody 

func ValidateDatabaseUserSpecRequestBody(body *DatabaseUserSpecRequestBody) (err error)

ValidateDatabaseUserSpecRequestBody runs the validations defined on DatabaseUserSpecRequestBody

func ValidateDatabaseUserSpecRequestBodyRequestBody 

func ValidateDatabaseUserSpecRequestBodyRequestBody(body *DatabaseUserSpecRequestBodyRequestBody) (err error)

ValidateDatabaseUserSpecRequestBodyRequestBody runs the validations defined on DatabaseUserSpecRequestBodyRequestBody

func ValidateExtraNetworkSpecRequestBody 

func ValidateExtraNetworkSpecRequestBody(body *ExtraNetworkSpecRequestBody) (err error)

ValidateExtraNetworkSpecRequestBody runs the validations defined on ExtraNetworkSpecRequestBody

func ValidateExtraNetworkSpecRequestBodyRequestBody 

func ValidateExtraNetworkSpecRequestBodyRequestBody(body *ExtraNetworkSpecRequestBodyRequestBody) (err error)

ValidateExtraNetworkSpecRequestBodyRequestBody runs the validations defined on ExtraNetworkSpecRequestBodyRequestBody

func ValidateExtraVolumesSpecRequestBody 

func ValidateExtraVolumesSpecRequestBody(body *ExtraVolumesSpecRequestBody) (err error)

ValidateExtraVolumesSpecRequestBody runs the validations defined on ExtraVolumesSpecRequestBody

func ValidateExtraVolumesSpecRequestBodyRequestBody 

func ValidateExtraVolumesSpecRequestBodyRequestBody(body *ExtraVolumesSpecRequestBodyRequestBody) (err error)

ValidateExtraVolumesSpecRequestBodyRequestBody runs the validations defined on ExtraVolumesSpecRequestBodyRequestBody

func ValidateGetJoinOptionsRequestBody 

func ValidateGetJoinOptionsRequestBody(body *GetJoinOptionsRequestBody) (err error)

ValidateGetJoinOptionsRequestBody runs the validations defined on Get-Join-OptionsRequestBody

func ValidateJoinClusterRequestBody 

func ValidateJoinClusterRequestBody(body *JoinClusterRequestBody) (err error)

ValidateJoinClusterRequestBody runs the validations defined on Join-ClusterRequestBody

func ValidateOrchestratorOptsRequestBody 

func ValidateOrchestratorOptsRequestBody(body *OrchestratorOptsRequestBody) (err error)

ValidateOrchestratorOptsRequestBody runs the validations defined on OrchestratorOptsRequestBody

func ValidateOrchestratorOptsRequestBodyRequestBody 

func ValidateOrchestratorOptsRequestBodyRequestBody(body *OrchestratorOptsRequestBodyRequestBody) (err error)

ValidateOrchestratorOptsRequestBodyRequestBody runs the validations defined on OrchestratorOptsRequestBodyRequestBody

func ValidateRestoreConfigSpecRequestBody 

func ValidateRestoreConfigSpecRequestBody(body *RestoreConfigSpecRequestBody) (err error)

ValidateRestoreConfigSpecRequestBody runs the validations defined on RestoreConfigSpecRequestBody

func ValidateRestoreConfigSpecRequestBodyRequestBody 

func ValidateRestoreConfigSpecRequestBodyRequestBody(body *RestoreConfigSpecRequestBodyRequestBody) (err error)

ValidateRestoreConfigSpecRequestBodyRequestBody runs the validations defined on RestoreConfigSpecRequestBodyRequestBody

func ValidateRestoreDatabaseRequestBody 

func ValidateRestoreDatabaseRequestBody(body *RestoreDatabaseRequestBody) (err error)

ValidateRestoreDatabaseRequestBody runs the validations defined on Restore-DatabaseRequestBody

func ValidateRestoreRepositorySpecRequestBody 

func ValidateRestoreRepositorySpecRequestBody(body *RestoreRepositorySpecRequestBody) (err error)

ValidateRestoreRepositorySpecRequestBody runs the validations defined on RestoreRepositorySpecRequestBody

func ValidateRestoreRepositorySpecRequestBodyRequestBody 

func ValidateRestoreRepositorySpecRequestBodyRequestBody(body *RestoreRepositorySpecRequestBodyRequestBody) (err error)

ValidateRestoreRepositorySpecRequestBodyRequestBody runs the validations defined on RestoreRepositorySpecRequestBodyRequestBody

func ValidateSwarmOptsRequestBody 

func ValidateSwarmOptsRequestBody(body *SwarmOptsRequestBody) (err error)

ValidateSwarmOptsRequestBody runs the validations defined on SwarmOptsRequestBody

func ValidateSwarmOptsRequestBodyRequestBody 

func ValidateSwarmOptsRequestBodyRequestBody(body *SwarmOptsRequestBodyRequestBody) (err error)

ValidateSwarmOptsRequestBodyRequestBody runs the validations defined on SwarmOptsRequestBodyRequestBody

func ValidateSwitchoverDatabaseNodeRequestBody 

func ValidateSwitchoverDatabaseNodeRequestBody(body *SwitchoverDatabaseNodeRequestBody) (err error)

ValidateSwitchoverDatabaseNodeRequestBody runs the validations defined on Switchover-Database-NodeRequestBody

func ValidateUpdateDatabaseRequestBody 

func ValidateUpdateDatabaseRequestBody(body *UpdateDatabaseRequestBody) (err error)

ValidateUpdateDatabaseRequestBody runs the validations defined on Update-DatabaseRequestBody

Types

type BackupConfigSpecRequestBody 

type BackupConfigSpecRequestBody struct {
	// The repositories for this backup configuration.
	Repositories []*BackupRepositorySpecRequestBody `form:"repositories,omitempty" json:"repositories,omitempty" xml:"repositories,omitempty"`
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecRequestBody `form:"schedules,omitempty" json:"schedules,omitempty" xml:"schedules,omitempty"`
}

BackupConfigSpecRequestBody is used to define fields on request body types.

type BackupConfigSpecRequestBodyRequestBody 

type BackupConfigSpecRequestBodyRequestBody struct {
	// The repositories for this backup configuration.
	Repositories []*BackupRepositorySpecRequestBodyRequestBody `form:"repositories,omitempty" json:"repositories,omitempty" xml:"repositories,omitempty"`
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecRequestBodyRequestBody `form:"schedules,omitempty" json:"schedules,omitempty" xml:"schedules,omitempty"`
}

BackupConfigSpecRequestBodyRequestBody is used to define fields on request body types.

type BackupConfigSpecResponseBody 

type BackupConfigSpecResponseBody struct {
	// The repositories for this backup configuration.
	Repositories []*BackupRepositorySpecResponseBody `form:"repositories" json:"repositories" xml:"repositories"`
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecResponseBody `form:"schedules,omitempty" json:"schedules,omitempty" xml:"schedules,omitempty"`
}

BackupConfigSpecResponseBody is used to define fields on response body types.

type BackupDatabaseNodeClusterNotInitializedResponseBody 

type BackupDatabaseNodeClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

BackupDatabaseNodeClusterNotInitializedResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewBackupDatabaseNodeClusterNotInitializedResponseBody 

func NewBackupDatabaseNodeClusterNotInitializedResponseBody(res *controlplane.APIError) *BackupDatabaseNodeClusterNotInitializedResponseBody

NewBackupDatabaseNodeClusterNotInitializedResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeDatabaseNotModifiableResponseBody 

type BackupDatabaseNodeDatabaseNotModifiableResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

BackupDatabaseNodeDatabaseNotModifiableResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body for the "database_not_modifiable" error.

func NewBackupDatabaseNodeDatabaseNotModifiableResponseBody 

func NewBackupDatabaseNodeDatabaseNotModifiableResponseBody(res *controlplane.APIError) *BackupDatabaseNodeDatabaseNotModifiableResponseBody

NewBackupDatabaseNodeDatabaseNotModifiableResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeInvalidInputResponseBody 

type BackupDatabaseNodeInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

BackupDatabaseNodeInvalidInputResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body for the "invalid_input" error.

func NewBackupDatabaseNodeInvalidInputResponseBody 

func NewBackupDatabaseNodeInvalidInputResponseBody(res *controlplane.APIError) *BackupDatabaseNodeInvalidInputResponseBody

NewBackupDatabaseNodeInvalidInputResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeNotFoundResponseBody 

type BackupDatabaseNodeNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

BackupDatabaseNodeNotFoundResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body for the "not_found" error.

func NewBackupDatabaseNodeNotFoundResponseBody 

func NewBackupDatabaseNodeNotFoundResponseBody(res *controlplane.APIError) *BackupDatabaseNodeNotFoundResponseBody

NewBackupDatabaseNodeNotFoundResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeOperationAlreadyInProgressResponseBody 

type BackupDatabaseNodeOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

BackupDatabaseNodeOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewBackupDatabaseNodeOperationAlreadyInProgressResponseBody 

func NewBackupDatabaseNodeOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *BackupDatabaseNodeOperationAlreadyInProgressResponseBody

NewBackupDatabaseNodeOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeRequestBody 

type BackupDatabaseNodeRequestBody struct {
	// The type of backup.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// Annotations for the backup.
	Annotations map[string]string `form:"annotations,omitempty" json:"annotations,omitempty" xml:"annotations,omitempty"`
	// Options for the backup.
	BackupOptions map[string]string `form:"backup_options,omitempty" json:"backup_options,omitempty" xml:"backup_options,omitempty"`
}

BackupDatabaseNodeRequestBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP request body.

type BackupDatabaseNodeResponseBody 

type BackupDatabaseNodeResponseBody struct {
	// The task that will backup this database node.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

BackupDatabaseNodeResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body.

func NewBackupDatabaseNodeResponseBody 

func NewBackupDatabaseNodeResponseBody(res *controlplane.BackupDatabaseNodeResponse) *BackupDatabaseNodeResponseBody

NewBackupDatabaseNodeResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeServerErrorResponseBody 

type BackupDatabaseNodeServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

BackupDatabaseNodeServerErrorResponseBody is the type of the "control-plane" service "backup-database-node" endpoint HTTP response body for the "server_error" error.

func NewBackupDatabaseNodeServerErrorResponseBody 

func NewBackupDatabaseNodeServerErrorResponseBody(res *controlplane.APIError) *BackupDatabaseNodeServerErrorResponseBody

NewBackupDatabaseNodeServerErrorResponseBody builds the HTTP response body from the result of the "backup-database-node" endpoint of the "control-plane" service.

type BackupRepositorySpecRequestBody 

type BackupRepositorySpecRequestBody struct {
	// The unique identifier of this repository.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of this repository.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `form:"s3_bucket,omitempty" json:"s3_bucket,omitempty" xml:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `form:"s3_region,omitempty" json:"s3_region,omitempty" xml:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `form:"s3_endpoint,omitempty" json:"s3_endpoint,omitempty" xml:"s3_endpoint,omitempty"`
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain. This field will
	// be excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	S3Key *string `form:"s3_key,omitempty" json:"s3_key,omitempty" xml:"s3_key,omitempty"`
	// The corresponding secret for the AWS access key ID in s3_key. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	S3KeySecret *string `form:"s3_key_secret,omitempty" json:"s3_key_secret,omitempty" xml:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `form:"gcs_bucket,omitempty" json:"gcs_bucket,omitempty" xml:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `form:"gcs_endpoint,omitempty" json:"gcs_endpoint,omitempty" xml:"gcs_endpoint,omitempty"`
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile. This field will be
	// excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	GcsKey *string `form:"gcs_key,omitempty" json:"gcs_key,omitempty" xml:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `form:"azure_account,omitempty" json:"azure_account,omitempty" xml:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `form:"azure_container,omitempty" json:"azure_container,omitempty" xml:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `form:"azure_endpoint,omitempty" json:"azure_endpoint,omitempty" xml:"azure_endpoint,omitempty"`
	// The Azure storage account access key to use for this repository. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	AzureKey *string `form:"azure_key,omitempty" json:"azure_key,omitempty" xml:"azure_key,omitempty"`
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int `form:"retention_full,omitempty" json:"retention_full,omitempty" xml:"retention_full,omitempty"`
	// The type of measure used for retention_full.
	RetentionFullType *string `form:"retention_full_type,omitempty" json:"retention_full_type,omitempty" xml:"retention_full_type,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `form:"base_path,omitempty" json:"base_path,omitempty" xml:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `form:"custom_options,omitempty" json:"custom_options,omitempty" xml:"custom_options,omitempty"`
}

BackupRepositorySpecRequestBody is used to define fields on request body types.

type BackupRepositorySpecRequestBodyRequestBody 

type BackupRepositorySpecRequestBodyRequestBody struct {
	// The unique identifier of this repository.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of this repository.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `form:"s3_bucket,omitempty" json:"s3_bucket,omitempty" xml:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `form:"s3_region,omitempty" json:"s3_region,omitempty" xml:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `form:"s3_endpoint,omitempty" json:"s3_endpoint,omitempty" xml:"s3_endpoint,omitempty"`
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain. This field will
	// be excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	S3Key *string `form:"s3_key,omitempty" json:"s3_key,omitempty" xml:"s3_key,omitempty"`
	// The corresponding secret for the AWS access key ID in s3_key. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	S3KeySecret *string `form:"s3_key_secret,omitempty" json:"s3_key_secret,omitempty" xml:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `form:"gcs_bucket,omitempty" json:"gcs_bucket,omitempty" xml:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `form:"gcs_endpoint,omitempty" json:"gcs_endpoint,omitempty" xml:"gcs_endpoint,omitempty"`
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile. This field will be
	// excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	GcsKey *string `form:"gcs_key,omitempty" json:"gcs_key,omitempty" xml:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `form:"azure_account,omitempty" json:"azure_account,omitempty" xml:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `form:"azure_container,omitempty" json:"azure_container,omitempty" xml:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `form:"azure_endpoint,omitempty" json:"azure_endpoint,omitempty" xml:"azure_endpoint,omitempty"`
	// The Azure storage account access key to use for this repository. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	AzureKey *string `form:"azure_key,omitempty" json:"azure_key,omitempty" xml:"azure_key,omitempty"`
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int `form:"retention_full,omitempty" json:"retention_full,omitempty" xml:"retention_full,omitempty"`
	// The type of measure used for retention_full.
	RetentionFullType *string `form:"retention_full_type,omitempty" json:"retention_full_type,omitempty" xml:"retention_full_type,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `form:"base_path,omitempty" json:"base_path,omitempty" xml:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `form:"custom_options,omitempty" json:"custom_options,omitempty" xml:"custom_options,omitempty"`
}

BackupRepositorySpecRequestBodyRequestBody is used to define fields on request body types.

type BackupRepositorySpecResponseBody 

type BackupRepositorySpecResponseBody struct {
	// The unique identifier of this repository.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of this repository.
	Type string `form:"type" json:"type" xml:"type"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `form:"s3_bucket,omitempty" json:"s3_bucket,omitempty" xml:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `form:"s3_region,omitempty" json:"s3_region,omitempty" xml:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `form:"s3_endpoint,omitempty" json:"s3_endpoint,omitempty" xml:"s3_endpoint,omitempty"`
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain. This field will
	// be excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	S3Key *string `form:"s3_key,omitempty" json:"s3_key,omitempty" xml:"s3_key,omitempty"`
	// The corresponding secret for the AWS access key ID in s3_key. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	S3KeySecret *string `form:"s3_key_secret,omitempty" json:"s3_key_secret,omitempty" xml:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `form:"gcs_bucket,omitempty" json:"gcs_bucket,omitempty" xml:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `form:"gcs_endpoint,omitempty" json:"gcs_endpoint,omitempty" xml:"gcs_endpoint,omitempty"`
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile. This field will be
	// excluded from the response of all endpoints. It can also be omitted from
	// update requests to keep the current value.
	GcsKey *string `form:"gcs_key,omitempty" json:"gcs_key,omitempty" xml:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `form:"azure_account,omitempty" json:"azure_account,omitempty" xml:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `form:"azure_container,omitempty" json:"azure_container,omitempty" xml:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `form:"azure_endpoint,omitempty" json:"azure_endpoint,omitempty" xml:"azure_endpoint,omitempty"`
	// The Azure storage account access key to use for this repository. This field
	// will be excluded from the response of all endpoints. It can also be omitted
	// from update requests to keep the current value.
	AzureKey *string `form:"azure_key,omitempty" json:"azure_key,omitempty" xml:"azure_key,omitempty"`
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int `form:"retention_full,omitempty" json:"retention_full,omitempty" xml:"retention_full,omitempty"`
	// The type of measure used for retention_full.
	RetentionFullType *string `form:"retention_full_type,omitempty" json:"retention_full_type,omitempty" xml:"retention_full_type,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `form:"base_path,omitempty" json:"base_path,omitempty" xml:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `form:"custom_options,omitempty" json:"custom_options,omitempty" xml:"custom_options,omitempty"`
}

BackupRepositorySpecResponseBody is used to define fields on response body types.

type BackupScheduleSpecRequestBody 

type BackupScheduleSpecRequestBody struct {
	// The unique identifier for this backup schedule.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of backup to take on this schedule.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// The cron expression for this schedule.
	CronExpression *string `form:"cron_expression,omitempty" json:"cron_expression,omitempty" xml:"cron_expression,omitempty"`
}

BackupScheduleSpecRequestBody is used to define fields on request body types.

type BackupScheduleSpecRequestBodyRequestBody 

type BackupScheduleSpecRequestBodyRequestBody struct {
	// The unique identifier for this backup schedule.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of backup to take on this schedule.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// The cron expression for this schedule.
	CronExpression *string `form:"cron_expression,omitempty" json:"cron_expression,omitempty" xml:"cron_expression,omitempty"`
}

BackupScheduleSpecRequestBodyRequestBody is used to define fields on request body types.

type BackupScheduleSpecResponseBody 

type BackupScheduleSpecResponseBody struct {
	// The unique identifier for this backup schedule.
	ID string `form:"id" json:"id" xml:"id"`
	// The type of backup to take on this schedule.
	Type string `form:"type" json:"type" xml:"type"`
	// The cron expression for this schedule.
	CronExpression string `form:"cron_expression" json:"cron_expression" xml:"cron_expression"`
}

BackupScheduleSpecResponseBody is used to define fields on response body types.

type CancelDatabaseTaskInvalidInputResponseBody 

type CancelDatabaseTaskInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CancelDatabaseTaskInvalidInputResponseBody is the type of the "control-plane" service "cancel-database-task" endpoint HTTP response body for the "invalid_input" error.

func NewCancelDatabaseTaskInvalidInputResponseBody 

func NewCancelDatabaseTaskInvalidInputResponseBody(res *controlplane.APIError) *CancelDatabaseTaskInvalidInputResponseBody

NewCancelDatabaseTaskInvalidInputResponseBody builds the HTTP response body from the result of the "cancel-database-task" endpoint of the "control-plane" service.

type CancelDatabaseTaskNotFoundResponseBody 

type CancelDatabaseTaskNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CancelDatabaseTaskNotFoundResponseBody is the type of the "control-plane" service "cancel-database-task" endpoint HTTP response body for the "not_found" error.

func NewCancelDatabaseTaskNotFoundResponseBody 

func NewCancelDatabaseTaskNotFoundResponseBody(res *controlplane.APIError) *CancelDatabaseTaskNotFoundResponseBody

NewCancelDatabaseTaskNotFoundResponseBody builds the HTTP response body from the result of the "cancel-database-task" endpoint of the "control-plane" service.

type CancelDatabaseTaskResponseBody 

type CancelDatabaseTaskResponseBody struct {
	// The parent task ID of the task.
	ParentID *string `form:"parent_id,omitempty" json:"parent_id,omitempty" xml:"parent_id,omitempty"`
	// The database ID of the task.
	DatabaseID string `form:"database_id" json:"database_id" xml:"database_id"`
	// The name of the node that the task is operating on.
	NodeName *string `form:"node_name,omitempty" json:"node_name,omitempty" xml:"node_name,omitempty"`
	// The ID of the instance that the task is operating on.
	InstanceID *string `form:"instance_id,omitempty" json:"instance_id,omitempty" xml:"instance_id,omitempty"`
	// The ID of the host that the task is running on.
	HostID *string `form:"host_id,omitempty" json:"host_id,omitempty" xml:"host_id,omitempty"`
	// The unique ID of the task.
	TaskID string `form:"task_id" json:"task_id" xml:"task_id"`
	// The time when the task was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time when the task was completed.
	CompletedAt *string `form:"completed_at,omitempty" json:"completed_at,omitempty" xml:"completed_at,omitempty"`
	// The type of the task.
	Type string `form:"type" json:"type" xml:"type"`
	// The status of the task.
	Status string `form:"status" json:"status" xml:"status"`
	// The error message if the task failed.
	Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"`
}

CancelDatabaseTaskResponseBody is the type of the "control-plane" service "cancel-database-task" endpoint HTTP response body.

func NewCancelDatabaseTaskResponseBody 

func NewCancelDatabaseTaskResponseBody(res *controlplane.Task) *CancelDatabaseTaskResponseBody

NewCancelDatabaseTaskResponseBody builds the HTTP response body from the result of the "cancel-database-task" endpoint of the "control-plane" service.

type CancelDatabaseTaskServerErrorResponseBody 

type CancelDatabaseTaskServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CancelDatabaseTaskServerErrorResponseBody is the type of the "control-plane" service "cancel-database-task" endpoint HTTP response body for the "server_error" error.

func NewCancelDatabaseTaskServerErrorResponseBody 

func NewCancelDatabaseTaskServerErrorResponseBody(res *controlplane.APIError) *CancelDatabaseTaskServerErrorResponseBody

NewCancelDatabaseTaskServerErrorResponseBody builds the HTTP response body from the result of the "cancel-database-task" endpoint of the "control-plane" service.

type ClusterCredentialsResponseBody 

type ClusterCredentialsResponseBody struct {
	// The Etcd username for the new host.
	Username string `form:"username" json:"username" xml:"username"`
	// The Etcd password for the new host.
	Password string `form:"password" json:"password" xml:"password"`
	// The base64-encoded CA certificate for the cluster.
	CaCert string `form:"ca_cert" json:"ca_cert" xml:"ca_cert"`
	// The base64-encoded etcd client certificate for the new cluster member.
	ClientCert string `form:"client_cert" json:"client_cert" xml:"client_cert"`
	// The base64-encoded etcd client key for the new cluster member.
	ClientKey string `form:"client_key" json:"client_key" xml:"client_key"`
	// The base64-encoded etcd server certificate for the new cluster member.
	ServerCert string `form:"server_cert" json:"server_cert" xml:"server_cert"`
	// The base64-encoded etcd server key for the new cluster member.
	ServerKey string `form:"server_key" json:"server_key" xml:"server_key"`
}

ClusterCredentialsResponseBody is used to define fields on response body types.

type ClusterStatusResponseBody 

type ClusterStatusResponseBody struct {
	// The current state of the cluster.
	State string `form:"state" json:"state" xml:"state"`
}

ClusterStatusResponseBody is used to define fields on response body types.

type ComponentStatusResponseBody 

type ComponentStatusResponseBody struct {
	// Indicates if the component is healthy.
	Healthy bool `form:"healthy" json:"healthy" xml:"healthy"`
	// Error message from any errors that occurred during the health check.
	Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"`
	// Additional details about the component.
	Details map[string]any `form:"details,omitempty" json:"details,omitempty" xml:"details,omitempty"`
}

ComponentStatusResponseBody is used to define fields on response body types.

type CreateDatabaseClusterNotInitializedResponseBody 

type CreateDatabaseClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CreateDatabaseClusterNotInitializedResponseBody is the type of the "control-plane" service "create-database" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewCreateDatabaseClusterNotInitializedResponseBody 

func NewCreateDatabaseClusterNotInitializedResponseBody(res *controlplane.APIError) *CreateDatabaseClusterNotInitializedResponseBody

NewCreateDatabaseClusterNotInitializedResponseBody builds the HTTP response body from the result of the "create-database" endpoint of the "control-plane" service.

type CreateDatabaseDatabaseAlreadyExistsResponseBody 

type CreateDatabaseDatabaseAlreadyExistsResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CreateDatabaseDatabaseAlreadyExistsResponseBody is the type of the "control-plane" service "create-database" endpoint HTTP response body for the "database_already_exists" error.

func NewCreateDatabaseDatabaseAlreadyExistsResponseBody 

func NewCreateDatabaseDatabaseAlreadyExistsResponseBody(res *controlplane.APIError) *CreateDatabaseDatabaseAlreadyExistsResponseBody

NewCreateDatabaseDatabaseAlreadyExistsResponseBody builds the HTTP response body from the result of the "create-database" endpoint of the "control-plane" service.

type CreateDatabaseInvalidInputResponseBody 

type CreateDatabaseInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CreateDatabaseInvalidInputResponseBody is the type of the "control-plane" service "create-database" endpoint HTTP response body for the "invalid_input" error.

func NewCreateDatabaseInvalidInputResponseBody 

func NewCreateDatabaseInvalidInputResponseBody(res *controlplane.APIError) *CreateDatabaseInvalidInputResponseBody

NewCreateDatabaseInvalidInputResponseBody builds the HTTP response body from the result of the "create-database" endpoint of the "control-plane" service.

type CreateDatabaseOperationAlreadyInProgressResponseBody 

type CreateDatabaseOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CreateDatabaseOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "create-database" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewCreateDatabaseOperationAlreadyInProgressResponseBody 

func NewCreateDatabaseOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *CreateDatabaseOperationAlreadyInProgressResponseBody

NewCreateDatabaseOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "create-database" endpoint of the "control-plane" service.

type CreateDatabaseRequestBody 

type CreateDatabaseRequestBody struct {
	// Unique identifier for the database.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Unique identifier for the databases's owner.
	TenantID *string `form:"tenant_id,omitempty" json:"tenant_id,omitempty" xml:"tenant_id,omitempty"`
	// The specification for the database.
	Spec *DatabaseSpecRequestBody `form:"spec,omitempty" json:"spec,omitempty" xml:"spec,omitempty"`
}

CreateDatabaseRequestBody is the type of the "control-plane" service "create-database" endpoint HTTP request body.

type CreateDatabaseResponseBody 

type CreateDatabaseResponseBody struct {
	// The task that will create this database.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
	// The database being created.
	Database *DatabaseResponseBody `form:"database" json:"database" xml:"database"`
}

CreateDatabaseResponseBody is the type of the "control-plane" service "create-database" endpoint HTTP response body.

func NewCreateDatabaseResponseBody 

func NewCreateDatabaseResponseBody(res *controlplane.CreateDatabaseResponse) *CreateDatabaseResponseBody

NewCreateDatabaseResponseBody builds the HTTP response body from the result of the "create-database" endpoint of the "control-plane" service.

type CreateDatabaseServerErrorResponseBody 

type CreateDatabaseServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

CreateDatabaseServerErrorResponseBody is the type of the "control-plane" service "create-database" endpoint HTTP response body for the "server_error" error.

func NewCreateDatabaseServerErrorResponseBody 

func NewCreateDatabaseServerErrorResponseBody(res *controlplane.APIError) *CreateDatabaseServerErrorResponseBody

NewCreateDatabaseServerErrorResponseBody builds the HTTP response body from the result of the "create-database" endpoint of the "control-plane" service.

type DatabaseNodeSpecRequestBody 

type DatabaseNodeSpecRequestBody struct {
	// The name of the database node.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// The IDs of the hosts that should run this node. When multiple hosts are
	// specified, one host will chosen as a primary, and the others will be read
	// replicas.
	HostIds []string `form:"host_ids,omitempty" json:"host_ids,omitempty" xml:"host_ids,omitempty"`
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string `form:"postgres_version,omitempty" json:"postgres_version,omitempty" xml:"postgres_version,omitempty"`
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
	// The number of CPUs to allocate for the database on this node and to use for
	// tuning Postgres. It can include the SI suffix 'm', e.g. '500m' for 500
	// millicpus. Cannot allocate units smaller than 1m. Defaults to the number of
	// available CPUs on the host if 0 or unspecified. Cannot allocate more CPUs
	// than are available on the host. Whether this limit is enforced depends on
	// the orchestrator.
	Cpus *string `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for the database on
	// this node and to use for tuning Postgres. Defaults to the total available
	// memory on the host. Whether this limit is enforced depends on the
	// orchestrator.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any `form:"postgresql_conf,omitempty" json:"postgresql_conf,omitempty" xml:"postgresql_conf,omitempty"`
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecRequestBody `form:"backup_config,omitempty" json:"backup_config,omitempty" xml:"backup_config,omitempty"`
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecRequestBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBody `form:"orchestrator_opts,omitempty" json:"orchestrator_opts,omitempty" xml:"orchestrator_opts,omitempty"`
	// The name of the source node to use for sync. This is typically the node
	// (like 'n1') from which the data will be copied to initialize this new node.
	SourceNode *string `form:"source_node,omitempty" json:"source_node,omitempty" xml:"source_node,omitempty"`
}

DatabaseNodeSpecRequestBody is used to define fields on request body types.

type DatabaseNodeSpecRequestBodyRequestBody 

type DatabaseNodeSpecRequestBodyRequestBody struct {
	// The name of the database node.
	Name *string `form:"name,omitempty" json:"name,omitempty" xml:"name,omitempty"`
	// The IDs of the hosts that should run this node. When multiple hosts are
	// specified, one host will chosen as a primary, and the others will be read
	// replicas.
	HostIds []string `form:"host_ids,omitempty" json:"host_ids,omitempty" xml:"host_ids,omitempty"`
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string `form:"postgres_version,omitempty" json:"postgres_version,omitempty" xml:"postgres_version,omitempty"`
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
	// The number of CPUs to allocate for the database on this node and to use for
	// tuning Postgres. It can include the SI suffix 'm', e.g. '500m' for 500
	// millicpus. Cannot allocate units smaller than 1m. Defaults to the number of
	// available CPUs on the host if 0 or unspecified. Cannot allocate more CPUs
	// than are available on the host. Whether this limit is enforced depends on
	// the orchestrator.
	Cpus *string `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for the database on
	// this node and to use for tuning Postgres. Defaults to the total available
	// memory on the host. Whether this limit is enforced depends on the
	// orchestrator.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any `form:"postgresql_conf,omitempty" json:"postgresql_conf,omitempty" xml:"postgresql_conf,omitempty"`
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecRequestBodyRequestBody `form:"backup_config,omitempty" json:"backup_config,omitempty" xml:"backup_config,omitempty"`
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecRequestBodyRequestBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBodyRequestBody `form:"orchestrator_opts,omitempty" json:"orchestrator_opts,omitempty" xml:"orchestrator_opts,omitempty"`
	// The name of the source node to use for sync. This is typically the node
	// (like 'n1') from which the data will be copied to initialize this new node.
	SourceNode *string `form:"source_node,omitempty" json:"source_node,omitempty" xml:"source_node,omitempty"`
}

DatabaseNodeSpecRequestBodyRequestBody is used to define fields on request body types.

type DatabaseNodeSpecResponseBody 

type DatabaseNodeSpecResponseBody struct {
	// The name of the database node.
	Name string `form:"name" json:"name" xml:"name"`
	// The IDs of the hosts that should run this node. When multiple hosts are
	// specified, one host will chosen as a primary, and the others will be read
	// replicas.
	HostIds []string `form:"host_ids" json:"host_ids" xml:"host_ids"`
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string `form:"postgres_version,omitempty" json:"postgres_version,omitempty" xml:"postgres_version,omitempty"`
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
	// The number of CPUs to allocate for the database on this node and to use for
	// tuning Postgres. It can include the SI suffix 'm', e.g. '500m' for 500
	// millicpus. Cannot allocate units smaller than 1m. Defaults to the number of
	// available CPUs on the host if 0 or unspecified. Cannot allocate more CPUs
	// than are available on the host. Whether this limit is enforced depends on
	// the orchestrator.
	Cpus *string `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for the database on
	// this node and to use for tuning Postgres. Defaults to the total available
	// memory on the host. Whether this limit is enforced depends on the
	// orchestrator.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any `form:"postgresql_conf,omitempty" json:"postgresql_conf,omitempty" xml:"postgresql_conf,omitempty"`
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecResponseBody `form:"backup_config,omitempty" json:"backup_config,omitempty" xml:"backup_config,omitempty"`
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecResponseBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsResponseBody `form:"orchestrator_opts,omitempty" json:"orchestrator_opts,omitempty" xml:"orchestrator_opts,omitempty"`
	// The name of the source node to use for sync. This is typically the node
	// (like 'n1') from which the data will be copied to initialize this new node.
	SourceNode *string `form:"source_node,omitempty" json:"source_node,omitempty" xml:"source_node,omitempty"`
}

DatabaseNodeSpecResponseBody is used to define fields on response body types.

type DatabaseResponseBody 

type DatabaseResponseBody struct {
	// Unique identifier for the database.
	ID string `form:"id" json:"id" xml:"id"`
	// Unique identifier for the databases's owner.
	TenantID *string `form:"tenant_id,omitempty" json:"tenant_id,omitempty" xml:"tenant_id,omitempty"`
	// The time that the database was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time that the database was last updated.
	UpdatedAt string `form:"updated_at" json:"updated_at" xml:"updated_at"`
	// Current state of the database.
	State string `form:"state" json:"state" xml:"state"`
	// All of the instances in the database.
	Instances InstanceCollectionResponseBody `form:"instances,omitempty" json:"instances,omitempty" xml:"instances,omitempty"`
	// The user-provided specification for the database.
	Spec *DatabaseSpecResponseBody `form:"spec,omitempty" json:"spec,omitempty" xml:"spec,omitempty"`
}

DatabaseResponseBody is used to define fields on response body types.

type DatabaseResponseBodyAbbreviated 

type DatabaseResponseBodyAbbreviated struct {
	// Unique identifier for the database.
	ID string `form:"id" json:"id" xml:"id"`
	// Unique identifier for the databases's owner.
	TenantID *string `form:"tenant_id,omitempty" json:"tenant_id,omitempty" xml:"tenant_id,omitempty"`
	// The time that the database was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time that the database was last updated.
	UpdatedAt string `form:"updated_at" json:"updated_at" xml:"updated_at"`
	// Current state of the database.
	State string `form:"state" json:"state" xml:"state"`
	// All of the instances in the database.
	Instances InstanceResponseBodyAbbreviatedCollection `form:"instances,omitempty" json:"instances,omitempty" xml:"instances,omitempty"`
}

DatabaseResponseBodyAbbreviated is used to define fields on response body types.

type DatabaseResponseBodyAbbreviatedCollection 

type DatabaseResponseBodyAbbreviatedCollection []*DatabaseResponseBodyAbbreviated

DatabaseResponseBodyAbbreviatedCollection is used to define fields on response body types.

type DatabaseSpecRequestBody 

type DatabaseSpecRequestBody struct {
	// The name of the Postgres database.
	DatabaseName *string `form:"database_name,omitempty" json:"database_name,omitempty" xml:"database_name,omitempty"`
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string `form:"postgres_version,omitempty" json:"postgres_version,omitempty" xml:"postgres_version,omitempty"`
	// The major version of the Spock extension.
	SpockVersion *string `form:"spock_version,omitempty" json:"spock_version,omitempty" xml:"spock_version,omitempty"`
	// The port used by the Postgres database. If the port is 0, each instance will
	// be assigned a random port. If the port is unspecified, the database will not
	// be exposed on any port, dependent on orchestrator support for that feature.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
	// The number of CPUs to allocate for the database and to use for tuning
	// Postgres. Defaults to the number of available CPUs on the host. Can include
	// an SI suffix, e.g. '500m' for 500 millicpus. Whether this limit is enforced
	// depends on the orchestrator.
	Cpus *string `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for the database and
	// to use for tuning Postgres. Defaults to the total available memory on the
	// host. Whether this limit is enforced depends on the orchestrator.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecRequestBody `form:"nodes,omitempty" json:"nodes,omitempty" xml:"nodes,omitempty"`
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecRequestBody `form:"database_users,omitempty" json:"database_users,omitempty" xml:"database_users,omitempty"`
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecRequestBody `form:"backup_config,omitempty" json:"backup_config,omitempty" xml:"backup_config,omitempty"`
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecRequestBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any `form:"postgresql_conf,omitempty" json:"postgresql_conf,omitempty" xml:"postgresql_conf,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBody `form:"orchestrator_opts,omitempty" json:"orchestrator_opts,omitempty" xml:"orchestrator_opts,omitempty"`
}

DatabaseSpecRequestBody is used to define fields on request body types.

type DatabaseSpecRequestBodyRequestBody 

type DatabaseSpecRequestBodyRequestBody struct {
	// The name of the Postgres database.
	DatabaseName *string `form:"database_name,omitempty" json:"database_name,omitempty" xml:"database_name,omitempty"`
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string `form:"postgres_version,omitempty" json:"postgres_version,omitempty" xml:"postgres_version,omitempty"`
	// The major version of the Spock extension.
	SpockVersion *string `form:"spock_version,omitempty" json:"spock_version,omitempty" xml:"spock_version,omitempty"`
	// The port used by the Postgres database. If the port is 0, each instance will
	// be assigned a random port. If the port is unspecified, the database will not
	// be exposed on any port, dependent on orchestrator support for that feature.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
	// The number of CPUs to allocate for the database and to use for tuning
	// Postgres. Defaults to the number of available CPUs on the host. Can include
	// an SI suffix, e.g. '500m' for 500 millicpus. Whether this limit is enforced
	// depends on the orchestrator.
	Cpus *string `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for the database and
	// to use for tuning Postgres. Defaults to the total available memory on the
	// host. Whether this limit is enforced depends on the orchestrator.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecRequestBodyRequestBody `form:"nodes,omitempty" json:"nodes,omitempty" xml:"nodes,omitempty"`
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecRequestBodyRequestBody `form:"database_users,omitempty" json:"database_users,omitempty" xml:"database_users,omitempty"`
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecRequestBodyRequestBody `form:"backup_config,omitempty" json:"backup_config,omitempty" xml:"backup_config,omitempty"`
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecRequestBodyRequestBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any `form:"postgresql_conf,omitempty" json:"postgresql_conf,omitempty" xml:"postgresql_conf,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBodyRequestBody `form:"orchestrator_opts,omitempty" json:"orchestrator_opts,omitempty" xml:"orchestrator_opts,omitempty"`
}

DatabaseSpecRequestBodyRequestBody is used to define fields on request body types.

type DatabaseSpecResponseBody 

type DatabaseSpecResponseBody struct {
	// The name of the Postgres database.
	DatabaseName string `form:"database_name" json:"database_name" xml:"database_name"`
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string `form:"postgres_version,omitempty" json:"postgres_version,omitempty" xml:"postgres_version,omitempty"`
	// The major version of the Spock extension.
	SpockVersion *string `form:"spock_version,omitempty" json:"spock_version,omitempty" xml:"spock_version,omitempty"`
	// The port used by the Postgres database. If the port is 0, each instance will
	// be assigned a random port. If the port is unspecified, the database will not
	// be exposed on any port, dependent on orchestrator support for that feature.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
	// The number of CPUs to allocate for the database and to use for tuning
	// Postgres. Defaults to the number of available CPUs on the host. Can include
	// an SI suffix, e.g. '500m' for 500 millicpus. Whether this limit is enforced
	// depends on the orchestrator.
	Cpus *string `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for the database and
	// to use for tuning Postgres. Defaults to the total available memory on the
	// host. Whether this limit is enforced depends on the orchestrator.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecResponseBody `form:"nodes" json:"nodes" xml:"nodes"`
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecResponseBody `form:"database_users,omitempty" json:"database_users,omitempty" xml:"database_users,omitempty"`
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecResponseBody `form:"backup_config,omitempty" json:"backup_config,omitempty" xml:"backup_config,omitempty"`
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecResponseBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any `form:"postgresql_conf,omitempty" json:"postgresql_conf,omitempty" xml:"postgresql_conf,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsResponseBody `form:"orchestrator_opts,omitempty" json:"orchestrator_opts,omitempty" xml:"orchestrator_opts,omitempty"`
}

DatabaseSpecResponseBody is used to define fields on response body types.

type DatabaseUserSpecRequestBody 

type DatabaseUserSpecRequestBody struct {
	// The username for this database user.
	Username *string `form:"username,omitempty" json:"username,omitempty" xml:"username,omitempty"`
	// The password for this database user. This field will be excluded from the
	// response of all endpoints. It can also be omitted from update requests to
	// keep the current value.
	Password *string `form:"password,omitempty" json:"password,omitempty" xml:"password,omitempty"`
	// If true, this user will be granted database ownership.
	DbOwner *bool `form:"db_owner,omitempty" json:"db_owner,omitempty" xml:"db_owner,omitempty"`
	// The attributes to assign to this database user.
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" xml:"attributes,omitempty"`
	// The roles to assign to this database user.
	Roles []string `form:"roles,omitempty" json:"roles,omitempty" xml:"roles,omitempty"`
}

DatabaseUserSpecRequestBody is used to define fields on request body types.

type DatabaseUserSpecRequestBodyRequestBody 

type DatabaseUserSpecRequestBodyRequestBody struct {
	// The username for this database user.
	Username *string `form:"username,omitempty" json:"username,omitempty" xml:"username,omitempty"`
	// The password for this database user. This field will be excluded from the
	// response of all endpoints. It can also be omitted from update requests to
	// keep the current value.
	Password *string `form:"password,omitempty" json:"password,omitempty" xml:"password,omitempty"`
	// If true, this user will be granted database ownership.
	DbOwner *bool `form:"db_owner,omitempty" json:"db_owner,omitempty" xml:"db_owner,omitempty"`
	// The attributes to assign to this database user.
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" xml:"attributes,omitempty"`
	// The roles to assign to this database user.
	Roles []string `form:"roles,omitempty" json:"roles,omitempty" xml:"roles,omitempty"`
}

DatabaseUserSpecRequestBodyRequestBody is used to define fields on request body types.

type DatabaseUserSpecResponseBody 

type DatabaseUserSpecResponseBody struct {
	// The username for this database user.
	Username string `form:"username" json:"username" xml:"username"`
	// The password for this database user. This field will be excluded from the
	// response of all endpoints. It can also be omitted from update requests to
	// keep the current value.
	Password *string `form:"password,omitempty" json:"password,omitempty" xml:"password,omitempty"`
	// If true, this user will be granted database ownership.
	DbOwner *bool `form:"db_owner,omitempty" json:"db_owner,omitempty" xml:"db_owner,omitempty"`
	// The attributes to assign to this database user.
	Attributes []string `form:"attributes,omitempty" json:"attributes,omitempty" xml:"attributes,omitempty"`
	// The roles to assign to this database user.
	Roles []string `form:"roles,omitempty" json:"roles,omitempty" xml:"roles,omitempty"`
}

DatabaseUserSpecResponseBody is used to define fields on response body types.

type DeleteDatabaseClusterNotInitializedResponseBody 

type DeleteDatabaseClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

DeleteDatabaseClusterNotInitializedResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewDeleteDatabaseClusterNotInitializedResponseBody 

func NewDeleteDatabaseClusterNotInitializedResponseBody(res *controlplane.APIError) *DeleteDatabaseClusterNotInitializedResponseBody

NewDeleteDatabaseClusterNotInitializedResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type DeleteDatabaseDatabaseNotModifiableResponseBody 

type DeleteDatabaseDatabaseNotModifiableResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

DeleteDatabaseDatabaseNotModifiableResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body for the "database_not_modifiable" error.

func NewDeleteDatabaseDatabaseNotModifiableResponseBody 

func NewDeleteDatabaseDatabaseNotModifiableResponseBody(res *controlplane.APIError) *DeleteDatabaseDatabaseNotModifiableResponseBody

NewDeleteDatabaseDatabaseNotModifiableResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type DeleteDatabaseInvalidInputResponseBody 

type DeleteDatabaseInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

DeleteDatabaseInvalidInputResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body for the "invalid_input" error.

func NewDeleteDatabaseInvalidInputResponseBody 

func NewDeleteDatabaseInvalidInputResponseBody(res *controlplane.APIError) *DeleteDatabaseInvalidInputResponseBody

NewDeleteDatabaseInvalidInputResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type DeleteDatabaseNotFoundResponseBody 

type DeleteDatabaseNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

DeleteDatabaseNotFoundResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body for the "not_found" error.

func NewDeleteDatabaseNotFoundResponseBody 

func NewDeleteDatabaseNotFoundResponseBody(res *controlplane.APIError) *DeleteDatabaseNotFoundResponseBody

NewDeleteDatabaseNotFoundResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type DeleteDatabaseOperationAlreadyInProgressResponseBody 

type DeleteDatabaseOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

DeleteDatabaseOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewDeleteDatabaseOperationAlreadyInProgressResponseBody 

func NewDeleteDatabaseOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *DeleteDatabaseOperationAlreadyInProgressResponseBody

NewDeleteDatabaseOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type DeleteDatabaseResponseBody 

type DeleteDatabaseResponseBody struct {
	// The task that will delete this database.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

DeleteDatabaseResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body.

func NewDeleteDatabaseResponseBody 

func NewDeleteDatabaseResponseBody(res *controlplane.DeleteDatabaseResponse) *DeleteDatabaseResponseBody

NewDeleteDatabaseResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type DeleteDatabaseServerErrorResponseBody 

type DeleteDatabaseServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

DeleteDatabaseServerErrorResponseBody is the type of the "control-plane" service "delete-database" endpoint HTTP response body for the "server_error" error.

func NewDeleteDatabaseServerErrorResponseBody 

func NewDeleteDatabaseServerErrorResponseBody(res *controlplane.APIError) *DeleteDatabaseServerErrorResponseBody

NewDeleteDatabaseServerErrorResponseBody builds the HTTP response body from the result of the "delete-database" endpoint of the "control-plane" service.

type EtcdClusterMemberResponseBody 

type EtcdClusterMemberResponseBody struct {
	// The name of the Etcd cluster member.
	Name string `form:"name" json:"name" xml:"name"`
	// The Etcd peer endpoint for this cluster member.
	PeerUrls []string `form:"peer_urls" json:"peer_urls" xml:"peer_urls"`
	// The Etcd client endpoint for this cluster member.
	ClientUrls []string `form:"client_urls" json:"client_urls" xml:"client_urls"`
}

EtcdClusterMemberResponseBody is used to define fields on response body types.

type ExtraNetworkSpecRequestBody 

type ExtraNetworkSpecRequestBody struct {
	// The name or ID of the network to connect to.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional network-scoped aliases for the container.
	Aliases []string `form:"aliases,omitempty" json:"aliases,omitempty" xml:"aliases,omitempty"`
	// Optional driver options for the network connection.
	DriverOpts map[string]string `form:"driver_opts,omitempty" json:"driver_opts,omitempty" xml:"driver_opts,omitempty"`
}

ExtraNetworkSpecRequestBody is used to define fields on request body types.

type ExtraNetworkSpecRequestBodyRequestBody 

type ExtraNetworkSpecRequestBodyRequestBody struct {
	// The name or ID of the network to connect to.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Optional network-scoped aliases for the container.
	Aliases []string `form:"aliases,omitempty" json:"aliases,omitempty" xml:"aliases,omitempty"`
	// Optional driver options for the network connection.
	DriverOpts map[string]string `form:"driver_opts,omitempty" json:"driver_opts,omitempty" xml:"driver_opts,omitempty"`
}

ExtraNetworkSpecRequestBodyRequestBody is used to define fields on request body types.

type ExtraNetworkSpecResponseBody 

type ExtraNetworkSpecResponseBody struct {
	// The name or ID of the network to connect to.
	ID string `form:"id" json:"id" xml:"id"`
	// Optional network-scoped aliases for the container.
	Aliases []string `form:"aliases,omitempty" json:"aliases,omitempty" xml:"aliases,omitempty"`
	// Optional driver options for the network connection.
	DriverOpts map[string]string `form:"driver_opts,omitempty" json:"driver_opts,omitempty" xml:"driver_opts,omitempty"`
}

ExtraNetworkSpecResponseBody is used to define fields on response body types.

type ExtraVolumesSpecRequestBody 

type ExtraVolumesSpecRequestBody struct {
	// The host path for the volume.
	HostPath *string `form:"host_path,omitempty" json:"host_path,omitempty" xml:"host_path,omitempty"`
	// The path inside the container where the volume will be mounted.
	DestinationPath *string `form:"destination_path,omitempty" json:"destination_path,omitempty" xml:"destination_path,omitempty"`
}

ExtraVolumesSpecRequestBody is used to define fields on request body types.

type ExtraVolumesSpecRequestBodyRequestBody 

type ExtraVolumesSpecRequestBodyRequestBody struct {
	// The host path for the volume.
	HostPath *string `form:"host_path,omitempty" json:"host_path,omitempty" xml:"host_path,omitempty"`
	// The path inside the container where the volume will be mounted.
	DestinationPath *string `form:"destination_path,omitempty" json:"destination_path,omitempty" xml:"destination_path,omitempty"`
}

ExtraVolumesSpecRequestBodyRequestBody is used to define fields on request body types.

type ExtraVolumesSpecResponseBody 

type ExtraVolumesSpecResponseBody struct {
	// The host path for the volume.
	HostPath string `form:"host_path" json:"host_path" xml:"host_path"`
	// The path inside the container where the volume will be mounted.
	DestinationPath string `form:"destination_path" json:"destination_path" xml:"destination_path"`
}

ExtraVolumesSpecResponseBody is used to define fields on response body types.

type FailoverDatabaseNodeClusterNotInitializedResponseBody 

type FailoverDatabaseNodeClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

FailoverDatabaseNodeClusterNotInitializedResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewFailoverDatabaseNodeClusterNotInitializedResponseBody 

func NewFailoverDatabaseNodeClusterNotInitializedResponseBody(res *controlplane.APIError) *FailoverDatabaseNodeClusterNotInitializedResponseBody

NewFailoverDatabaseNodeClusterNotInitializedResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeDatabaseNotModifiableResponseBody 

type FailoverDatabaseNodeDatabaseNotModifiableResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

FailoverDatabaseNodeDatabaseNotModifiableResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body for the "database_not_modifiable" error.

func NewFailoverDatabaseNodeDatabaseNotModifiableResponseBody 

func NewFailoverDatabaseNodeDatabaseNotModifiableResponseBody(res *controlplane.APIError) *FailoverDatabaseNodeDatabaseNotModifiableResponseBody

NewFailoverDatabaseNodeDatabaseNotModifiableResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeInvalidInputResponseBody 

type FailoverDatabaseNodeInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

FailoverDatabaseNodeInvalidInputResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body for the "invalid_input" error.

func NewFailoverDatabaseNodeInvalidInputResponseBody 

func NewFailoverDatabaseNodeInvalidInputResponseBody(res *controlplane.APIError) *FailoverDatabaseNodeInvalidInputResponseBody

NewFailoverDatabaseNodeInvalidInputResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeNotFoundResponseBody 

type FailoverDatabaseNodeNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

FailoverDatabaseNodeNotFoundResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body for the "not_found" error.

func NewFailoverDatabaseNodeNotFoundResponseBody 

func NewFailoverDatabaseNodeNotFoundResponseBody(res *controlplane.APIError) *FailoverDatabaseNodeNotFoundResponseBody

NewFailoverDatabaseNodeNotFoundResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeOperationAlreadyInProgressResponseBody 

type FailoverDatabaseNodeOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

FailoverDatabaseNodeOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewFailoverDatabaseNodeOperationAlreadyInProgressResponseBody 

func NewFailoverDatabaseNodeOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *FailoverDatabaseNodeOperationAlreadyInProgressResponseBody

NewFailoverDatabaseNodeOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeRequestBody 

type FailoverDatabaseNodeRequestBody struct {
	// Optional instance_id of the replica to promote. If omitted, a candidate will
	// be selected.
	CandidateInstanceID *string `form:"candidate_instance_id,omitempty" json:"candidate_instance_id,omitempty" xml:"candidate_instance_id,omitempty"`
	// If true, skip the health validations that prevent running failover on a
	// healthy cluster.
	SkipValidation *bool `form:"skip_validation,omitempty" json:"skip_validation,omitempty" xml:"skip_validation,omitempty"`
}

FailoverDatabaseNodeRequestBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP request body.

type FailoverDatabaseNodeResponseBody 

type FailoverDatabaseNodeResponseBody struct {
	// The task that will perform the failover.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

FailoverDatabaseNodeResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body.

func NewFailoverDatabaseNodeResponseBody 

func NewFailoverDatabaseNodeResponseBody(res *controlplane.FailoverDatabaseNodeResponse) *FailoverDatabaseNodeResponseBody

NewFailoverDatabaseNodeResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeServerErrorResponseBody 

type FailoverDatabaseNodeServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

FailoverDatabaseNodeServerErrorResponseBody is the type of the "control-plane" service "failover-database-node" endpoint HTTP response body for the "server_error" error.

func NewFailoverDatabaseNodeServerErrorResponseBody 

func NewFailoverDatabaseNodeServerErrorResponseBody(res *controlplane.APIError) *FailoverDatabaseNodeServerErrorResponseBody

NewFailoverDatabaseNodeServerErrorResponseBody builds the HTTP response body from the result of the "failover-database-node" endpoint of the "control-plane" service.

type GetClusterClusterNotInitializedResponseBody 

type GetClusterClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetClusterClusterNotInitializedResponseBody is the type of the "control-plane" service "get-cluster" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetClusterClusterNotInitializedResponseBody 

func NewGetClusterClusterNotInitializedResponseBody(res *controlplane.APIError) *GetClusterClusterNotInitializedResponseBody

NewGetClusterClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-cluster" endpoint of the "control-plane" service.

type GetClusterResponseBody 

type GetClusterResponseBody struct {
	// Unique identifier for the cluster.
	ID string `form:"id" json:"id" xml:"id"`
	// Current status of the cluster.
	Status *ClusterStatusResponseBody `form:"status" json:"status" xml:"status"`
	// All of the hosts in the cluster.
	Hosts []*HostResponseBody `form:"hosts" json:"hosts" xml:"hosts"`
}

GetClusterResponseBody is the type of the "control-plane" service "get-cluster" endpoint HTTP response body.

func NewGetClusterResponseBody 

func NewGetClusterResponseBody(res *controlplane.Cluster) *GetClusterResponseBody

NewGetClusterResponseBody builds the HTTP response body from the result of the "get-cluster" endpoint of the "control-plane" service.

type GetClusterServerErrorResponseBody 

type GetClusterServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetClusterServerErrorResponseBody is the type of the "control-plane" service "get-cluster" endpoint HTTP response body for the "server_error" error.

func NewGetClusterServerErrorResponseBody 

func NewGetClusterServerErrorResponseBody(res *controlplane.APIError) *GetClusterServerErrorResponseBody

NewGetClusterServerErrorResponseBody builds the HTTP response body from the result of the "get-cluster" endpoint of the "control-plane" service.

type GetDatabaseClusterNotInitializedResponseBody 

type GetDatabaseClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseClusterNotInitializedResponseBody is the type of the "control-plane" service "get-database" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetDatabaseClusterNotInitializedResponseBody 

func NewGetDatabaseClusterNotInitializedResponseBody(res *controlplane.APIError) *GetDatabaseClusterNotInitializedResponseBody

NewGetDatabaseClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-database" endpoint of the "control-plane" service.

type GetDatabaseInvalidInputResponseBody 

type GetDatabaseInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseInvalidInputResponseBody is the type of the "control-plane" service "get-database" endpoint HTTP response body for the "invalid_input" error.

func NewGetDatabaseInvalidInputResponseBody 

func NewGetDatabaseInvalidInputResponseBody(res *controlplane.APIError) *GetDatabaseInvalidInputResponseBody

NewGetDatabaseInvalidInputResponseBody builds the HTTP response body from the result of the "get-database" endpoint of the "control-plane" service.

type GetDatabaseNotFoundResponseBody 

type GetDatabaseNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseNotFoundResponseBody is the type of the "control-plane" service "get-database" endpoint HTTP response body for the "not_found" error.

func NewGetDatabaseNotFoundResponseBody 

func NewGetDatabaseNotFoundResponseBody(res *controlplane.APIError) *GetDatabaseNotFoundResponseBody

NewGetDatabaseNotFoundResponseBody builds the HTTP response body from the result of the "get-database" endpoint of the "control-plane" service.

type GetDatabaseResponseBody 

type GetDatabaseResponseBody struct {
	// Unique identifier for the database.
	ID string `form:"id" json:"id" xml:"id"`
	// Unique identifier for the database.
	TenantID *string `form:"tenant_id,omitempty" json:"tenant_id,omitempty" xml:"tenant_id,omitempty"`
	// The time that the database was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time that the database was last updated.
	UpdatedAt string `form:"updated_at" json:"updated_at" xml:"updated_at"`
	// Current state of the database.
	State string `form:"state" json:"state" xml:"state"`
	// All of the instances in the database.
	Instances InstanceResponseBodyCollection `form:"instances,omitempty" json:"instances,omitempty" xml:"instances,omitempty"`
	// The user-provided specification for the database.
	Spec *DatabaseSpecResponseBody `form:"spec,omitempty" json:"spec,omitempty" xml:"spec,omitempty"`
}

GetDatabaseResponseBody is the type of the "control-plane" service "get-database" endpoint HTTP response body.

func NewGetDatabaseResponseBody 

func NewGetDatabaseResponseBody(res *controlplaneviews.DatabaseView) *GetDatabaseResponseBody

NewGetDatabaseResponseBody builds the HTTP response body from the result of the "get-database" endpoint of the "control-plane" service.

type GetDatabaseServerErrorResponseBody 

type GetDatabaseServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseServerErrorResponseBody is the type of the "control-plane" service "get-database" endpoint HTTP response body for the "server_error" error.

func NewGetDatabaseServerErrorResponseBody 

func NewGetDatabaseServerErrorResponseBody(res *controlplane.APIError) *GetDatabaseServerErrorResponseBody

NewGetDatabaseServerErrorResponseBody builds the HTTP response body from the result of the "get-database" endpoint of the "control-plane" service.

type GetDatabaseTaskClusterNotInitializedResponseBody 

type GetDatabaseTaskClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskClusterNotInitializedResponseBody is the type of the "control-plane" service "get-database-task" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetDatabaseTaskClusterNotInitializedResponseBody 

func NewGetDatabaseTaskClusterNotInitializedResponseBody(res *controlplane.APIError) *GetDatabaseTaskClusterNotInitializedResponseBody

NewGetDatabaseTaskClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-database-task" endpoint of the "control-plane" service.

type GetDatabaseTaskInvalidInputResponseBody 

type GetDatabaseTaskInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskInvalidInputResponseBody is the type of the "control-plane" service "get-database-task" endpoint HTTP response body for the "invalid_input" error.

func NewGetDatabaseTaskInvalidInputResponseBody 

func NewGetDatabaseTaskInvalidInputResponseBody(res *controlplane.APIError) *GetDatabaseTaskInvalidInputResponseBody

NewGetDatabaseTaskInvalidInputResponseBody builds the HTTP response body from the result of the "get-database-task" endpoint of the "control-plane" service.

type GetDatabaseTaskLogClusterNotInitializedResponseBody 

type GetDatabaseTaskLogClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskLogClusterNotInitializedResponseBody is the type of the "control-plane" service "get-database-task-log" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetDatabaseTaskLogClusterNotInitializedResponseBody 

func NewGetDatabaseTaskLogClusterNotInitializedResponseBody(res *controlplane.APIError) *GetDatabaseTaskLogClusterNotInitializedResponseBody

NewGetDatabaseTaskLogClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-database-task-log" endpoint of the "control-plane" service.

type GetDatabaseTaskLogInvalidInputResponseBody 

type GetDatabaseTaskLogInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskLogInvalidInputResponseBody is the type of the "control-plane" service "get-database-task-log" endpoint HTTP response body for the "invalid_input" error.

func NewGetDatabaseTaskLogInvalidInputResponseBody 

func NewGetDatabaseTaskLogInvalidInputResponseBody(res *controlplane.APIError) *GetDatabaseTaskLogInvalidInputResponseBody

NewGetDatabaseTaskLogInvalidInputResponseBody builds the HTTP response body from the result of the "get-database-task-log" endpoint of the "control-plane" service.

type GetDatabaseTaskLogNotFoundResponseBody 

type GetDatabaseTaskLogNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskLogNotFoundResponseBody is the type of the "control-plane" service "get-database-task-log" endpoint HTTP response body for the "not_found" error.

func NewGetDatabaseTaskLogNotFoundResponseBody 

func NewGetDatabaseTaskLogNotFoundResponseBody(res *controlplane.APIError) *GetDatabaseTaskLogNotFoundResponseBody

NewGetDatabaseTaskLogNotFoundResponseBody builds the HTTP response body from the result of the "get-database-task-log" endpoint of the "control-plane" service.

type GetDatabaseTaskLogResponseBody 

type GetDatabaseTaskLogResponseBody struct {
	// The database ID of the task log.
	DatabaseID string `form:"database_id" json:"database_id" xml:"database_id"`
	// The unique ID of the task log.
	TaskID string `form:"task_id" json:"task_id" xml:"task_id"`
	// The status of the task.
	TaskStatus string `form:"task_status" json:"task_status" xml:"task_status"`
	// The ID of the last entry in the task log.
	LastEntryID *string `form:"last_entry_id,omitempty" json:"last_entry_id,omitempty" xml:"last_entry_id,omitempty"`
	// Entries in the task log.
	Entries []*TaskLogEntryResponseBody `form:"entries" json:"entries" xml:"entries"`
}

GetDatabaseTaskLogResponseBody is the type of the "control-plane" service "get-database-task-log" endpoint HTTP response body.

func NewGetDatabaseTaskLogResponseBody 

func NewGetDatabaseTaskLogResponseBody(res *controlplane.TaskLog) *GetDatabaseTaskLogResponseBody

NewGetDatabaseTaskLogResponseBody builds the HTTP response body from the result of the "get-database-task-log" endpoint of the "control-plane" service.

type GetDatabaseTaskLogServerErrorResponseBody 

type GetDatabaseTaskLogServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskLogServerErrorResponseBody is the type of the "control-plane" service "get-database-task-log" endpoint HTTP response body for the "server_error" error.

func NewGetDatabaseTaskLogServerErrorResponseBody 

func NewGetDatabaseTaskLogServerErrorResponseBody(res *controlplane.APIError) *GetDatabaseTaskLogServerErrorResponseBody

NewGetDatabaseTaskLogServerErrorResponseBody builds the HTTP response body from the result of the "get-database-task-log" endpoint of the "control-plane" service.

type GetDatabaseTaskNotFoundResponseBody 

type GetDatabaseTaskNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskNotFoundResponseBody is the type of the "control-plane" service "get-database-task" endpoint HTTP response body for the "not_found" error.

func NewGetDatabaseTaskNotFoundResponseBody 

func NewGetDatabaseTaskNotFoundResponseBody(res *controlplane.APIError) *GetDatabaseTaskNotFoundResponseBody

NewGetDatabaseTaskNotFoundResponseBody builds the HTTP response body from the result of the "get-database-task" endpoint of the "control-plane" service.

type GetDatabaseTaskResponseBody 

type GetDatabaseTaskResponseBody struct {
	// The parent task ID of the task.
	ParentID *string `form:"parent_id,omitempty" json:"parent_id,omitempty" xml:"parent_id,omitempty"`
	// The database ID of the task.
	DatabaseID string `form:"database_id" json:"database_id" xml:"database_id"`
	// The name of the node that the task is operating on.
	NodeName *string `form:"node_name,omitempty" json:"node_name,omitempty" xml:"node_name,omitempty"`
	// The ID of the instance that the task is operating on.
	InstanceID *string `form:"instance_id,omitempty" json:"instance_id,omitempty" xml:"instance_id,omitempty"`
	// The ID of the host that the task is running on.
	HostID *string `form:"host_id,omitempty" json:"host_id,omitempty" xml:"host_id,omitempty"`
	// The unique ID of the task.
	TaskID string `form:"task_id" json:"task_id" xml:"task_id"`
	// The time when the task was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time when the task was completed.
	CompletedAt *string `form:"completed_at,omitempty" json:"completed_at,omitempty" xml:"completed_at,omitempty"`
	// The type of the task.
	Type string `form:"type" json:"type" xml:"type"`
	// The status of the task.
	Status string `form:"status" json:"status" xml:"status"`
	// The error message if the task failed.
	Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"`
}

GetDatabaseTaskResponseBody is the type of the "control-plane" service "get-database-task" endpoint HTTP response body.

func NewGetDatabaseTaskResponseBody 

func NewGetDatabaseTaskResponseBody(res *controlplane.Task) *GetDatabaseTaskResponseBody

NewGetDatabaseTaskResponseBody builds the HTTP response body from the result of the "get-database-task" endpoint of the "control-plane" service.

type GetDatabaseTaskServerErrorResponseBody 

type GetDatabaseTaskServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetDatabaseTaskServerErrorResponseBody is the type of the "control-plane" service "get-database-task" endpoint HTTP response body for the "server_error" error.

func NewGetDatabaseTaskServerErrorResponseBody 

func NewGetDatabaseTaskServerErrorResponseBody(res *controlplane.APIError) *GetDatabaseTaskServerErrorResponseBody

NewGetDatabaseTaskServerErrorResponseBody builds the HTTP response body from the result of the "get-database-task" endpoint of the "control-plane" service.

type GetHostClusterNotInitializedResponseBody 

type GetHostClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetHostClusterNotInitializedResponseBody is the type of the "control-plane" service "get-host" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetHostClusterNotInitializedResponseBody 

func NewGetHostClusterNotInitializedResponseBody(res *controlplane.APIError) *GetHostClusterNotInitializedResponseBody

NewGetHostClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-host" endpoint of the "control-plane" service.

type GetHostInvalidInputResponseBody 

type GetHostInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetHostInvalidInputResponseBody is the type of the "control-plane" service "get-host" endpoint HTTP response body for the "invalid_input" error.

func NewGetHostInvalidInputResponseBody 

func NewGetHostInvalidInputResponseBody(res *controlplane.APIError) *GetHostInvalidInputResponseBody

NewGetHostInvalidInputResponseBody builds the HTTP response body from the result of the "get-host" endpoint of the "control-plane" service.

type GetHostNotFoundResponseBody 

type GetHostNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetHostNotFoundResponseBody is the type of the "control-plane" service "get-host" endpoint HTTP response body for the "not_found" error.

func NewGetHostNotFoundResponseBody 

func NewGetHostNotFoundResponseBody(res *controlplane.APIError) *GetHostNotFoundResponseBody

NewGetHostNotFoundResponseBody builds the HTTP response body from the result of the "get-host" endpoint of the "control-plane" service.

type GetHostResponseBody 

type GetHostResponseBody struct {
	// Unique identifier for the host.
	ID string `form:"id" json:"id" xml:"id"`
	// The orchestrator used by this host.
	Orchestrator string `form:"orchestrator" json:"orchestrator" xml:"orchestrator"`
	// The data directory for the host.
	DataDir string `form:"data_dir" json:"data_dir" xml:"data_dir"`
	// The cohort that this host belongs to.
	Cohort *HostCohortResponseBody `form:"cohort,omitempty" json:"cohort,omitempty" xml:"cohort,omitempty"`
	// The hostname of this host.
	Hostname string `form:"hostname" json:"hostname" xml:"hostname"`
	// The IPv4 address of this host.
	Ipv4Address string `form:"ipv4_address" json:"ipv4_address" xml:"ipv4_address"`
	// The number of CPUs on this host.
	Cpus *int `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory available on this host.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// Current status of the host.
	Status *HostStatusResponseBody `form:"status" json:"status" xml:"status"`
	// The default PgEdge version for this host.
	DefaultPgedgeVersion *PgEdgeVersionResponseBody `form:"default_pgedge_version,omitempty" json:"default_pgedge_version,omitempty" xml:"default_pgedge_version,omitempty"`
	// The PgEdge versions supported by this host.
	SupportedPgedgeVersions []*PgEdgeVersionResponseBody `` /* 127-byte string literal not displayed */
}

GetHostResponseBody is the type of the "control-plane" service "get-host" endpoint HTTP response body.

func NewGetHostResponseBody 

func NewGetHostResponseBody(res *controlplane.Host) *GetHostResponseBody

NewGetHostResponseBody builds the HTTP response body from the result of the "get-host" endpoint of the "control-plane" service.

type GetHostServerErrorResponseBody 

type GetHostServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetHostServerErrorResponseBody is the type of the "control-plane" service "get-host" endpoint HTTP response body for the "server_error" error.

func NewGetHostServerErrorResponseBody 

func NewGetHostServerErrorResponseBody(res *controlplane.APIError) *GetHostServerErrorResponseBody

NewGetHostServerErrorResponseBody builds the HTTP response body from the result of the "get-host" endpoint of the "control-plane" service.

type GetJoinOptionsClusterNotInitializedResponseBody 

type GetJoinOptionsClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetJoinOptionsClusterNotInitializedResponseBody is the type of the "control-plane" service "get-join-options" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetJoinOptionsClusterNotInitializedResponseBody 

func NewGetJoinOptionsClusterNotInitializedResponseBody(res *controlplane.APIError) *GetJoinOptionsClusterNotInitializedResponseBody

NewGetJoinOptionsClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-join-options" endpoint of the "control-plane" service.

type GetJoinOptionsInvalidInputResponseBody added in v0.6.0 

type GetJoinOptionsInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetJoinOptionsInvalidInputResponseBody is the type of the "control-plane" service "get-join-options" endpoint HTTP response body for the "invalid_input" error.

func NewGetJoinOptionsInvalidInputResponseBody added in v0.6.0 

func NewGetJoinOptionsInvalidInputResponseBody(res *controlplane.APIError) *GetJoinOptionsInvalidInputResponseBody

NewGetJoinOptionsInvalidInputResponseBody builds the HTTP response body from the result of the "get-join-options" endpoint of the "control-plane" service.

type GetJoinOptionsInvalidJoinTokenResponseBody 

type GetJoinOptionsInvalidJoinTokenResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetJoinOptionsInvalidJoinTokenResponseBody is the type of the "control-plane" service "get-join-options" endpoint HTTP response body for the "invalid_join_token" error.

func NewGetJoinOptionsInvalidJoinTokenResponseBody 

func NewGetJoinOptionsInvalidJoinTokenResponseBody(res *controlplane.APIError) *GetJoinOptionsInvalidJoinTokenResponseBody

NewGetJoinOptionsInvalidJoinTokenResponseBody builds the HTTP response body from the result of the "get-join-options" endpoint of the "control-plane" service.

type GetJoinOptionsRequestBody 

type GetJoinOptionsRequestBody struct {
	// Token to join the cluster.
	Token *string `form:"token,omitempty" json:"token,omitempty" xml:"token,omitempty"`
	// The unique identifier for the host that's joining the cluster.
	HostID *string `form:"host_id,omitempty" json:"host_id,omitempty" xml:"host_id,omitempty"`
	// The hostname of the host that's joining the cluster.
	Hostname *string `form:"hostname,omitempty" json:"hostname,omitempty" xml:"hostname,omitempty"`
	// The IPv4 address of the host that's joining the cluster.
	Ipv4Address *string `form:"ipv4_address,omitempty" json:"ipv4_address,omitempty" xml:"ipv4_address,omitempty"`
	// True if the joining member is configured to run an embedded an etcd server.
	EmbeddedEtcdEnabled *bool `form:"embedded_etcd_enabled,omitempty" json:"embedded_etcd_enabled,omitempty" xml:"embedded_etcd_enabled,omitempty"`
}

GetJoinOptionsRequestBody is the type of the "control-plane" service "get-join-options" endpoint HTTP request body.

type GetJoinOptionsResponseBody 

type GetJoinOptionsResponseBody struct {
	// Connection information for the etcd cluster leader
	Leader *EtcdClusterMemberResponseBody `form:"leader" json:"leader" xml:"leader"`
	// Credentials for the new host joining the cluster.
	Credentials *ClusterCredentialsResponseBody `form:"credentials" json:"credentials" xml:"credentials"`
}

GetJoinOptionsResponseBody is the type of the "control-plane" service "get-join-options" endpoint HTTP response body.

func NewGetJoinOptionsResponseBody 

func NewGetJoinOptionsResponseBody(res *controlplane.ClusterJoinOptions) *GetJoinOptionsResponseBody

NewGetJoinOptionsResponseBody builds the HTTP response body from the result of the "get-join-options" endpoint of the "control-plane" service.

type GetJoinOptionsServerErrorResponseBody 

type GetJoinOptionsServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetJoinOptionsServerErrorResponseBody is the type of the "control-plane" service "get-join-options" endpoint HTTP response body for the "server_error" error.

func NewGetJoinOptionsServerErrorResponseBody 

func NewGetJoinOptionsServerErrorResponseBody(res *controlplane.APIError) *GetJoinOptionsServerErrorResponseBody

NewGetJoinOptionsServerErrorResponseBody builds the HTTP response body from the result of the "get-join-options" endpoint of the "control-plane" service.

type GetJoinTokenClusterNotInitializedResponseBody 

type GetJoinTokenClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetJoinTokenClusterNotInitializedResponseBody is the type of the "control-plane" service "get-join-token" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewGetJoinTokenClusterNotInitializedResponseBody 

func NewGetJoinTokenClusterNotInitializedResponseBody(res *controlplane.APIError) *GetJoinTokenClusterNotInitializedResponseBody

NewGetJoinTokenClusterNotInitializedResponseBody builds the HTTP response body from the result of the "get-join-token" endpoint of the "control-plane" service.

type GetJoinTokenResponseBody 

type GetJoinTokenResponseBody struct {
	// Token to join an existing cluster.
	Token string `form:"token" json:"token" xml:"token"`
	// Existing server to join
	ServerURL string `form:"server_url" json:"server_url" xml:"server_url"`
}

GetJoinTokenResponseBody is the type of the "control-plane" service "get-join-token" endpoint HTTP response body.

func NewGetJoinTokenResponseBody 

func NewGetJoinTokenResponseBody(res *controlplane.ClusterJoinToken) *GetJoinTokenResponseBody

NewGetJoinTokenResponseBody builds the HTTP response body from the result of the "get-join-token" endpoint of the "control-plane" service.

type GetJoinTokenServerErrorResponseBody 

type GetJoinTokenServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetJoinTokenServerErrorResponseBody is the type of the "control-plane" service "get-join-token" endpoint HTTP response body for the "server_error" error.

func NewGetJoinTokenServerErrorResponseBody 

func NewGetJoinTokenServerErrorResponseBody(res *controlplane.APIError) *GetJoinTokenServerErrorResponseBody

NewGetJoinTokenServerErrorResponseBody builds the HTTP response body from the result of the "get-join-token" endpoint of the "control-plane" service.

type GetVersionResponseBody 

type GetVersionResponseBody struct {
	// The version of the API server.
	Version string `form:"version" json:"version" xml:"version"`
	// The VCS revision of the API server.
	Revision string `form:"revision" json:"revision" xml:"revision"`
	// The timestamp associated with the revision.
	RevisionTime string `form:"revision_time" json:"revision_time" xml:"revision_time"`
	// The CPU architecture of the API server.
	Arch string `form:"arch" json:"arch" xml:"arch"`
}

GetVersionResponseBody is the type of the "control-plane" service "get-version" endpoint HTTP response body.

func NewGetVersionResponseBody 

func NewGetVersionResponseBody(res *controlplane.VersionInfo) *GetVersionResponseBody

NewGetVersionResponseBody builds the HTTP response body from the result of the "get-version" endpoint of the "control-plane" service.

type GetVersionServerErrorResponseBody 

type GetVersionServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

GetVersionServerErrorResponseBody is the type of the "control-plane" service "get-version" endpoint HTTP response body for the "server_error" error.

func NewGetVersionServerErrorResponseBody 

func NewGetVersionServerErrorResponseBody(res *controlplane.APIError) *GetVersionServerErrorResponseBody

NewGetVersionServerErrorResponseBody builds the HTTP response body from the result of the "get-version" endpoint of the "control-plane" service.

type HostCohortResponseBody 

type HostCohortResponseBody struct {
	// The type of cohort that the host belongs to.
	Type string `form:"type" json:"type" xml:"type"`
	// The member ID of the host within the cohort.
	MemberID string `form:"member_id" json:"member_id" xml:"member_id"`
	// Indicates if the host is a control node in the cohort.
	ControlAvailable bool `form:"control_available" json:"control_available" xml:"control_available"`
}

HostCohortResponseBody is used to define fields on response body types.

type HostResponseBody 

type HostResponseBody struct {
	// Unique identifier for the host.
	ID string `form:"id" json:"id" xml:"id"`
	// The orchestrator used by this host.
	Orchestrator string `form:"orchestrator" json:"orchestrator" xml:"orchestrator"`
	// The data directory for the host.
	DataDir string `form:"data_dir" json:"data_dir" xml:"data_dir"`
	// The cohort that this host belongs to.
	Cohort *HostCohortResponseBody `form:"cohort,omitempty" json:"cohort,omitempty" xml:"cohort,omitempty"`
	// The hostname of this host.
	Hostname string `form:"hostname" json:"hostname" xml:"hostname"`
	// The IPv4 address of this host.
	Ipv4Address string `form:"ipv4_address" json:"ipv4_address" xml:"ipv4_address"`
	// The number of CPUs on this host.
	Cpus *int `form:"cpus,omitempty" json:"cpus,omitempty" xml:"cpus,omitempty"`
	// The amount of memory available on this host.
	Memory *string `form:"memory,omitempty" json:"memory,omitempty" xml:"memory,omitempty"`
	// Current status of the host.
	Status *HostStatusResponseBody `form:"status" json:"status" xml:"status"`
	// The default PgEdge version for this host.
	DefaultPgedgeVersion *PgEdgeVersionResponseBody `form:"default_pgedge_version,omitempty" json:"default_pgedge_version,omitempty" xml:"default_pgedge_version,omitempty"`
	// The PgEdge versions supported by this host.
	SupportedPgedgeVersions []*PgEdgeVersionResponseBody `` /* 127-byte string literal not displayed */
}

HostResponseBody is used to define fields on response body types.

type HostStatusResponseBody 

type HostStatusResponseBody struct {
	State string `form:"state" json:"state" xml:"state"`
	// The last time the host status was updated.
	UpdatedAt string `form:"updated_at" json:"updated_at" xml:"updated_at"`
	// The status of each component of the host.
	Components map[string]*ComponentStatusResponseBody `form:"components" json:"components" xml:"components"`
}

HostStatusResponseBody is used to define fields on response body types.

type InitClusterClusterAlreadyInitializedResponseBody 

type InitClusterClusterAlreadyInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

InitClusterClusterAlreadyInitializedResponseBody is the type of the "control-plane" service "init-cluster" endpoint HTTP response body for the "cluster_already_initialized" error.

func NewInitClusterClusterAlreadyInitializedResponseBody 

func NewInitClusterClusterAlreadyInitializedResponseBody(res *controlplane.APIError) *InitClusterClusterAlreadyInitializedResponseBody

NewInitClusterClusterAlreadyInitializedResponseBody builds the HTTP response body from the result of the "init-cluster" endpoint of the "control-plane" service.

type InitClusterOperationNotSupportedResponseBody 

type InitClusterOperationNotSupportedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

InitClusterOperationNotSupportedResponseBody is the type of the "control-plane" service "init-cluster" endpoint HTTP response body for the "operation_not_supported" error.

func NewInitClusterOperationNotSupportedResponseBody 

func NewInitClusterOperationNotSupportedResponseBody(res *controlplane.APIError) *InitClusterOperationNotSupportedResponseBody

NewInitClusterOperationNotSupportedResponseBody builds the HTTP response body from the result of the "init-cluster" endpoint of the "control-plane" service.

type InitClusterResponseBody 

type InitClusterResponseBody struct {
	// Token to join an existing cluster.
	Token string `form:"token" json:"token" xml:"token"`
	// Existing server to join
	ServerURL string `form:"server_url" json:"server_url" xml:"server_url"`
}

InitClusterResponseBody is the type of the "control-plane" service "init-cluster" endpoint HTTP response body.

func NewInitClusterResponseBody 

func NewInitClusterResponseBody(res *controlplane.ClusterJoinToken) *InitClusterResponseBody

NewInitClusterResponseBody builds the HTTP response body from the result of the "init-cluster" endpoint of the "control-plane" service.

type InitClusterServerErrorResponseBody 

type InitClusterServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

InitClusterServerErrorResponseBody is the type of the "control-plane" service "init-cluster" endpoint HTTP response body for the "server_error" error.

func NewInitClusterServerErrorResponseBody 

func NewInitClusterServerErrorResponseBody(res *controlplane.APIError) *InitClusterServerErrorResponseBody

NewInitClusterServerErrorResponseBody builds the HTTP response body from the result of the "init-cluster" endpoint of the "control-plane" service.

type InstanceCollectionResponseBody 

type InstanceCollectionResponseBody []*InstanceResponseBody

InstanceCollectionResponseBody is used to define fields on response body types.

type InstanceConnectionInfoResponseBody 

type InstanceConnectionInfoResponseBody struct {
	// The hostname of the host that's running this instance.
	Hostname *string `form:"hostname,omitempty" json:"hostname,omitempty" xml:"hostname,omitempty"`
	// The IPv4 address of the host that's running this instance.
	Ipv4Address *string `form:"ipv4_address,omitempty" json:"ipv4_address,omitempty" xml:"ipv4_address,omitempty"`
	// The host port that Postgres is listening on for this instance.
	Port *int `form:"port,omitempty" json:"port,omitempty" xml:"port,omitempty"`
}

InstanceConnectionInfoResponseBody is used to define fields on response body types.

type InstancePostgresStatusResponseBody 

type InstancePostgresStatusResponseBody struct {
	// The version of Postgres for this instance.
	Version      *string `form:"version,omitempty" json:"version,omitempty" xml:"version,omitempty"`
	PatroniState *string `form:"patroni_state,omitempty" json:"patroni_state,omitempty" xml:"patroni_state,omitempty"`
	Role         *string `form:"role,omitempty" json:"role,omitempty" xml:"role,omitempty"`
	// True if this instance has a pending restart from a configuration change.
	PendingRestart *bool `form:"pending_restart,omitempty" json:"pending_restart,omitempty" xml:"pending_restart,omitempty"`
	// True if Patroni is paused for this instance.
	PatroniPaused *bool `form:"patroni_paused,omitempty" json:"patroni_paused,omitempty" xml:"patroni_paused,omitempty"`
}

InstancePostgresStatusResponseBody is used to define fields on response body types.

type InstanceResponseBody 

type InstanceResponseBody struct {
	// Unique identifier for the instance.
	ID string `form:"id" json:"id" xml:"id"`
	// The ID of the host this instance is running on.
	HostID string `form:"host_id" json:"host_id" xml:"host_id"`
	// The Spock node name for this instance.
	NodeName string `form:"node_name" json:"node_name" xml:"node_name"`
	// The time that the instance was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time that the instance was last modified.
	UpdatedAt string `form:"updated_at" json:"updated_at" xml:"updated_at"`
	// The time that the instance status information was last updated.
	StatusUpdatedAt *string `form:"status_updated_at,omitempty" json:"status_updated_at,omitempty" xml:"status_updated_at,omitempty"`
	State           string  `form:"state" json:"state" xml:"state"`
	// Connection information for the instance.
	ConnectionInfo *InstanceConnectionInfoResponseBody `form:"connection_info,omitempty" json:"connection_info,omitempty" xml:"connection_info,omitempty"`
	// Postgres status information for the instance.
	Postgres *InstancePostgresStatusResponseBody `form:"postgres,omitempty" json:"postgres,omitempty" xml:"postgres,omitempty"`
	// Spock status information for the instance.
	Spock *InstanceSpockStatusResponseBody `form:"spock,omitempty" json:"spock,omitempty" xml:"spock,omitempty"`
	// An error message if the instance is in an error state.
	Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"`
}

InstanceResponseBody is used to define fields on response body types.

type InstanceResponseBodyAbbreviated 

type InstanceResponseBodyAbbreviated struct {
	// Unique identifier for the instance.
	ID string `form:"id" json:"id" xml:"id"`
	// The ID of the host this instance is running on.
	HostID string `form:"host_id" json:"host_id" xml:"host_id"`
	// The Spock node name for this instance.
	NodeName string `form:"node_name" json:"node_name" xml:"node_name"`
	State    string `form:"state" json:"state" xml:"state"`
}

InstanceResponseBodyAbbreviated is used to define fields on response body types.

type InstanceResponseBodyAbbreviatedCollection 

type InstanceResponseBodyAbbreviatedCollection []*InstanceResponseBodyAbbreviated

InstanceResponseBodyAbbreviatedCollection is used to define fields on response body types.

type InstanceResponseBodyCollection 

type InstanceResponseBodyCollection []*InstanceResponseBody

InstanceResponseBodyCollection is used to define fields on response body types.

type InstanceSpockStatusResponseBody 

type InstanceSpockStatusResponseBody struct {
	// The current spock.readonly setting.
	ReadOnly *string `form:"read_only,omitempty" json:"read_only,omitempty" xml:"read_only,omitempty"`
	// The version of Spock for this instance.
	Version *string `form:"version,omitempty" json:"version,omitempty" xml:"version,omitempty"`
	// Status information for this instance's Spock subscriptions.
	Subscriptions []*InstanceSubscriptionResponseBody `form:"subscriptions,omitempty" json:"subscriptions,omitempty" xml:"subscriptions,omitempty"`
}

InstanceSpockStatusResponseBody is used to define fields on response body types.

type InstanceSubscriptionResponseBody 

type InstanceSubscriptionResponseBody struct {
	// The Spock node name of the provider for this subscription.
	ProviderNode string `form:"provider_node" json:"provider_node" xml:"provider_node"`
	// The name of the subscription.
	Name string `form:"name" json:"name" xml:"name"`
	// The current status of the subscription.
	Status string `form:"status" json:"status" xml:"status"`
}

InstanceSubscriptionResponseBody is used to define fields on response body types.

type JoinClusterClusterAlreadyInitializedResponseBody 

type JoinClusterClusterAlreadyInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

JoinClusterClusterAlreadyInitializedResponseBody is the type of the "control-plane" service "join-cluster" endpoint HTTP response body for the "cluster_already_initialized" error.

func NewJoinClusterClusterAlreadyInitializedResponseBody 

func NewJoinClusterClusterAlreadyInitializedResponseBody(res *controlplane.APIError) *JoinClusterClusterAlreadyInitializedResponseBody

NewJoinClusterClusterAlreadyInitializedResponseBody builds the HTTP response body from the result of the "join-cluster" endpoint of the "control-plane" service.

type JoinClusterInvalidInputResponseBody added in v0.6.0 

type JoinClusterInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

JoinClusterInvalidInputResponseBody is the type of the "control-plane" service "join-cluster" endpoint HTTP response body for the "invalid_input" error.

func NewJoinClusterInvalidInputResponseBody added in v0.6.0 

func NewJoinClusterInvalidInputResponseBody(res *controlplane.APIError) *JoinClusterInvalidInputResponseBody

NewJoinClusterInvalidInputResponseBody builds the HTTP response body from the result of the "join-cluster" endpoint of the "control-plane" service.

type JoinClusterInvalidJoinTokenResponseBody 

type JoinClusterInvalidJoinTokenResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

JoinClusterInvalidJoinTokenResponseBody is the type of the "control-plane" service "join-cluster" endpoint HTTP response body for the "invalid_join_token" error.

func NewJoinClusterInvalidJoinTokenResponseBody 

func NewJoinClusterInvalidJoinTokenResponseBody(res *controlplane.APIError) *JoinClusterInvalidJoinTokenResponseBody

NewJoinClusterInvalidJoinTokenResponseBody builds the HTTP response body from the result of the "join-cluster" endpoint of the "control-plane" service.

type JoinClusterRequestBody 

type JoinClusterRequestBody struct {
	// Token to join an existing cluster.
	Token *string `form:"token,omitempty" json:"token,omitempty" xml:"token,omitempty"`
	// Existing server to join
	ServerURL *string `form:"server_url,omitempty" json:"server_url,omitempty" xml:"server_url,omitempty"`
}

JoinClusterRequestBody is the type of the "control-plane" service "join-cluster" endpoint HTTP request body.

type JoinClusterServerErrorResponseBody 

type JoinClusterServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

JoinClusterServerErrorResponseBody is the type of the "control-plane" service "join-cluster" endpoint HTTP response body for the "server_error" error.

func NewJoinClusterServerErrorResponseBody 

func NewJoinClusterServerErrorResponseBody(res *controlplane.APIError) *JoinClusterServerErrorResponseBody

NewJoinClusterServerErrorResponseBody builds the HTTP response body from the result of the "join-cluster" endpoint of the "control-plane" service.

type ListDatabaseTasksClusterNotInitializedResponseBody 

type ListDatabaseTasksClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListDatabaseTasksClusterNotInitializedResponseBody is the type of the "control-plane" service "list-database-tasks" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewListDatabaseTasksClusterNotInitializedResponseBody 

func NewListDatabaseTasksClusterNotInitializedResponseBody(res *controlplane.APIError) *ListDatabaseTasksClusterNotInitializedResponseBody

NewListDatabaseTasksClusterNotInitializedResponseBody builds the HTTP response body from the result of the "list-database-tasks" endpoint of the "control-plane" service.

type ListDatabaseTasksInvalidInputResponseBody 

type ListDatabaseTasksInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListDatabaseTasksInvalidInputResponseBody is the type of the "control-plane" service "list-database-tasks" endpoint HTTP response body for the "invalid_input" error.

func NewListDatabaseTasksInvalidInputResponseBody 

func NewListDatabaseTasksInvalidInputResponseBody(res *controlplane.APIError) *ListDatabaseTasksInvalidInputResponseBody

NewListDatabaseTasksInvalidInputResponseBody builds the HTTP response body from the result of the "list-database-tasks" endpoint of the "control-plane" service.

type ListDatabaseTasksNotFoundResponseBody 

type ListDatabaseTasksNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListDatabaseTasksNotFoundResponseBody is the type of the "control-plane" service "list-database-tasks" endpoint HTTP response body for the "not_found" error.

func NewListDatabaseTasksNotFoundResponseBody 

func NewListDatabaseTasksNotFoundResponseBody(res *controlplane.APIError) *ListDatabaseTasksNotFoundResponseBody

NewListDatabaseTasksNotFoundResponseBody builds the HTTP response body from the result of the "list-database-tasks" endpoint of the "control-plane" service.

type ListDatabaseTasksResponseBody 

type ListDatabaseTasksResponseBody struct {
	Tasks []*TaskResponseBody `form:"tasks,omitempty" json:"tasks,omitempty" xml:"tasks,omitempty"`
}

ListDatabaseTasksResponseBody is the type of the "control-plane" service "list-database-tasks" endpoint HTTP response body.

func NewListDatabaseTasksResponseBody 

func NewListDatabaseTasksResponseBody(res *controlplane.ListDatabaseTasksResponse) *ListDatabaseTasksResponseBody

NewListDatabaseTasksResponseBody builds the HTTP response body from the result of the "list-database-tasks" endpoint of the "control-plane" service.

type ListDatabaseTasksServerErrorResponseBody 

type ListDatabaseTasksServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListDatabaseTasksServerErrorResponseBody is the type of the "control-plane" service "list-database-tasks" endpoint HTTP response body for the "server_error" error.

func NewListDatabaseTasksServerErrorResponseBody 

func NewListDatabaseTasksServerErrorResponseBody(res *controlplane.APIError) *ListDatabaseTasksServerErrorResponseBody

NewListDatabaseTasksServerErrorResponseBody builds the HTTP response body from the result of the "list-database-tasks" endpoint of the "control-plane" service.

type ListDatabasesClusterNotInitializedResponseBody 

type ListDatabasesClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListDatabasesClusterNotInitializedResponseBody is the type of the "control-plane" service "list-databases" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewListDatabasesClusterNotInitializedResponseBody 

func NewListDatabasesClusterNotInitializedResponseBody(res *controlplane.APIError) *ListDatabasesClusterNotInitializedResponseBody

NewListDatabasesClusterNotInitializedResponseBody builds the HTTP response body from the result of the "list-databases" endpoint of the "control-plane" service.

type ListDatabasesResponseBody 

type ListDatabasesResponseBody struct {
	Databases DatabaseResponseBodyAbbreviatedCollection `form:"databases,omitempty" json:"databases,omitempty" xml:"databases,omitempty"`
}

ListDatabasesResponseBody is the type of the "control-plane" service "list-databases" endpoint HTTP response body.

func NewListDatabasesResponseBody 

func NewListDatabasesResponseBody(res *controlplaneviews.ListDatabasesResponseView) *ListDatabasesResponseBody

NewListDatabasesResponseBody builds the HTTP response body from the result of the "list-databases" endpoint of the "control-plane" service.

type ListDatabasesServerErrorResponseBody 

type ListDatabasesServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListDatabasesServerErrorResponseBody is the type of the "control-plane" service "list-databases" endpoint HTTP response body for the "server_error" error.

func NewListDatabasesServerErrorResponseBody 

func NewListDatabasesServerErrorResponseBody(res *controlplane.APIError) *ListDatabasesServerErrorResponseBody

NewListDatabasesServerErrorResponseBody builds the HTTP response body from the result of the "list-databases" endpoint of the "control-plane" service.

type ListHostsClusterNotInitializedResponseBody 

type ListHostsClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListHostsClusterNotInitializedResponseBody is the type of the "control-plane" service "list-hosts" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewListHostsClusterNotInitializedResponseBody 

func NewListHostsClusterNotInitializedResponseBody(res *controlplane.APIError) *ListHostsClusterNotInitializedResponseBody

NewListHostsClusterNotInitializedResponseBody builds the HTTP response body from the result of the "list-hosts" endpoint of the "control-plane" service.

type ListHostsResponseBody 

type ListHostsResponseBody struct {
	// List of hosts in the cluster
	Hosts []*HostResponseBody `form:"hosts" json:"hosts" xml:"hosts"`
}

ListHostsResponseBody is the type of the "control-plane" service "list-hosts" endpoint HTTP response body.

func NewListHostsResponseBody 

func NewListHostsResponseBody(res *controlplane.ListHostsResponse) *ListHostsResponseBody

NewListHostsResponseBody builds the HTTP response body from the result of the "list-hosts" endpoint of the "control-plane" service.

type ListHostsServerErrorResponseBody 

type ListHostsServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

ListHostsServerErrorResponseBody is the type of the "control-plane" service "list-hosts" endpoint HTTP response body for the "server_error" error.

func NewListHostsServerErrorResponseBody 

func NewListHostsServerErrorResponseBody(res *controlplane.APIError) *ListHostsServerErrorResponseBody

NewListHostsServerErrorResponseBody builds the HTTP response body from the result of the "list-hosts" endpoint of the "control-plane" service.

type MountPoint 

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type OrchestratorOptsRequestBody 

type OrchestratorOptsRequestBody struct {
	// Swarm-specific configuration.
	Swarm *SwarmOptsRequestBody `form:"swarm,omitempty" json:"swarm,omitempty" xml:"swarm,omitempty"`
}

OrchestratorOptsRequestBody is used to define fields on request body types.

type OrchestratorOptsRequestBodyRequestBody 

type OrchestratorOptsRequestBodyRequestBody struct {
	// Swarm-specific configuration.
	Swarm *SwarmOptsRequestBodyRequestBody `form:"swarm,omitempty" json:"swarm,omitempty" xml:"swarm,omitempty"`
}

OrchestratorOptsRequestBodyRequestBody is used to define fields on request body types.

type OrchestratorOptsResponseBody 

type OrchestratorOptsResponseBody struct {
	// Swarm-specific configuration.
	Swarm *SwarmOptsResponseBody `form:"swarm,omitempty" json:"swarm,omitempty" xml:"swarm,omitempty"`
}

OrchestratorOptsResponseBody is used to define fields on response body types.

type PgEdgeVersionResponseBody 

type PgEdgeVersionResponseBody struct {
	// The Postgres major and minor version.
	PostgresVersion string `form:"postgres_version" json:"postgres_version" xml:"postgres_version"`
	// The Spock major version.
	SpockVersion string `form:"spock_version" json:"spock_version" xml:"spock_version"`
}

PgEdgeVersionResponseBody is used to define fields on response body types.

type RemoveHostClusterNotInitializedResponseBody 

type RemoveHostClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RemoveHostClusterNotInitializedResponseBody is the type of the "control-plane" service "remove-host" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewRemoveHostClusterNotInitializedResponseBody 

func NewRemoveHostClusterNotInitializedResponseBody(res *controlplane.APIError) *RemoveHostClusterNotInitializedResponseBody

NewRemoveHostClusterNotInitializedResponseBody builds the HTTP response body from the result of the "remove-host" endpoint of the "control-plane" service.

type RemoveHostInvalidInputResponseBody 

type RemoveHostInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RemoveHostInvalidInputResponseBody is the type of the "control-plane" service "remove-host" endpoint HTTP response body for the "invalid_input" error.

func NewRemoveHostInvalidInputResponseBody 

func NewRemoveHostInvalidInputResponseBody(res *controlplane.APIError) *RemoveHostInvalidInputResponseBody

NewRemoveHostInvalidInputResponseBody builds the HTTP response body from the result of the "remove-host" endpoint of the "control-plane" service.

type RemoveHostNotFoundResponseBody 

type RemoveHostNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RemoveHostNotFoundResponseBody is the type of the "control-plane" service "remove-host" endpoint HTTP response body for the "not_found" error.

func NewRemoveHostNotFoundResponseBody 

func NewRemoveHostNotFoundResponseBody(res *controlplane.APIError) *RemoveHostNotFoundResponseBody

NewRemoveHostNotFoundResponseBody builds the HTTP response body from the result of the "remove-host" endpoint of the "control-plane" service.

type RemoveHostResponseBody added in v0.6.0 

type RemoveHostResponseBody struct {
	// The tasks that will update databases affected by the host removal.
	UpdateDatabaseTasks []*TaskResponseBody `form:"update_database_tasks" json:"update_database_tasks" xml:"update_database_tasks"`
}

RemoveHostResponseBody is the type of the "control-plane" service "remove-host" endpoint HTTP response body.

func NewRemoveHostResponseBody added in v0.6.0 

func NewRemoveHostResponseBody(res *controlplane.RemoveHostResponse) *RemoveHostResponseBody

NewRemoveHostResponseBody builds the HTTP response body from the result of the "remove-host" endpoint of the "control-plane" service.

type RemoveHostServerErrorResponseBody 

type RemoveHostServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RemoveHostServerErrorResponseBody is the type of the "control-plane" service "remove-host" endpoint HTTP response body for the "server_error" error.

func NewRemoveHostServerErrorResponseBody 

func NewRemoveHostServerErrorResponseBody(res *controlplane.APIError) *RemoveHostServerErrorResponseBody

NewRemoveHostServerErrorResponseBody builds the HTTP response body from the result of the "remove-host" endpoint of the "control-plane" service.

type RestartInstanceClusterNotInitializedResponseBody 

type RestartInstanceClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestartInstanceClusterNotInitializedResponseBody is the type of the "control-plane" service "restart-instance" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewRestartInstanceClusterNotInitializedResponseBody 

func NewRestartInstanceClusterNotInitializedResponseBody(res *controlplane.APIError) *RestartInstanceClusterNotInitializedResponseBody

NewRestartInstanceClusterNotInitializedResponseBody builds the HTTP response body from the result of the "restart-instance" endpoint of the "control-plane" service.

type RestartInstanceInvalidInputResponseBody 

type RestartInstanceInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestartInstanceInvalidInputResponseBody is the type of the "control-plane" service "restart-instance" endpoint HTTP response body for the "invalid_input" error.

func NewRestartInstanceInvalidInputResponseBody 

func NewRestartInstanceInvalidInputResponseBody(res *controlplane.APIError) *RestartInstanceInvalidInputResponseBody

NewRestartInstanceInvalidInputResponseBody builds the HTTP response body from the result of the "restart-instance" endpoint of the "control-plane" service.

type RestartInstanceNotFoundResponseBody 

type RestartInstanceNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestartInstanceNotFoundResponseBody is the type of the "control-plane" service "restart-instance" endpoint HTTP response body for the "not_found" error.

func NewRestartInstanceNotFoundResponseBody 

func NewRestartInstanceNotFoundResponseBody(res *controlplane.APIError) *RestartInstanceNotFoundResponseBody

NewRestartInstanceNotFoundResponseBody builds the HTTP response body from the result of the "restart-instance" endpoint of the "control-plane" service.

type RestartInstanceResponseBody 

type RestartInstanceResponseBody struct {
	// Task representing the restart operation
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

RestartInstanceResponseBody is the type of the "control-plane" service "restart-instance" endpoint HTTP response body.

func NewRestartInstanceResponseBody 

func NewRestartInstanceResponseBody(res *controlplane.RestartInstanceResponse) *RestartInstanceResponseBody

NewRestartInstanceResponseBody builds the HTTP response body from the result of the "restart-instance" endpoint of the "control-plane" service.

type RestartInstanceServerErrorResponseBody 

type RestartInstanceServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestartInstanceServerErrorResponseBody is the type of the "control-plane" service "restart-instance" endpoint HTTP response body for the "server_error" error.

func NewRestartInstanceServerErrorResponseBody 

func NewRestartInstanceServerErrorResponseBody(res *controlplane.APIError) *RestartInstanceServerErrorResponseBody

NewRestartInstanceServerErrorResponseBody builds the HTTP response body from the result of the "restart-instance" endpoint of the "control-plane" service.

type RestoreConfigSpecRequestBody 

type RestoreConfigSpecRequestBody struct {
	// The ID of the database to restore this database from.
	SourceDatabaseID *string `form:"source_database_id,omitempty" json:"source_database_id,omitempty" xml:"source_database_id,omitempty"`
	// The name of the node to restore this database from.
	SourceNodeName *string `form:"source_node_name,omitempty" json:"source_node_name,omitempty" xml:"source_node_name,omitempty"`
	// The name of the database in this repository. The database will be renamed to
	// the database_name in the DatabaseSpec after it's restored.
	SourceDatabaseName *string `form:"source_database_name,omitempty" json:"source_database_name,omitempty" xml:"source_database_name,omitempty"`
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecRequestBody `form:"repository,omitempty" json:"repository,omitempty" xml:"repository,omitempty"`
	// Additional options to use when restoring this database. If omitted, the
	// database will be restored to the latest point in the given repository.
	RestoreOptions map[string]string `form:"restore_options,omitempty" json:"restore_options,omitempty" xml:"restore_options,omitempty"`
}

RestoreConfigSpecRequestBody is used to define fields on request body types.

type RestoreConfigSpecRequestBodyRequestBody 

type RestoreConfigSpecRequestBodyRequestBody struct {
	// The ID of the database to restore this database from.
	SourceDatabaseID *string `form:"source_database_id,omitempty" json:"source_database_id,omitempty" xml:"source_database_id,omitempty"`
	// The name of the node to restore this database from.
	SourceNodeName *string `form:"source_node_name,omitempty" json:"source_node_name,omitempty" xml:"source_node_name,omitempty"`
	// The name of the database in this repository. The database will be renamed to
	// the database_name in the DatabaseSpec after it's restored.
	SourceDatabaseName *string `form:"source_database_name,omitempty" json:"source_database_name,omitempty" xml:"source_database_name,omitempty"`
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecRequestBodyRequestBody `form:"repository,omitempty" json:"repository,omitempty" xml:"repository,omitempty"`
	// Additional options to use when restoring this database. If omitted, the
	// database will be restored to the latest point in the given repository.
	RestoreOptions map[string]string `form:"restore_options,omitempty" json:"restore_options,omitempty" xml:"restore_options,omitempty"`
}

RestoreConfigSpecRequestBodyRequestBody is used to define fields on request body types.

type RestoreConfigSpecResponseBody 

type RestoreConfigSpecResponseBody struct {
	// The ID of the database to restore this database from.
	SourceDatabaseID string `form:"source_database_id" json:"source_database_id" xml:"source_database_id"`
	// The name of the node to restore this database from.
	SourceNodeName string `form:"source_node_name" json:"source_node_name" xml:"source_node_name"`
	// The name of the database in this repository. The database will be renamed to
	// the database_name in the DatabaseSpec after it's restored.
	SourceDatabaseName string `form:"source_database_name" json:"source_database_name" xml:"source_database_name"`
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecResponseBody `form:"repository" json:"repository" xml:"repository"`
	// Additional options to use when restoring this database. If omitted, the
	// database will be restored to the latest point in the given repository.
	RestoreOptions map[string]string `form:"restore_options,omitempty" json:"restore_options,omitempty" xml:"restore_options,omitempty"`
}

RestoreConfigSpecResponseBody is used to define fields on response body types.

type RestoreDatabaseClusterNotInitializedResponseBody 

type RestoreDatabaseClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestoreDatabaseClusterNotInitializedResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewRestoreDatabaseClusterNotInitializedResponseBody 

func NewRestoreDatabaseClusterNotInitializedResponseBody(res *controlplane.APIError) *RestoreDatabaseClusterNotInitializedResponseBody

NewRestoreDatabaseClusterNotInitializedResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseDatabaseNotModifiableResponseBody 

type RestoreDatabaseDatabaseNotModifiableResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestoreDatabaseDatabaseNotModifiableResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body for the "database_not_modifiable" error.

func NewRestoreDatabaseDatabaseNotModifiableResponseBody 

func NewRestoreDatabaseDatabaseNotModifiableResponseBody(res *controlplane.APIError) *RestoreDatabaseDatabaseNotModifiableResponseBody

NewRestoreDatabaseDatabaseNotModifiableResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseInvalidInputResponseBody 

type RestoreDatabaseInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestoreDatabaseInvalidInputResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body for the "invalid_input" error.

func NewRestoreDatabaseInvalidInputResponseBody 

func NewRestoreDatabaseInvalidInputResponseBody(res *controlplane.APIError) *RestoreDatabaseInvalidInputResponseBody

NewRestoreDatabaseInvalidInputResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseNotFoundResponseBody 

type RestoreDatabaseNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestoreDatabaseNotFoundResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body for the "not_found" error.

func NewRestoreDatabaseNotFoundResponseBody 

func NewRestoreDatabaseNotFoundResponseBody(res *controlplane.APIError) *RestoreDatabaseNotFoundResponseBody

NewRestoreDatabaseNotFoundResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseOperationAlreadyInProgressResponseBody 

type RestoreDatabaseOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestoreDatabaseOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewRestoreDatabaseOperationAlreadyInProgressResponseBody 

func NewRestoreDatabaseOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *RestoreDatabaseOperationAlreadyInProgressResponseBody

NewRestoreDatabaseOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseRequestBody 

type RestoreDatabaseRequestBody struct {
	// Configuration for the restore process.
	RestoreConfig *RestoreConfigSpecRequestBodyRequestBody `form:"restore_config,omitempty" json:"restore_config,omitempty" xml:"restore_config,omitempty"`
	// The nodes to restore. Defaults to all nodes if empty or unspecified.
	TargetNodes []string `form:"target_nodes,omitempty" json:"target_nodes,omitempty" xml:"target_nodes,omitempty"`
}

RestoreDatabaseRequestBody is the type of the "control-plane" service "restore-database" endpoint HTTP request body.

type RestoreDatabaseResponseBody 

type RestoreDatabaseResponseBody struct {
	// The task that will restore this database.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
	// The tasks that will restore each database node.
	NodeTasks []*TaskResponseBody `form:"node_tasks" json:"node_tasks" xml:"node_tasks"`
	// The database being restored.
	Database *DatabaseResponseBody `form:"database" json:"database" xml:"database"`
}

RestoreDatabaseResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body.

func NewRestoreDatabaseResponseBody 

func NewRestoreDatabaseResponseBody(res *controlplane.RestoreDatabaseResponse) *RestoreDatabaseResponseBody

NewRestoreDatabaseResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseServerErrorResponseBody 

type RestoreDatabaseServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

RestoreDatabaseServerErrorResponseBody is the type of the "control-plane" service "restore-database" endpoint HTTP response body for the "server_error" error.

func NewRestoreDatabaseServerErrorResponseBody 

func NewRestoreDatabaseServerErrorResponseBody(res *controlplane.APIError) *RestoreDatabaseServerErrorResponseBody

NewRestoreDatabaseServerErrorResponseBody builds the HTTP response body from the result of the "restore-database" endpoint of the "control-plane" service.

type RestoreRepositorySpecRequestBody 

type RestoreRepositorySpecRequestBody struct {
	// The unique identifier of this repository.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of this repository.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `form:"s3_bucket,omitempty" json:"s3_bucket,omitempty" xml:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `form:"s3_region,omitempty" json:"s3_region,omitempty" xml:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `form:"s3_endpoint,omitempty" json:"s3_endpoint,omitempty" xml:"s3_endpoint,omitempty"`
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain.
	S3Key *string `form:"s3_key,omitempty" json:"s3_key,omitempty" xml:"s3_key,omitempty"`
	// The corresponding secret for the AWS access key ID in s3_key.
	S3KeySecret *string `form:"s3_key_secret,omitempty" json:"s3_key_secret,omitempty" xml:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `form:"gcs_bucket,omitempty" json:"gcs_bucket,omitempty" xml:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `form:"gcs_endpoint,omitempty" json:"gcs_endpoint,omitempty" xml:"gcs_endpoint,omitempty"`
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile.
	GcsKey *string `form:"gcs_key,omitempty" json:"gcs_key,omitempty" xml:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `form:"azure_account,omitempty" json:"azure_account,omitempty" xml:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `form:"azure_container,omitempty" json:"azure_container,omitempty" xml:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `form:"azure_endpoint,omitempty" json:"azure_endpoint,omitempty" xml:"azure_endpoint,omitempty"`
	// An optional Azure storage account access key to use for this repository. If
	// not provided, pgbackrest will use the VM's managed identity.
	AzureKey *string `form:"azure_key,omitempty" json:"azure_key,omitempty" xml:"azure_key,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `form:"base_path,omitempty" json:"base_path,omitempty" xml:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `form:"custom_options,omitempty" json:"custom_options,omitempty" xml:"custom_options,omitempty"`
}

RestoreRepositorySpecRequestBody is used to define fields on request body types.

type RestoreRepositorySpecRequestBodyRequestBody 

type RestoreRepositorySpecRequestBodyRequestBody struct {
	// The unique identifier of this repository.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of this repository.
	Type *string `form:"type,omitempty" json:"type,omitempty" xml:"type,omitempty"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `form:"s3_bucket,omitempty" json:"s3_bucket,omitempty" xml:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `form:"s3_region,omitempty" json:"s3_region,omitempty" xml:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `form:"s3_endpoint,omitempty" json:"s3_endpoint,omitempty" xml:"s3_endpoint,omitempty"`
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain.
	S3Key *string `form:"s3_key,omitempty" json:"s3_key,omitempty" xml:"s3_key,omitempty"`
	// The corresponding secret for the AWS access key ID in s3_key.
	S3KeySecret *string `form:"s3_key_secret,omitempty" json:"s3_key_secret,omitempty" xml:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `form:"gcs_bucket,omitempty" json:"gcs_bucket,omitempty" xml:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `form:"gcs_endpoint,omitempty" json:"gcs_endpoint,omitempty" xml:"gcs_endpoint,omitempty"`
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile.
	GcsKey *string `form:"gcs_key,omitempty" json:"gcs_key,omitempty" xml:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `form:"azure_account,omitempty" json:"azure_account,omitempty" xml:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `form:"azure_container,omitempty" json:"azure_container,omitempty" xml:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `form:"azure_endpoint,omitempty" json:"azure_endpoint,omitempty" xml:"azure_endpoint,omitempty"`
	// An optional Azure storage account access key to use for this repository. If
	// not provided, pgbackrest will use the VM's managed identity.
	AzureKey *string `form:"azure_key,omitempty" json:"azure_key,omitempty" xml:"azure_key,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `form:"base_path,omitempty" json:"base_path,omitempty" xml:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `form:"custom_options,omitempty" json:"custom_options,omitempty" xml:"custom_options,omitempty"`
}

RestoreRepositorySpecRequestBodyRequestBody is used to define fields on request body types.

type RestoreRepositorySpecResponseBody 

type RestoreRepositorySpecResponseBody struct {
	// The unique identifier of this repository.
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// The type of this repository.
	Type string `form:"type" json:"type" xml:"type"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `form:"s3_bucket,omitempty" json:"s3_bucket,omitempty" xml:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `form:"s3_region,omitempty" json:"s3_region,omitempty" xml:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `form:"s3_endpoint,omitempty" json:"s3_endpoint,omitempty" xml:"s3_endpoint,omitempty"`
	// An optional AWS access key ID to use for this repository. If not provided,
	// pgbackrest will use the default credential provider chain.
	S3Key *string `form:"s3_key,omitempty" json:"s3_key,omitempty" xml:"s3_key,omitempty"`
	// The corresponding secret for the AWS access key ID in s3_key.
	S3KeySecret *string `form:"s3_key_secret,omitempty" json:"s3_key_secret,omitempty" xml:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `form:"gcs_bucket,omitempty" json:"gcs_bucket,omitempty" xml:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `form:"gcs_endpoint,omitempty" json:"gcs_endpoint,omitempty" xml:"gcs_endpoint,omitempty"`
	// Optional base64-encoded private key data. If omitted, pgbackrest will use
	// the service account attached to the instance profile.
	GcsKey *string `form:"gcs_key,omitempty" json:"gcs_key,omitempty" xml:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `form:"azure_account,omitempty" json:"azure_account,omitempty" xml:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `form:"azure_container,omitempty" json:"azure_container,omitempty" xml:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `form:"azure_endpoint,omitempty" json:"azure_endpoint,omitempty" xml:"azure_endpoint,omitempty"`
	// An optional Azure storage account access key to use for this repository. If
	// not provided, pgbackrest will use the VM's managed identity.
	AzureKey *string `form:"azure_key,omitempty" json:"azure_key,omitempty" xml:"azure_key,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `form:"base_path,omitempty" json:"base_path,omitempty" xml:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `form:"custom_options,omitempty" json:"custom_options,omitempty" xml:"custom_options,omitempty"`
}

RestoreRepositorySpecResponseBody is used to define fields on response body types.

type Server 

type Server struct {
	Mounts                 []*MountPoint
	InitCluster            http.Handler
	JoinCluster            http.Handler
	GetJoinToken           http.Handler
	GetJoinOptions         http.Handler
	GetCluster             http.Handler
	ListHosts              http.Handler
	GetHost                http.Handler
	RemoveHost             http.Handler
	ListDatabases          http.Handler
	CreateDatabase         http.Handler
	GetDatabase            http.Handler
	UpdateDatabase         http.Handler
	DeleteDatabase         http.Handler
	BackupDatabaseNode     http.Handler
	SwitchoverDatabaseNode http.Handler
	FailoverDatabaseNode   http.Handler
	ListDatabaseTasks      http.Handler
	GetDatabaseTask        http.Handler
	GetDatabaseTaskLog     http.Handler
	RestoreDatabase        http.Handler
	GetVersion             http.Handler
	RestartInstance        http.Handler
	StopInstance           http.Handler
	StartInstance          http.Handler
	CancelDatabaseTask     http.Handler
	GenHTTPOpenapi3JSON    http.Handler
}

Server lists the control-plane service endpoint HTTP handlers.

func New 

func New(
	e *controlplane.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(ctx context.Context, err error) goahttp.Statuser,
	fileSystemGenHTTPOpenapi3JSON http.FileSystem,
) *Server

New instantiates HTTP handlers for all the control-plane service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) MethodNames 

func (s *Server) MethodNames() []string

MethodNames returns the methods served.

func (*Server) Mount 

func (s *Server) Mount(mux goahttp.Muxer)

Mount configures the mux to serve the control-plane endpoints.

func (*Server) Service 

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use 

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.

type StartInstanceClusterNotInitializedResponseBody 

type StartInstanceClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StartInstanceClusterNotInitializedResponseBody is the type of the "control-plane" service "start-instance" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewStartInstanceClusterNotInitializedResponseBody 

func NewStartInstanceClusterNotInitializedResponseBody(res *controlplane.APIError) *StartInstanceClusterNotInitializedResponseBody

NewStartInstanceClusterNotInitializedResponseBody builds the HTTP response body from the result of the "start-instance" endpoint of the "control-plane" service.

type StartInstanceInvalidInputResponseBody 

type StartInstanceInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StartInstanceInvalidInputResponseBody is the type of the "control-plane" service "start-instance" endpoint HTTP response body for the "invalid_input" error.

func NewStartInstanceInvalidInputResponseBody 

func NewStartInstanceInvalidInputResponseBody(res *controlplane.APIError) *StartInstanceInvalidInputResponseBody

NewStartInstanceInvalidInputResponseBody builds the HTTP response body from the result of the "start-instance" endpoint of the "control-plane" service.

type StartInstanceNotFoundResponseBody 

type StartInstanceNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StartInstanceNotFoundResponseBody is the type of the "control-plane" service "start-instance" endpoint HTTP response body for the "not_found" error.

func NewStartInstanceNotFoundResponseBody 

func NewStartInstanceNotFoundResponseBody(res *controlplane.APIError) *StartInstanceNotFoundResponseBody

NewStartInstanceNotFoundResponseBody builds the HTTP response body from the result of the "start-instance" endpoint of the "control-plane" service.

type StartInstanceResponseBody 

type StartInstanceResponseBody struct {
	// Task representing the start operation
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

StartInstanceResponseBody is the type of the "control-plane" service "start-instance" endpoint HTTP response body.

func NewStartInstanceResponseBody 

func NewStartInstanceResponseBody(res *controlplane.StartInstanceResponse) *StartInstanceResponseBody

NewStartInstanceResponseBody builds the HTTP response body from the result of the "start-instance" endpoint of the "control-plane" service.

type StartInstanceServerErrorResponseBody 

type StartInstanceServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StartInstanceServerErrorResponseBody is the type of the "control-plane" service "start-instance" endpoint HTTP response body for the "server_error" error.

func NewStartInstanceServerErrorResponseBody 

func NewStartInstanceServerErrorResponseBody(res *controlplane.APIError) *StartInstanceServerErrorResponseBody

NewStartInstanceServerErrorResponseBody builds the HTTP response body from the result of the "start-instance" endpoint of the "control-plane" service.

type StopInstanceClusterNotInitializedResponseBody 

type StopInstanceClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StopInstanceClusterNotInitializedResponseBody is the type of the "control-plane" service "stop-instance" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewStopInstanceClusterNotInitializedResponseBody 

func NewStopInstanceClusterNotInitializedResponseBody(res *controlplane.APIError) *StopInstanceClusterNotInitializedResponseBody

NewStopInstanceClusterNotInitializedResponseBody builds the HTTP response body from the result of the "stop-instance" endpoint of the "control-plane" service.

type StopInstanceInvalidInputResponseBody 

type StopInstanceInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StopInstanceInvalidInputResponseBody is the type of the "control-plane" service "stop-instance" endpoint HTTP response body for the "invalid_input" error.

func NewStopInstanceInvalidInputResponseBody 

func NewStopInstanceInvalidInputResponseBody(res *controlplane.APIError) *StopInstanceInvalidInputResponseBody

NewStopInstanceInvalidInputResponseBody builds the HTTP response body from the result of the "stop-instance" endpoint of the "control-plane" service.

type StopInstanceNotFoundResponseBody 

type StopInstanceNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StopInstanceNotFoundResponseBody is the type of the "control-plane" service "stop-instance" endpoint HTTP response body for the "not_found" error.

func NewStopInstanceNotFoundResponseBody 

func NewStopInstanceNotFoundResponseBody(res *controlplane.APIError) *StopInstanceNotFoundResponseBody

NewStopInstanceNotFoundResponseBody builds the HTTP response body from the result of the "stop-instance" endpoint of the "control-plane" service.

type StopInstanceResponseBody 

type StopInstanceResponseBody struct {
	// Task representing the stop operation
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

StopInstanceResponseBody is the type of the "control-plane" service "stop-instance" endpoint HTTP response body.

func NewStopInstanceResponseBody 

func NewStopInstanceResponseBody(res *controlplane.StopInstanceResponse) *StopInstanceResponseBody

NewStopInstanceResponseBody builds the HTTP response body from the result of the "stop-instance" endpoint of the "control-plane" service.

type StopInstanceServerErrorResponseBody 

type StopInstanceServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

StopInstanceServerErrorResponseBody is the type of the "control-plane" service "stop-instance" endpoint HTTP response body for the "server_error" error.

func NewStopInstanceServerErrorResponseBody 

func NewStopInstanceServerErrorResponseBody(res *controlplane.APIError) *StopInstanceServerErrorResponseBody

NewStopInstanceServerErrorResponseBody builds the HTTP response body from the result of the "stop-instance" endpoint of the "control-plane" service.

type SwarmOptsRequestBody 

type SwarmOptsRequestBody struct {
	// A list of extra volumes to mount. Each entry defines a host and container
	// path.
	ExtraVolumes []*ExtraVolumesSpecRequestBody `form:"extra_volumes,omitempty" json:"extra_volumes,omitempty" xml:"extra_volumes,omitempty"`
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecRequestBody `form:"extra_networks,omitempty" json:"extra_networks,omitempty" xml:"extra_networks,omitempty"`
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string `form:"extra_labels,omitempty" json:"extra_labels,omitempty" xml:"extra_labels,omitempty"`
}

SwarmOptsRequestBody is used to define fields on request body types.

type SwarmOptsRequestBodyRequestBody 

type SwarmOptsRequestBodyRequestBody struct {
	// A list of extra volumes to mount. Each entry defines a host and container
	// path.
	ExtraVolumes []*ExtraVolumesSpecRequestBodyRequestBody `form:"extra_volumes,omitempty" json:"extra_volumes,omitempty" xml:"extra_volumes,omitempty"`
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecRequestBodyRequestBody `form:"extra_networks,omitempty" json:"extra_networks,omitempty" xml:"extra_networks,omitempty"`
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string `form:"extra_labels,omitempty" json:"extra_labels,omitempty" xml:"extra_labels,omitempty"`
}

SwarmOptsRequestBodyRequestBody is used to define fields on request body types.

type SwarmOptsResponseBody 

type SwarmOptsResponseBody struct {
	// A list of extra volumes to mount. Each entry defines a host and container
	// path.
	ExtraVolumes []*ExtraVolumesSpecResponseBody `form:"extra_volumes,omitempty" json:"extra_volumes,omitempty" xml:"extra_volumes,omitempty"`
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecResponseBody `form:"extra_networks,omitempty" json:"extra_networks,omitempty" xml:"extra_networks,omitempty"`
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string `form:"extra_labels,omitempty" json:"extra_labels,omitempty" xml:"extra_labels,omitempty"`
}

SwarmOptsResponseBody is used to define fields on response body types.

type SwitchoverDatabaseNodeClusterNotInitializedResponseBody 

type SwitchoverDatabaseNodeClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

SwitchoverDatabaseNodeClusterNotInitializedResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewSwitchoverDatabaseNodeClusterNotInitializedResponseBody 

func NewSwitchoverDatabaseNodeClusterNotInitializedResponseBody(res *controlplane.APIError) *SwitchoverDatabaseNodeClusterNotInitializedResponseBody

NewSwitchoverDatabaseNodeClusterNotInitializedResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody 

type SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body for the "database_not_modifiable" error.

func NewSwitchoverDatabaseNodeDatabaseNotModifiableResponseBody 

func NewSwitchoverDatabaseNodeDatabaseNotModifiableResponseBody(res *controlplane.APIError) *SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody

NewSwitchoverDatabaseNodeDatabaseNotModifiableResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeInvalidInputResponseBody 

type SwitchoverDatabaseNodeInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

SwitchoverDatabaseNodeInvalidInputResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body for the "invalid_input" error.

func NewSwitchoverDatabaseNodeInvalidInputResponseBody 

func NewSwitchoverDatabaseNodeInvalidInputResponseBody(res *controlplane.APIError) *SwitchoverDatabaseNodeInvalidInputResponseBody

NewSwitchoverDatabaseNodeInvalidInputResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeNotFoundResponseBody 

type SwitchoverDatabaseNodeNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

SwitchoverDatabaseNodeNotFoundResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body for the "not_found" error.

func NewSwitchoverDatabaseNodeNotFoundResponseBody 

func NewSwitchoverDatabaseNodeNotFoundResponseBody(res *controlplane.APIError) *SwitchoverDatabaseNodeNotFoundResponseBody

NewSwitchoverDatabaseNodeNotFoundResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody 

type SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewSwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody 

func NewSwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody

NewSwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeRequestBody 

type SwitchoverDatabaseNodeRequestBody struct {
	// Optional instance_id for the replica candidate.
	CandidateInstanceID *string `form:"candidate_instance_id,omitempty" json:"candidate_instance_id,omitempty" xml:"candidate_instance_id,omitempty"`
	// Optional scheduled time (ISO8601) for the switchover. If absent switchover
	// happens immediately.
	ScheduledAt *string `form:"scheduled_at,omitempty" json:"scheduled_at,omitempty" xml:"scheduled_at,omitempty"`
}

SwitchoverDatabaseNodeRequestBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP request body.

type SwitchoverDatabaseNodeResponseBody 

type SwitchoverDatabaseNodeResponseBody struct {
	// The task that will perform the switchover.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
}

SwitchoverDatabaseNodeResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body.

func NewSwitchoverDatabaseNodeResponseBody 

func NewSwitchoverDatabaseNodeResponseBody(res *controlplane.SwitchoverDatabaseNodeResponse) *SwitchoverDatabaseNodeResponseBody

NewSwitchoverDatabaseNodeResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeServerErrorResponseBody 

type SwitchoverDatabaseNodeServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

SwitchoverDatabaseNodeServerErrorResponseBody is the type of the "control-plane" service "switchover-database-node" endpoint HTTP response body for the "server_error" error.

func NewSwitchoverDatabaseNodeServerErrorResponseBody 

func NewSwitchoverDatabaseNodeServerErrorResponseBody(res *controlplane.APIError) *SwitchoverDatabaseNodeServerErrorResponseBody

NewSwitchoverDatabaseNodeServerErrorResponseBody builds the HTTP response body from the result of the "switchover-database-node" endpoint of the "control-plane" service.

type TaskLogEntryResponseBody 

type TaskLogEntryResponseBody struct {
	// The timestamp of the log entry.
	Timestamp string `form:"timestamp" json:"timestamp" xml:"timestamp"`
	// The log message.
	Message string `form:"message" json:"message" xml:"message"`
	// Additional fields for the log entry.
	Fields map[string]any `form:"fields,omitempty" json:"fields,omitempty" xml:"fields,omitempty"`
}

TaskLogEntryResponseBody is used to define fields on response body types.

type TaskResponseBody 

type TaskResponseBody struct {
	// The parent task ID of the task.
	ParentID *string `form:"parent_id,omitempty" json:"parent_id,omitempty" xml:"parent_id,omitempty"`
	// The database ID of the task.
	DatabaseID string `form:"database_id" json:"database_id" xml:"database_id"`
	// The name of the node that the task is operating on.
	NodeName *string `form:"node_name,omitempty" json:"node_name,omitempty" xml:"node_name,omitempty"`
	// The ID of the instance that the task is operating on.
	InstanceID *string `form:"instance_id,omitempty" json:"instance_id,omitempty" xml:"instance_id,omitempty"`
	// The ID of the host that the task is running on.
	HostID *string `form:"host_id,omitempty" json:"host_id,omitempty" xml:"host_id,omitempty"`
	// The unique ID of the task.
	TaskID string `form:"task_id" json:"task_id" xml:"task_id"`
	// The time when the task was created.
	CreatedAt string `form:"created_at" json:"created_at" xml:"created_at"`
	// The time when the task was completed.
	CompletedAt *string `form:"completed_at,omitempty" json:"completed_at,omitempty" xml:"completed_at,omitempty"`
	// The type of the task.
	Type string `form:"type" json:"type" xml:"type"`
	// The status of the task.
	Status string `form:"status" json:"status" xml:"status"`
	// The error message if the task failed.
	Error *string `form:"error,omitempty" json:"error,omitempty" xml:"error,omitempty"`
}

TaskResponseBody is used to define fields on response body types.

type UpdateDatabaseClusterNotInitializedResponseBody 

type UpdateDatabaseClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

UpdateDatabaseClusterNotInitializedResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body for the "cluster_not_initialized" error.

func NewUpdateDatabaseClusterNotInitializedResponseBody 

func NewUpdateDatabaseClusterNotInitializedResponseBody(res *controlplane.APIError) *UpdateDatabaseClusterNotInitializedResponseBody

NewUpdateDatabaseClusterNotInitializedResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseDatabaseNotModifiableResponseBody 

type UpdateDatabaseDatabaseNotModifiableResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

UpdateDatabaseDatabaseNotModifiableResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body for the "database_not_modifiable" error.

func NewUpdateDatabaseDatabaseNotModifiableResponseBody 

func NewUpdateDatabaseDatabaseNotModifiableResponseBody(res *controlplane.APIError) *UpdateDatabaseDatabaseNotModifiableResponseBody

NewUpdateDatabaseDatabaseNotModifiableResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseInvalidInputResponseBody 

type UpdateDatabaseInvalidInputResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

UpdateDatabaseInvalidInputResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body for the "invalid_input" error.

func NewUpdateDatabaseInvalidInputResponseBody 

func NewUpdateDatabaseInvalidInputResponseBody(res *controlplane.APIError) *UpdateDatabaseInvalidInputResponseBody

NewUpdateDatabaseInvalidInputResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseNotFoundResponseBody 

type UpdateDatabaseNotFoundResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

UpdateDatabaseNotFoundResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body for the "not_found" error.

func NewUpdateDatabaseNotFoundResponseBody 

func NewUpdateDatabaseNotFoundResponseBody(res *controlplane.APIError) *UpdateDatabaseNotFoundResponseBody

NewUpdateDatabaseNotFoundResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseOperationAlreadyInProgressResponseBody 

type UpdateDatabaseOperationAlreadyInProgressResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

UpdateDatabaseOperationAlreadyInProgressResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body for the "operation_already_in_progress" error.

func NewUpdateDatabaseOperationAlreadyInProgressResponseBody 

func NewUpdateDatabaseOperationAlreadyInProgressResponseBody(res *controlplane.APIError) *UpdateDatabaseOperationAlreadyInProgressResponseBody

NewUpdateDatabaseOperationAlreadyInProgressResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseRequestBody 

type UpdateDatabaseRequestBody struct {
	// Unique identifier for the databases's owner.
	TenantID *string `form:"tenant_id,omitempty" json:"tenant_id,omitempty" xml:"tenant_id,omitempty"`
	// The specification for the database.
	Spec *DatabaseSpecRequestBodyRequestBody `form:"spec,omitempty" json:"spec,omitempty" xml:"spec,omitempty"`
}

UpdateDatabaseRequestBody is the type of the "control-plane" service "update-database" endpoint HTTP request body.

type UpdateDatabaseResponseBody 

type UpdateDatabaseResponseBody struct {
	// The task that will update this database.
	Task *TaskResponseBody `form:"task" json:"task" xml:"task"`
	// The database being updated.
	Database *DatabaseResponseBody `form:"database" json:"database" xml:"database"`
}

UpdateDatabaseResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body.

func NewUpdateDatabaseResponseBody 

func NewUpdateDatabaseResponseBody(res *controlplane.UpdateDatabaseResponse) *UpdateDatabaseResponseBody

NewUpdateDatabaseResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseServerErrorResponseBody 

type UpdateDatabaseServerErrorResponseBody struct {
	// The name of the error.
	Name string `form:"name" json:"name" xml:"name"`
	// The error message.
	Message string `form:"message" json:"message" xml:"message"`
}

UpdateDatabaseServerErrorResponseBody is the type of the "control-plane" service "update-database" endpoint HTTP response body for the "server_error" error.

func NewUpdateDatabaseServerErrorResponseBody 

func NewUpdateDatabaseServerErrorResponseBody(res *controlplane.APIError) *UpdateDatabaseServerErrorResponseBody

NewUpdateDatabaseServerErrorResponseBody builds the HTTP response body from the result of the "update-database" endpoint of the "control-plane" service.

Source Files

View all Source files

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.