client

package
v0.7.0 Latest Latest
Warning

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

Go to latest
Published: Mar 27, 2026 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 BuildBackupDatabaseNodePayload

func BuildBackupDatabaseNodePayload(controlPlaneBackupDatabaseNodeBody string, controlPlaneBackupDatabaseNodeDatabaseID string, controlPlaneBackupDatabaseNodeNodeName string, controlPlaneBackupDatabaseNodeForce string) (*controlplane.BackupDatabaseNodePayload, error)

BuildBackupDatabaseNodePayload builds the payload for the control-plane backup-database-node endpoint from CLI flags.

func BuildCancelDatabaseTaskPayload

func BuildCancelDatabaseTaskPayload(controlPlaneCancelDatabaseTaskDatabaseID string, controlPlaneCancelDatabaseTaskTaskID string) (*controlplane.CancelDatabaseTaskPayload, error)

BuildCancelDatabaseTaskPayload builds the payload for the control-plane cancel-database-task endpoint from CLI flags.

func BuildCreateDatabasePayload

func BuildCreateDatabasePayload(controlPlaneCreateDatabaseBody string) (*controlplane.CreateDatabaseRequest, error)

BuildCreateDatabasePayload builds the payload for the control-plane create-database endpoint from CLI flags.

func BuildDeleteDatabasePayload

func BuildDeleteDatabasePayload(controlPlaneDeleteDatabaseDatabaseID string, controlPlaneDeleteDatabaseForce string) (*controlplane.DeleteDatabasePayload, error)

BuildDeleteDatabasePayload builds the payload for the control-plane delete-database endpoint from CLI flags.

func BuildFailoverDatabaseNodePayload

func BuildFailoverDatabaseNodePayload(controlPlaneFailoverDatabaseNodeBody string, controlPlaneFailoverDatabaseNodeDatabaseID string, controlPlaneFailoverDatabaseNodeNodeName string) (*controlplane.FailoverDatabaseNodeRequest, error)

BuildFailoverDatabaseNodePayload builds the payload for the control-plane failover-database-node endpoint from CLI flags.

func BuildGetDatabasePayload

func BuildGetDatabasePayload(controlPlaneGetDatabaseDatabaseID string) (*controlplane.GetDatabasePayload, error)

BuildGetDatabasePayload builds the payload for the control-plane get-database endpoint from CLI flags.

func BuildGetDatabaseTaskLogPayload

func BuildGetDatabaseTaskLogPayload(controlPlaneGetDatabaseTaskLogDatabaseID string, controlPlaneGetDatabaseTaskLogTaskID string, controlPlaneGetDatabaseTaskLogAfterEntryID string, controlPlaneGetDatabaseTaskLogLimit string) (*controlplane.GetDatabaseTaskLogPayload, error)

BuildGetDatabaseTaskLogPayload builds the payload for the control-plane get-database-task-log endpoint from CLI flags.

func BuildGetDatabaseTaskPayload

func BuildGetDatabaseTaskPayload(controlPlaneGetDatabaseTaskDatabaseID string, controlPlaneGetDatabaseTaskTaskID string) (*controlplane.GetDatabaseTaskPayload, error)

BuildGetDatabaseTaskPayload builds the payload for the control-plane get-database-task endpoint from CLI flags.

func BuildGetHostPayload

func BuildGetHostPayload(controlPlaneGetHostHostID string) (*controlplane.GetHostPayload, error)

BuildGetHostPayload builds the payload for the control-plane get-host endpoint from CLI flags.

func BuildGetHostTaskLogPayload added in v0.7.0

func BuildGetHostTaskLogPayload(controlPlaneGetHostTaskLogHostID string, controlPlaneGetHostTaskLogTaskID string, controlPlaneGetHostTaskLogAfterEntryID string, controlPlaneGetHostTaskLogLimit string) (*controlplane.GetHostTaskLogPayload, error)

BuildGetHostTaskLogPayload builds the payload for the control-plane get-host-task-log endpoint from CLI flags.

func BuildGetHostTaskPayload added in v0.7.0

func BuildGetHostTaskPayload(controlPlaneGetHostTaskHostID string, controlPlaneGetHostTaskTaskID string) (*controlplane.GetHostTaskPayload, error)

BuildGetHostTaskPayload builds the payload for the control-plane get-host-task endpoint from CLI flags.

func BuildGetJoinOptionsPayload

func BuildGetJoinOptionsPayload(controlPlaneGetJoinOptionsBody string) (*controlplane.ClusterJoinRequest, error)

BuildGetJoinOptionsPayload builds the payload for the control-plane get-join-options endpoint from CLI flags.

func BuildInitClusterPayload

func BuildInitClusterPayload(controlPlaneInitClusterClusterID string) (*controlplane.InitClusterRequest, error)

BuildInitClusterPayload builds the payload for the control-plane init-cluster endpoint from CLI flags.

func BuildJoinClusterPayload

func BuildJoinClusterPayload(controlPlaneJoinClusterBody string) (*controlplane.ClusterJoinToken, error)

BuildJoinClusterPayload builds the payload for the control-plane join-cluster endpoint from CLI flags.

func BuildListDatabaseTasksPayload

func BuildListDatabaseTasksPayload(controlPlaneListDatabaseTasksDatabaseID string, controlPlaneListDatabaseTasksAfterTaskID string, controlPlaneListDatabaseTasksLimit string, controlPlaneListDatabaseTasksSortOrder string) (*controlplane.ListDatabaseTasksPayload, error)

BuildListDatabaseTasksPayload builds the payload for the control-plane list-database-tasks endpoint from CLI flags.

func BuildListHostTasksPayload added in v0.7.0

func BuildListHostTasksPayload(controlPlaneListHostTasksHostID string, controlPlaneListHostTasksAfterTaskID string, controlPlaneListHostTasksLimit string, controlPlaneListHostTasksSortOrder string) (*controlplane.ListHostTasksPayload, error)

BuildListHostTasksPayload builds the payload for the control-plane list-host-tasks endpoint from CLI flags.

func BuildListTasksPayload added in v0.7.0

func BuildListTasksPayload(controlPlaneListTasksScope string, controlPlaneListTasksEntityID string, controlPlaneListTasksAfterTaskID string, controlPlaneListTasksLimit string, controlPlaneListTasksSortOrder string) (*controlplane.ListTasksPayload, error)

BuildListTasksPayload builds the payload for the control-plane list-tasks endpoint from CLI flags.

func BuildRemoveHostPayload

func BuildRemoveHostPayload(controlPlaneRemoveHostHostID string, controlPlaneRemoveHostForce string) (*controlplane.RemoveHostPayload, error)

BuildRemoveHostPayload builds the payload for the control-plane remove-host endpoint from CLI flags.

func BuildRestartInstancePayload

func BuildRestartInstancePayload(controlPlaneRestartInstanceBody string, controlPlaneRestartInstanceDatabaseID string, controlPlaneRestartInstanceInstanceID string) (*controlplane.RestartInstancePayload, error)

BuildRestartInstancePayload builds the payload for the control-plane restart-instance endpoint from CLI flags.

func BuildRestoreDatabasePayload

func BuildRestoreDatabasePayload(controlPlaneRestoreDatabaseBody string, controlPlaneRestoreDatabaseDatabaseID string, controlPlaneRestoreDatabaseForce string) (*controlplane.RestoreDatabasePayload, error)

BuildRestoreDatabasePayload builds the payload for the control-plane restore-database endpoint from CLI flags.

func BuildStartInstancePayload

func BuildStartInstancePayload(controlPlaneStartInstanceDatabaseID string, controlPlaneStartInstanceInstanceID string, controlPlaneStartInstanceForce string) (*controlplane.StartInstancePayload, error)

BuildStartInstancePayload builds the payload for the control-plane start-instance endpoint from CLI flags.

func BuildStopInstancePayload

func BuildStopInstancePayload(controlPlaneStopInstanceDatabaseID string, controlPlaneStopInstanceInstanceID string, controlPlaneStopInstanceForce string) (*controlplane.StopInstancePayload, error)

BuildStopInstancePayload builds the payload for the control-plane stop-instance endpoint from CLI flags.

func BuildSwitchoverDatabaseNodePayload

func BuildSwitchoverDatabaseNodePayload(controlPlaneSwitchoverDatabaseNodeBody string, controlPlaneSwitchoverDatabaseNodeDatabaseID string, controlPlaneSwitchoverDatabaseNodeNodeName string) (*controlplane.SwitchoverDatabaseNodePayload, error)

BuildSwitchoverDatabaseNodePayload builds the payload for the control-plane switchover-database-node endpoint from CLI flags.

func BuildUpdateDatabasePayload

func BuildUpdateDatabasePayload(controlPlaneUpdateDatabaseBody string, controlPlaneUpdateDatabaseDatabaseID string, controlPlaneUpdateDatabaseForceUpdate string, controlPlaneUpdateDatabaseRemoveHost string) (*controlplane.UpdateDatabasePayload, error)

BuildUpdateDatabasePayload builds the payload for the control-plane update-database endpoint from CLI flags.

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 DecodeBackupDatabaseNodeResponse

func DecodeBackupDatabaseNodeResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeBackupDatabaseNodeResponse returns a decoder for responses returned by the control-plane backup-database-node endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeBackupDatabaseNodeResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "database_not_modifiable" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeCancelDatabaseTaskResponse

func DecodeCancelDatabaseTaskResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeCancelDatabaseTaskResponse returns a decoder for responses returned by the control-plane cancel-database-task endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeCancelDatabaseTaskResponse may return the following errors:

  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeCreateDatabaseResponse

func DecodeCreateDatabaseResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeCreateDatabaseResponse returns a decoder for responses returned by the control-plane create-database endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeCreateDatabaseResponse may return the following errors:

  • "database_already_exists" (type *controlplane.APIError): http.StatusConflict
  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeDeleteDatabaseResponse

func DecodeDeleteDatabaseResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeDeleteDatabaseResponse returns a decoder for responses returned by the control-plane delete-database endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeDeleteDatabaseResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "database_not_modifiable" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeFailoverDatabaseNodeResponse

func DecodeFailoverDatabaseNodeResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeFailoverDatabaseNodeResponse returns a decoder for responses returned by the control-plane failover-database-node endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeFailoverDatabaseNodeResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "database_not_modifiable" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetClusterResponse

func DecodeGetClusterResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetClusterResponse returns a decoder for responses returned by the control-plane get-cluster endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetClusterResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetDatabaseResponse

func DecodeGetDatabaseResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetDatabaseResponse returns a decoder for responses returned by the control-plane get-database endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetDatabaseResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetDatabaseTaskLogResponse

func DecodeGetDatabaseTaskLogResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetDatabaseTaskLogResponse returns a decoder for responses returned by the control-plane get-database-task-log endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetDatabaseTaskLogResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetDatabaseTaskResponse

func DecodeGetDatabaseTaskResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetDatabaseTaskResponse returns a decoder for responses returned by the control-plane get-database-task endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetDatabaseTaskResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetHostResponse

func DecodeGetHostResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetHostResponse returns a decoder for responses returned by the control-plane get-host endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetHostResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetHostTaskLogResponse added in v0.7.0

func DecodeGetHostTaskLogResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetHostTaskLogResponse returns a decoder for responses returned by the control-plane get-host-task-log endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetHostTaskLogResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetHostTaskResponse added in v0.7.0

func DecodeGetHostTaskResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetHostTaskResponse returns a decoder for responses returned by the control-plane get-host-task endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetHostTaskResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetJoinOptionsResponse

func DecodeGetJoinOptionsResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetJoinOptionsResponse returns a decoder for responses returned by the control-plane get-join-options endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetJoinOptionsResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_join_token" (type *controlplane.APIError): http.StatusUnauthorized
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetJoinTokenResponse

func DecodeGetJoinTokenResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetJoinTokenResponse returns a decoder for responses returned by the control-plane get-join-token endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetJoinTokenResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeGetVersionResponse

func DecodeGetVersionResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeGetVersionResponse returns a decoder for responses returned by the control-plane get-version endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeGetVersionResponse may return the following errors:

  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeInitClusterResponse

func DecodeInitClusterResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeInitClusterResponse returns a decoder for responses returned by the control-plane init-cluster endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeInitClusterResponse may return the following errors:

  • "cluster_already_initialized" (type *controlplane.APIError): http.StatusConflict
  • "operation_not_supported" (type *controlplane.APIError): http.StatusBadRequest
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeJoinClusterResponse

func DecodeJoinClusterResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeJoinClusterResponse returns a decoder for responses returned by the control-plane join-cluster endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeJoinClusterResponse may return the following errors:

  • "cluster_already_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_join_token" (type *controlplane.APIError): http.StatusUnauthorized
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeListDatabaseTasksResponse

func DecodeListDatabaseTasksResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListDatabaseTasksResponse returns a decoder for responses returned by the control-plane list-database-tasks endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListDatabaseTasksResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeListDatabasesResponse

func DecodeListDatabasesResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListDatabasesResponse returns a decoder for responses returned by the control-plane list-databases endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListDatabasesResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeListHostTasksResponse added in v0.7.0

func DecodeListHostTasksResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListHostTasksResponse returns a decoder for responses returned by the control-plane list-host-tasks endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListHostTasksResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeListHostsResponse

func DecodeListHostsResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListHostsResponse returns a decoder for responses returned by the control-plane list-hosts endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListHostsResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeListTasksResponse added in v0.7.0

func DecodeListTasksResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeListTasksResponse returns a decoder for responses returned by the control-plane list-tasks endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeListTasksResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeRemoveHostResponse

func DecodeRemoveHostResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeRemoveHostResponse returns a decoder for responses returned by the control-plane remove-host endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeRemoveHostResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeRestartInstanceResponse

func DecodeRestartInstanceResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeRestartInstanceResponse returns a decoder for responses returned by the control-plane restart-instance endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeRestartInstanceResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeRestoreDatabaseResponse

func DecodeRestoreDatabaseResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeRestoreDatabaseResponse returns a decoder for responses returned by the control-plane restore-database endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeRestoreDatabaseResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "database_not_modifiable" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeStartInstanceResponse

func DecodeStartInstanceResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeStartInstanceResponse returns a decoder for responses returned by the control-plane start-instance endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeStartInstanceResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeStopInstanceResponse

func DecodeStopInstanceResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeStopInstanceResponse returns a decoder for responses returned by the control-plane stop-instance endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeStopInstanceResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeSwitchoverDatabaseNodeResponse

func DecodeSwitchoverDatabaseNodeResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeSwitchoverDatabaseNodeResponse returns a decoder for responses returned by the control-plane switchover-database-node endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeSwitchoverDatabaseNodeResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "database_not_modifiable" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DecodeUpdateDatabaseResponse

func DecodeUpdateDatabaseResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)

DecodeUpdateDatabaseResponse returns a decoder for responses returned by the control-plane update-database endpoint. restoreBody controls whether the response body should be restored after having been read. DecodeUpdateDatabaseResponse may return the following errors:

  • "cluster_not_initialized" (type *controlplane.APIError): http.StatusConflict
  • "database_not_modifiable" (type *controlplane.APIError): http.StatusConflict
  • "operation_already_in_progress" (type *controlplane.APIError): http.StatusConflict
  • "invalid_input" (type *controlplane.APIError): http.StatusBadRequest
  • "not_found" (type *controlplane.APIError): http.StatusNotFound
  • "server_error" (type *controlplane.APIError): http.StatusInternalServerError
  • error: internal error

func DeleteDatabaseControlPlanePath

func DeleteDatabaseControlPlanePath(databaseID string) string

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

func EncodeBackupDatabaseNodeRequest

func EncodeBackupDatabaseNodeRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeBackupDatabaseNodeRequest returns an encoder for requests sent to the control-plane backup-database-node server.

func EncodeCreateDatabaseRequest

func EncodeCreateDatabaseRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeCreateDatabaseRequest returns an encoder for requests sent to the control-plane create-database server.

func EncodeDeleteDatabaseRequest

func EncodeDeleteDatabaseRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeDeleteDatabaseRequest returns an encoder for requests sent to the control-plane delete-database server.

func EncodeFailoverDatabaseNodeRequest

func EncodeFailoverDatabaseNodeRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeFailoverDatabaseNodeRequest returns an encoder for requests sent to the control-plane failover-database-node server.

func EncodeGetDatabaseTaskLogRequest

func EncodeGetDatabaseTaskLogRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeGetDatabaseTaskLogRequest returns an encoder for requests sent to the control-plane get-database-task-log server.

func EncodeGetHostTaskLogRequest added in v0.7.0

func EncodeGetHostTaskLogRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeGetHostTaskLogRequest returns an encoder for requests sent to the control-plane get-host-task-log server.

func EncodeGetJoinOptionsRequest

func EncodeGetJoinOptionsRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeGetJoinOptionsRequest returns an encoder for requests sent to the control-plane get-join-options server.

func EncodeInitClusterRequest

func EncodeInitClusterRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeInitClusterRequest returns an encoder for requests sent to the control-plane init-cluster server.

func EncodeJoinClusterRequest

func EncodeJoinClusterRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeJoinClusterRequest returns an encoder for requests sent to the control-plane join-cluster server.

func EncodeListDatabaseTasksRequest

func EncodeListDatabaseTasksRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListDatabaseTasksRequest returns an encoder for requests sent to the control-plane list-database-tasks server.

func EncodeListHostTasksRequest added in v0.7.0

func EncodeListHostTasksRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListHostTasksRequest returns an encoder for requests sent to the control-plane list-host-tasks server.

func EncodeListTasksRequest added in v0.7.0

func EncodeListTasksRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeListTasksRequest returns an encoder for requests sent to the control-plane list-tasks server.

func EncodeRemoveHostRequest added in v0.6.0

func EncodeRemoveHostRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeRemoveHostRequest returns an encoder for requests sent to the control-plane remove-host server.

func EncodeRestartInstanceRequest

func EncodeRestartInstanceRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeRestartInstanceRequest returns an encoder for requests sent to the control-plane restart-instance server.

func EncodeRestoreDatabaseRequest

func EncodeRestoreDatabaseRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeRestoreDatabaseRequest returns an encoder for requests sent to the control-plane restore-database server.

func EncodeStartInstanceRequest

func EncodeStartInstanceRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeStartInstanceRequest returns an encoder for requests sent to the control-plane start-instance server.

func EncodeStopInstanceRequest

func EncodeStopInstanceRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeStopInstanceRequest returns an encoder for requests sent to the control-plane stop-instance server.

func EncodeSwitchoverDatabaseNodeRequest

func EncodeSwitchoverDatabaseNodeRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeSwitchoverDatabaseNodeRequest returns an encoder for requests sent to the control-plane switchover-database-node server.

func EncodeUpdateDatabaseRequest

func EncodeUpdateDatabaseRequest(encoder func(*http.Request) goahttp.Encoder) func(*http.Request, any) error

EncodeUpdateDatabaseRequest returns an encoder for requests sent to the control-plane update-database server.

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 GetHostTaskControlPlanePath added in v0.7.0

func GetHostTaskControlPlanePath(hostID string, taskID string) string

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

func GetHostTaskLogControlPlanePath added in v0.7.0

func GetHostTaskLogControlPlanePath(hostID string, taskID string) string

GetHostTaskLogControlPlanePath returns the URL path to the control-plane service get-host-task-log 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 ListHostTasksControlPlanePath added in v0.7.0

func ListHostTasksControlPlanePath(hostID string) string

ListHostTasksControlPlanePath returns the URL path to the control-plane service list-host-tasks HTTP endpoint.

func ListHostsControlPlanePath

func ListHostsControlPlanePath() string

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

func ListTasksControlPlanePath added in v0.7.0

func ListTasksControlPlanePath() string

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

func NewBackupDatabaseNodeClusterNotInitialized

func NewBackupDatabaseNodeClusterNotInitialized(body *BackupDatabaseNodeClusterNotInitializedResponseBody) *controlplane.APIError

NewBackupDatabaseNodeClusterNotInitialized builds a control-plane service backup-database-node endpoint cluster_not_initialized error.

func NewBackupDatabaseNodeDatabaseNotModifiable

func NewBackupDatabaseNodeDatabaseNotModifiable(body *BackupDatabaseNodeDatabaseNotModifiableResponseBody) *controlplane.APIError

NewBackupDatabaseNodeDatabaseNotModifiable builds a control-plane service backup-database-node endpoint database_not_modifiable error.

func NewBackupDatabaseNodeInvalidInput

func NewBackupDatabaseNodeInvalidInput(body *BackupDatabaseNodeInvalidInputResponseBody) *controlplane.APIError

NewBackupDatabaseNodeInvalidInput builds a control-plane service backup-database-node endpoint invalid_input error.

func NewBackupDatabaseNodeNotFound

func NewBackupDatabaseNodeNotFound(body *BackupDatabaseNodeNotFoundResponseBody) *controlplane.APIError

NewBackupDatabaseNodeNotFound builds a control-plane service backup-database-node endpoint not_found error.

func NewBackupDatabaseNodeOperationAlreadyInProgress

func NewBackupDatabaseNodeOperationAlreadyInProgress(body *BackupDatabaseNodeOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewBackupDatabaseNodeOperationAlreadyInProgress builds a control-plane service backup-database-node endpoint operation_already_in_progress error.

func NewBackupDatabaseNodeResponseOK

func NewBackupDatabaseNodeResponseOK(body *BackupDatabaseNodeResponseBody) *controlplane.BackupDatabaseNodeResponse

NewBackupDatabaseNodeResponseOK builds a "control-plane" service "backup-database-node" endpoint result from a HTTP "OK" response.

func NewBackupDatabaseNodeServerError

func NewBackupDatabaseNodeServerError(body *BackupDatabaseNodeServerErrorResponseBody) *controlplane.APIError

NewBackupDatabaseNodeServerError builds a control-plane service backup-database-node endpoint server_error error.

func NewCancelDatabaseTaskInvalidInput

func NewCancelDatabaseTaskInvalidInput(body *CancelDatabaseTaskInvalidInputResponseBody) *controlplane.APIError

NewCancelDatabaseTaskInvalidInput builds a control-plane service cancel-database-task endpoint invalid_input error.

func NewCancelDatabaseTaskNotFound

func NewCancelDatabaseTaskNotFound(body *CancelDatabaseTaskNotFoundResponseBody) *controlplane.APIError

NewCancelDatabaseTaskNotFound builds a control-plane service cancel-database-task endpoint not_found error.

func NewCancelDatabaseTaskServerError

func NewCancelDatabaseTaskServerError(body *CancelDatabaseTaskServerErrorResponseBody) *controlplane.APIError

NewCancelDatabaseTaskServerError builds a control-plane service cancel-database-task endpoint server_error error.

func NewCancelDatabaseTaskTaskOK

func NewCancelDatabaseTaskTaskOK(body *CancelDatabaseTaskResponseBody) *controlplane.Task

NewCancelDatabaseTaskTaskOK builds a "control-plane" service "cancel-database-task" endpoint result from a HTTP "OK" response.

func NewCreateDatabaseClusterNotInitialized

func NewCreateDatabaseClusterNotInitialized(body *CreateDatabaseClusterNotInitializedResponseBody) *controlplane.APIError

NewCreateDatabaseClusterNotInitialized builds a control-plane service create-database endpoint cluster_not_initialized error.

func NewCreateDatabaseDatabaseAlreadyExists

func NewCreateDatabaseDatabaseAlreadyExists(body *CreateDatabaseDatabaseAlreadyExistsResponseBody) *controlplane.APIError

NewCreateDatabaseDatabaseAlreadyExists builds a control-plane service create-database endpoint database_already_exists error.

func NewCreateDatabaseInvalidInput

func NewCreateDatabaseInvalidInput(body *CreateDatabaseInvalidInputResponseBody) *controlplane.APIError

NewCreateDatabaseInvalidInput builds a control-plane service create-database endpoint invalid_input error.

func NewCreateDatabaseOperationAlreadyInProgress

func NewCreateDatabaseOperationAlreadyInProgress(body *CreateDatabaseOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewCreateDatabaseOperationAlreadyInProgress builds a control-plane service create-database endpoint operation_already_in_progress error.

func NewCreateDatabaseResponseOK

func NewCreateDatabaseResponseOK(body *CreateDatabaseResponseBody) *controlplane.CreateDatabaseResponse

NewCreateDatabaseResponseOK builds a "control-plane" service "create-database" endpoint result from a HTTP "OK" response.

func NewCreateDatabaseServerError

func NewCreateDatabaseServerError(body *CreateDatabaseServerErrorResponseBody) *controlplane.APIError

NewCreateDatabaseServerError builds a control-plane service create-database endpoint server_error error.

func NewDeleteDatabaseClusterNotInitialized

func NewDeleteDatabaseClusterNotInitialized(body *DeleteDatabaseClusterNotInitializedResponseBody) *controlplane.APIError

NewDeleteDatabaseClusterNotInitialized builds a control-plane service delete-database endpoint cluster_not_initialized error.

func NewDeleteDatabaseDatabaseNotModifiable

func NewDeleteDatabaseDatabaseNotModifiable(body *DeleteDatabaseDatabaseNotModifiableResponseBody) *controlplane.APIError

NewDeleteDatabaseDatabaseNotModifiable builds a control-plane service delete-database endpoint database_not_modifiable error.

func NewDeleteDatabaseInvalidInput

func NewDeleteDatabaseInvalidInput(body *DeleteDatabaseInvalidInputResponseBody) *controlplane.APIError

NewDeleteDatabaseInvalidInput builds a control-plane service delete-database endpoint invalid_input error.

func NewDeleteDatabaseNotFound

func NewDeleteDatabaseNotFound(body *DeleteDatabaseNotFoundResponseBody) *controlplane.APIError

NewDeleteDatabaseNotFound builds a control-plane service delete-database endpoint not_found error.

func NewDeleteDatabaseOperationAlreadyInProgress

func NewDeleteDatabaseOperationAlreadyInProgress(body *DeleteDatabaseOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewDeleteDatabaseOperationAlreadyInProgress builds a control-plane service delete-database endpoint operation_already_in_progress error.

func NewDeleteDatabaseResponseOK

func NewDeleteDatabaseResponseOK(body *DeleteDatabaseResponseBody) *controlplane.DeleteDatabaseResponse

NewDeleteDatabaseResponseOK builds a "control-plane" service "delete-database" endpoint result from a HTTP "OK" response.

func NewDeleteDatabaseServerError

func NewDeleteDatabaseServerError(body *DeleteDatabaseServerErrorResponseBody) *controlplane.APIError

NewDeleteDatabaseServerError builds a control-plane service delete-database endpoint server_error error.

func NewFailoverDatabaseNodeClusterNotInitialized

func NewFailoverDatabaseNodeClusterNotInitialized(body *FailoverDatabaseNodeClusterNotInitializedResponseBody) *controlplane.APIError

NewFailoverDatabaseNodeClusterNotInitialized builds a control-plane service failover-database-node endpoint cluster_not_initialized error.

func NewFailoverDatabaseNodeDatabaseNotModifiable

func NewFailoverDatabaseNodeDatabaseNotModifiable(body *FailoverDatabaseNodeDatabaseNotModifiableResponseBody) *controlplane.APIError

NewFailoverDatabaseNodeDatabaseNotModifiable builds a control-plane service failover-database-node endpoint database_not_modifiable error.

func NewFailoverDatabaseNodeInvalidInput

func NewFailoverDatabaseNodeInvalidInput(body *FailoverDatabaseNodeInvalidInputResponseBody) *controlplane.APIError

NewFailoverDatabaseNodeInvalidInput builds a control-plane service failover-database-node endpoint invalid_input error.

func NewFailoverDatabaseNodeNotFound

func NewFailoverDatabaseNodeNotFound(body *FailoverDatabaseNodeNotFoundResponseBody) *controlplane.APIError

NewFailoverDatabaseNodeNotFound builds a control-plane service failover-database-node endpoint not_found error.

func NewFailoverDatabaseNodeOperationAlreadyInProgress

func NewFailoverDatabaseNodeOperationAlreadyInProgress(body *FailoverDatabaseNodeOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewFailoverDatabaseNodeOperationAlreadyInProgress builds a control-plane service failover-database-node endpoint operation_already_in_progress error.

func NewFailoverDatabaseNodeResponseOK

func NewFailoverDatabaseNodeResponseOK(body *FailoverDatabaseNodeResponseBody) *controlplane.FailoverDatabaseNodeResponse

NewFailoverDatabaseNodeResponseOK builds a "control-plane" service "failover-database-node" endpoint result from a HTTP "OK" response.

func NewFailoverDatabaseNodeServerError

func NewFailoverDatabaseNodeServerError(body *FailoverDatabaseNodeServerErrorResponseBody) *controlplane.APIError

NewFailoverDatabaseNodeServerError builds a control-plane service failover-database-node endpoint server_error error.

func NewGetClusterClusterNotInitialized

func NewGetClusterClusterNotInitialized(body *GetClusterClusterNotInitializedResponseBody) *controlplane.APIError

NewGetClusterClusterNotInitialized builds a control-plane service get-cluster endpoint cluster_not_initialized error.

func NewGetClusterClusterOK

func NewGetClusterClusterOK(body *GetClusterResponseBody) *controlplane.Cluster

NewGetClusterClusterOK builds a "control-plane" service "get-cluster" endpoint result from a HTTP "OK" response.

func NewGetClusterServerError

func NewGetClusterServerError(body *GetClusterServerErrorResponseBody) *controlplane.APIError

NewGetClusterServerError builds a control-plane service get-cluster endpoint server_error error.

func NewGetDatabaseClusterNotInitialized

func NewGetDatabaseClusterNotInitialized(body *GetDatabaseClusterNotInitializedResponseBody) *controlplane.APIError

NewGetDatabaseClusterNotInitialized builds a control-plane service get-database endpoint cluster_not_initialized error.

func NewGetDatabaseDatabaseOK

func NewGetDatabaseDatabaseOK(body *GetDatabaseResponseBody) *controlplane.Database

NewGetDatabaseDatabaseOK builds a "control-plane" service "get-database" endpoint result from a HTTP "OK" response.

func NewGetDatabaseInvalidInput

func NewGetDatabaseInvalidInput(body *GetDatabaseInvalidInputResponseBody) *controlplane.APIError

NewGetDatabaseInvalidInput builds a control-plane service get-database endpoint invalid_input error.

func NewGetDatabaseNotFound

func NewGetDatabaseNotFound(body *GetDatabaseNotFoundResponseBody) *controlplane.APIError

NewGetDatabaseNotFound builds a control-plane service get-database endpoint not_found error.

func NewGetDatabaseServerError

func NewGetDatabaseServerError(body *GetDatabaseServerErrorResponseBody) *controlplane.APIError

NewGetDatabaseServerError builds a control-plane service get-database endpoint server_error error.

func NewGetDatabaseTaskClusterNotInitialized

func NewGetDatabaseTaskClusterNotInitialized(body *GetDatabaseTaskClusterNotInitializedResponseBody) *controlplane.APIError

NewGetDatabaseTaskClusterNotInitialized builds a control-plane service get-database-task endpoint cluster_not_initialized error.

func NewGetDatabaseTaskInvalidInput

func NewGetDatabaseTaskInvalidInput(body *GetDatabaseTaskInvalidInputResponseBody) *controlplane.APIError

NewGetDatabaseTaskInvalidInput builds a control-plane service get-database-task endpoint invalid_input error.

func NewGetDatabaseTaskLogClusterNotInitialized

func NewGetDatabaseTaskLogClusterNotInitialized(body *GetDatabaseTaskLogClusterNotInitializedResponseBody) *controlplane.APIError

NewGetDatabaseTaskLogClusterNotInitialized builds a control-plane service get-database-task-log endpoint cluster_not_initialized error.

func NewGetDatabaseTaskLogInvalidInput

func NewGetDatabaseTaskLogInvalidInput(body *GetDatabaseTaskLogInvalidInputResponseBody) *controlplane.APIError

NewGetDatabaseTaskLogInvalidInput builds a control-plane service get-database-task-log endpoint invalid_input error.

func NewGetDatabaseTaskLogNotFound

func NewGetDatabaseTaskLogNotFound(body *GetDatabaseTaskLogNotFoundResponseBody) *controlplane.APIError

NewGetDatabaseTaskLogNotFound builds a control-plane service get-database-task-log endpoint not_found error.

func NewGetDatabaseTaskLogServerError

func NewGetDatabaseTaskLogServerError(body *GetDatabaseTaskLogServerErrorResponseBody) *controlplane.APIError

NewGetDatabaseTaskLogServerError builds a control-plane service get-database-task-log endpoint server_error error.

func NewGetDatabaseTaskLogTaskLogOK

func NewGetDatabaseTaskLogTaskLogOK(body *GetDatabaseTaskLogResponseBody) *controlplane.TaskLog

NewGetDatabaseTaskLogTaskLogOK builds a "control-plane" service "get-database-task-log" endpoint result from a HTTP "OK" response.

func NewGetDatabaseTaskNotFound

func NewGetDatabaseTaskNotFound(body *GetDatabaseTaskNotFoundResponseBody) *controlplane.APIError

NewGetDatabaseTaskNotFound builds a control-plane service get-database-task endpoint not_found error.

func NewGetDatabaseTaskServerError

func NewGetDatabaseTaskServerError(body *GetDatabaseTaskServerErrorResponseBody) *controlplane.APIError

NewGetDatabaseTaskServerError builds a control-plane service get-database-task endpoint server_error error.

func NewGetDatabaseTaskTaskOK

func NewGetDatabaseTaskTaskOK(body *GetDatabaseTaskResponseBody) *controlplane.Task

NewGetDatabaseTaskTaskOK builds a "control-plane" service "get-database-task" endpoint result from a HTTP "OK" response.

func NewGetHostClusterNotInitialized

func NewGetHostClusterNotInitialized(body *GetHostClusterNotInitializedResponseBody) *controlplane.APIError

NewGetHostClusterNotInitialized builds a control-plane service get-host endpoint cluster_not_initialized error.

func NewGetHostHostOK

func NewGetHostHostOK(body *GetHostResponseBody) *controlplane.Host

NewGetHostHostOK builds a "control-plane" service "get-host" endpoint result from a HTTP "OK" response.

func NewGetHostInvalidInput

func NewGetHostInvalidInput(body *GetHostInvalidInputResponseBody) *controlplane.APIError

NewGetHostInvalidInput builds a control-plane service get-host endpoint invalid_input error.

func NewGetHostNotFound

func NewGetHostNotFound(body *GetHostNotFoundResponseBody) *controlplane.APIError

NewGetHostNotFound builds a control-plane service get-host endpoint not_found error.

func NewGetHostServerError

func NewGetHostServerError(body *GetHostServerErrorResponseBody) *controlplane.APIError

NewGetHostServerError builds a control-plane service get-host endpoint server_error error.

func NewGetHostTaskClusterNotInitialized added in v0.7.0

func NewGetHostTaskClusterNotInitialized(body *GetHostTaskClusterNotInitializedResponseBody) *controlplane.APIError

NewGetHostTaskClusterNotInitialized builds a control-plane service get-host-task endpoint cluster_not_initialized error.

func NewGetHostTaskInvalidInput added in v0.7.0

func NewGetHostTaskInvalidInput(body *GetHostTaskInvalidInputResponseBody) *controlplane.APIError

NewGetHostTaskInvalidInput builds a control-plane service get-host-task endpoint invalid_input error.

func NewGetHostTaskLogClusterNotInitialized added in v0.7.0

func NewGetHostTaskLogClusterNotInitialized(body *GetHostTaskLogClusterNotInitializedResponseBody) *controlplane.APIError

NewGetHostTaskLogClusterNotInitialized builds a control-plane service get-host-task-log endpoint cluster_not_initialized error.

func NewGetHostTaskLogInvalidInput added in v0.7.0

func NewGetHostTaskLogInvalidInput(body *GetHostTaskLogInvalidInputResponseBody) *controlplane.APIError

NewGetHostTaskLogInvalidInput builds a control-plane service get-host-task-log endpoint invalid_input error.

func NewGetHostTaskLogNotFound added in v0.7.0

func NewGetHostTaskLogNotFound(body *GetHostTaskLogNotFoundResponseBody) *controlplane.APIError

NewGetHostTaskLogNotFound builds a control-plane service get-host-task-log endpoint not_found error.

func NewGetHostTaskLogServerError added in v0.7.0

func NewGetHostTaskLogServerError(body *GetHostTaskLogServerErrorResponseBody) *controlplane.APIError

NewGetHostTaskLogServerError builds a control-plane service get-host-task-log endpoint server_error error.

func NewGetHostTaskLogTaskLogOK added in v0.7.0

func NewGetHostTaskLogTaskLogOK(body *GetHostTaskLogResponseBody) *controlplane.TaskLog

NewGetHostTaskLogTaskLogOK builds a "control-plane" service "get-host-task-log" endpoint result from a HTTP "OK" response.

func NewGetHostTaskNotFound added in v0.7.0

func NewGetHostTaskNotFound(body *GetHostTaskNotFoundResponseBody) *controlplane.APIError

NewGetHostTaskNotFound builds a control-plane service get-host-task endpoint not_found error.

func NewGetHostTaskServerError added in v0.7.0

func NewGetHostTaskServerError(body *GetHostTaskServerErrorResponseBody) *controlplane.APIError

NewGetHostTaskServerError builds a control-plane service get-host-task endpoint server_error error.

func NewGetHostTaskTaskOK added in v0.7.0

func NewGetHostTaskTaskOK(body *GetHostTaskResponseBody) *controlplane.Task

NewGetHostTaskTaskOK builds a "control-plane" service "get-host-task" endpoint result from a HTTP "OK" response.

func NewGetJoinOptionsClusterJoinOptionsOK

func NewGetJoinOptionsClusterJoinOptionsOK(body *GetJoinOptionsResponseBody) *controlplane.ClusterJoinOptions

NewGetJoinOptionsClusterJoinOptionsOK builds a "control-plane" service "get-join-options" endpoint result from a HTTP "OK" response.

func NewGetJoinOptionsClusterNotInitialized

func NewGetJoinOptionsClusterNotInitialized(body *GetJoinOptionsClusterNotInitializedResponseBody) *controlplane.APIError

NewGetJoinOptionsClusterNotInitialized builds a control-plane service get-join-options endpoint cluster_not_initialized error.

func NewGetJoinOptionsInvalidInput added in v0.6.0

func NewGetJoinOptionsInvalidInput(body *GetJoinOptionsInvalidInputResponseBody) *controlplane.APIError

NewGetJoinOptionsInvalidInput builds a control-plane service get-join-options endpoint invalid_input error.

func NewGetJoinOptionsInvalidJoinToken

func NewGetJoinOptionsInvalidJoinToken(body *GetJoinOptionsInvalidJoinTokenResponseBody) *controlplane.APIError

NewGetJoinOptionsInvalidJoinToken builds a control-plane service get-join-options endpoint invalid_join_token error.

func NewGetJoinOptionsServerError

func NewGetJoinOptionsServerError(body *GetJoinOptionsServerErrorResponseBody) *controlplane.APIError

NewGetJoinOptionsServerError builds a control-plane service get-join-options endpoint server_error error.

func NewGetJoinTokenClusterJoinTokenOK

func NewGetJoinTokenClusterJoinTokenOK(body *GetJoinTokenResponseBody) *controlplane.ClusterJoinToken

NewGetJoinTokenClusterJoinTokenOK builds a "control-plane" service "get-join-token" endpoint result from a HTTP "OK" response.

func NewGetJoinTokenClusterNotInitialized

func NewGetJoinTokenClusterNotInitialized(body *GetJoinTokenClusterNotInitializedResponseBody) *controlplane.APIError

NewGetJoinTokenClusterNotInitialized builds a control-plane service get-join-token endpoint cluster_not_initialized error.

func NewGetJoinTokenServerError

func NewGetJoinTokenServerError(body *GetJoinTokenServerErrorResponseBody) *controlplane.APIError

NewGetJoinTokenServerError builds a control-plane service get-join-token endpoint server_error error.

func NewGetVersionServerError

func NewGetVersionServerError(body *GetVersionServerErrorResponseBody) *controlplane.APIError

NewGetVersionServerError builds a control-plane service get-version endpoint server_error error.

func NewGetVersionVersionInfoOK

func NewGetVersionVersionInfoOK(body *GetVersionResponseBody) *controlplane.VersionInfo

NewGetVersionVersionInfoOK builds a "control-plane" service "get-version" endpoint result from a HTTP "OK" response.

func NewInitClusterClusterAlreadyInitialized

func NewInitClusterClusterAlreadyInitialized(body *InitClusterClusterAlreadyInitializedResponseBody) *controlplane.APIError

NewInitClusterClusterAlreadyInitialized builds a control-plane service init-cluster endpoint cluster_already_initialized error.

func NewInitClusterClusterJoinTokenOK

func NewInitClusterClusterJoinTokenOK(body *InitClusterResponseBody) *controlplane.ClusterJoinToken

NewInitClusterClusterJoinTokenOK builds a "control-plane" service "init-cluster" endpoint result from a HTTP "OK" response.

func NewInitClusterOperationNotSupported

func NewInitClusterOperationNotSupported(body *InitClusterOperationNotSupportedResponseBody) *controlplane.APIError

NewInitClusterOperationNotSupported builds a control-plane service init-cluster endpoint operation_not_supported error.

func NewInitClusterServerError

func NewInitClusterServerError(body *InitClusterServerErrorResponseBody) *controlplane.APIError

NewInitClusterServerError builds a control-plane service init-cluster endpoint server_error error.

func NewJoinClusterClusterAlreadyInitialized

func NewJoinClusterClusterAlreadyInitialized(body *JoinClusterClusterAlreadyInitializedResponseBody) *controlplane.APIError

NewJoinClusterClusterAlreadyInitialized builds a control-plane service join-cluster endpoint cluster_already_initialized error.

func NewJoinClusterInvalidInput added in v0.6.0

func NewJoinClusterInvalidInput(body *JoinClusterInvalidInputResponseBody) *controlplane.APIError

NewJoinClusterInvalidInput builds a control-plane service join-cluster endpoint invalid_input error.

func NewJoinClusterInvalidJoinToken

func NewJoinClusterInvalidJoinToken(body *JoinClusterInvalidJoinTokenResponseBody) *controlplane.APIError

NewJoinClusterInvalidJoinToken builds a control-plane service join-cluster endpoint invalid_join_token error.

func NewJoinClusterServerError

func NewJoinClusterServerError(body *JoinClusterServerErrorResponseBody) *controlplane.APIError

NewJoinClusterServerError builds a control-plane service join-cluster endpoint server_error error.

func NewListDatabaseTasksClusterNotInitialized

func NewListDatabaseTasksClusterNotInitialized(body *ListDatabaseTasksClusterNotInitializedResponseBody) *controlplane.APIError

NewListDatabaseTasksClusterNotInitialized builds a control-plane service list-database-tasks endpoint cluster_not_initialized error.

func NewListDatabaseTasksInvalidInput

func NewListDatabaseTasksInvalidInput(body *ListDatabaseTasksInvalidInputResponseBody) *controlplane.APIError

NewListDatabaseTasksInvalidInput builds a control-plane service list-database-tasks endpoint invalid_input error.

func NewListDatabaseTasksNotFound

func NewListDatabaseTasksNotFound(body *ListDatabaseTasksNotFoundResponseBody) *controlplane.APIError

NewListDatabaseTasksNotFound builds a control-plane service list-database-tasks endpoint not_found error.

func NewListDatabaseTasksResponseOK

func NewListDatabaseTasksResponseOK(body *ListDatabaseTasksResponseBody) *controlplane.ListDatabaseTasksResponse

NewListDatabaseTasksResponseOK builds a "control-plane" service "list-database-tasks" endpoint result from a HTTP "OK" response.

func NewListDatabaseTasksServerError

func NewListDatabaseTasksServerError(body *ListDatabaseTasksServerErrorResponseBody) *controlplane.APIError

NewListDatabaseTasksServerError builds a control-plane service list-database-tasks endpoint server_error error.

func NewListDatabasesClusterNotInitialized

func NewListDatabasesClusterNotInitialized(body *ListDatabasesClusterNotInitializedResponseBody) *controlplane.APIError

NewListDatabasesClusterNotInitialized builds a control-plane service list-databases endpoint cluster_not_initialized error.

func NewListDatabasesResponseOK added in v0.7.0

func NewListDatabasesResponseOK(body *ListDatabasesResponseBody) *controlplane.ListDatabasesResponse

NewListDatabasesResponseOK builds a "control-plane" service "list-databases" endpoint result from a HTTP "OK" response.

func NewListDatabasesServerError

func NewListDatabasesServerError(body *ListDatabasesServerErrorResponseBody) *controlplane.APIError

NewListDatabasesServerError builds a control-plane service list-databases endpoint server_error error.

func NewListHostTasksClusterNotInitialized added in v0.7.0

func NewListHostTasksClusterNotInitialized(body *ListHostTasksClusterNotInitializedResponseBody) *controlplane.APIError

NewListHostTasksClusterNotInitialized builds a control-plane service list-host-tasks endpoint cluster_not_initialized error.

func NewListHostTasksInvalidInput added in v0.7.0

func NewListHostTasksInvalidInput(body *ListHostTasksInvalidInputResponseBody) *controlplane.APIError

NewListHostTasksInvalidInput builds a control-plane service list-host-tasks endpoint invalid_input error.

func NewListHostTasksNotFound added in v0.7.0

func NewListHostTasksNotFound(body *ListHostTasksNotFoundResponseBody) *controlplane.APIError

NewListHostTasksNotFound builds a control-plane service list-host-tasks endpoint not_found error.

func NewListHostTasksResponseOK added in v0.7.0

func NewListHostTasksResponseOK(body *ListHostTasksResponseBody) *controlplane.ListHostTasksResponse

NewListHostTasksResponseOK builds a "control-plane" service "list-host-tasks" endpoint result from a HTTP "OK" response.

func NewListHostTasksServerError added in v0.7.0

func NewListHostTasksServerError(body *ListHostTasksServerErrorResponseBody) *controlplane.APIError

NewListHostTasksServerError builds a control-plane service list-host-tasks endpoint server_error error.

func NewListHostsClusterNotInitialized

func NewListHostsClusterNotInitialized(body *ListHostsClusterNotInitializedResponseBody) *controlplane.APIError

NewListHostsClusterNotInitialized builds a control-plane service list-hosts endpoint cluster_not_initialized error.

func NewListHostsResponseOK

func NewListHostsResponseOK(body *ListHostsResponseBody) *controlplane.ListHostsResponse

NewListHostsResponseOK builds a "control-plane" service "list-hosts" endpoint result from a HTTP "OK" response.

func NewListHostsServerError

func NewListHostsServerError(body *ListHostsServerErrorResponseBody) *controlplane.APIError

NewListHostsServerError builds a control-plane service list-hosts endpoint server_error error.

func NewListTasksClusterNotInitialized added in v0.7.0

func NewListTasksClusterNotInitialized(body *ListTasksClusterNotInitializedResponseBody) *controlplane.APIError

NewListTasksClusterNotInitialized builds a control-plane service list-tasks endpoint cluster_not_initialized error.

func NewListTasksInvalidInput added in v0.7.0

func NewListTasksInvalidInput(body *ListTasksInvalidInputResponseBody) *controlplane.APIError

NewListTasksInvalidInput builds a control-plane service list-tasks endpoint invalid_input error.

func NewListTasksResponseOK added in v0.7.0

func NewListTasksResponseOK(body *ListTasksResponseBody) *controlplane.ListTasksResponse

NewListTasksResponseOK builds a "control-plane" service "list-tasks" endpoint result from a HTTP "OK" response.

func NewListTasksServerError added in v0.7.0

func NewListTasksServerError(body *ListTasksServerErrorResponseBody) *controlplane.APIError

NewListTasksServerError builds a control-plane service list-tasks endpoint server_error error.

func NewRemoveHostClusterNotInitialized

func NewRemoveHostClusterNotInitialized(body *RemoveHostClusterNotInitializedResponseBody) *controlplane.APIError

NewRemoveHostClusterNotInitialized builds a control-plane service remove-host endpoint cluster_not_initialized error.

func NewRemoveHostInvalidInput

func NewRemoveHostInvalidInput(body *RemoveHostInvalidInputResponseBody) *controlplane.APIError

NewRemoveHostInvalidInput builds a control-plane service remove-host endpoint invalid_input error.

func NewRemoveHostNotFound

func NewRemoveHostNotFound(body *RemoveHostNotFoundResponseBody) *controlplane.APIError

NewRemoveHostNotFound builds a control-plane service remove-host endpoint not_found error.

func NewRemoveHostResponseOK added in v0.6.0

func NewRemoveHostResponseOK(body *RemoveHostResponseBody) *controlplane.RemoveHostResponse

NewRemoveHostResponseOK builds a "control-plane" service "remove-host" endpoint result from a HTTP "OK" response.

func NewRemoveHostServerError

func NewRemoveHostServerError(body *RemoveHostServerErrorResponseBody) *controlplane.APIError

NewRemoveHostServerError builds a control-plane service remove-host endpoint server_error error.

func NewRestartInstanceClusterNotInitialized

func NewRestartInstanceClusterNotInitialized(body *RestartInstanceClusterNotInitializedResponseBody) *controlplane.APIError

NewRestartInstanceClusterNotInitialized builds a control-plane service restart-instance endpoint cluster_not_initialized error.

func NewRestartInstanceInvalidInput

func NewRestartInstanceInvalidInput(body *RestartInstanceInvalidInputResponseBody) *controlplane.APIError

NewRestartInstanceInvalidInput builds a control-plane service restart-instance endpoint invalid_input error.

func NewRestartInstanceNotFound

func NewRestartInstanceNotFound(body *RestartInstanceNotFoundResponseBody) *controlplane.APIError

NewRestartInstanceNotFound builds a control-plane service restart-instance endpoint not_found error.

func NewRestartInstanceResponseOK

func NewRestartInstanceResponseOK(body *RestartInstanceResponseBody) *controlplane.RestartInstanceResponse

NewRestartInstanceResponseOK builds a "control-plane" service "restart-instance" endpoint result from a HTTP "OK" response.

func NewRestartInstanceServerError

func NewRestartInstanceServerError(body *RestartInstanceServerErrorResponseBody) *controlplane.APIError

NewRestartInstanceServerError builds a control-plane service restart-instance endpoint server_error error.

func NewRestoreDatabaseClusterNotInitialized

func NewRestoreDatabaseClusterNotInitialized(body *RestoreDatabaseClusterNotInitializedResponseBody) *controlplane.APIError

NewRestoreDatabaseClusterNotInitialized builds a control-plane service restore-database endpoint cluster_not_initialized error.

func NewRestoreDatabaseDatabaseNotModifiable

func NewRestoreDatabaseDatabaseNotModifiable(body *RestoreDatabaseDatabaseNotModifiableResponseBody) *controlplane.APIError

NewRestoreDatabaseDatabaseNotModifiable builds a control-plane service restore-database endpoint database_not_modifiable error.

func NewRestoreDatabaseInvalidInput

func NewRestoreDatabaseInvalidInput(body *RestoreDatabaseInvalidInputResponseBody) *controlplane.APIError

NewRestoreDatabaseInvalidInput builds a control-plane service restore-database endpoint invalid_input error.

func NewRestoreDatabaseNotFound

func NewRestoreDatabaseNotFound(body *RestoreDatabaseNotFoundResponseBody) *controlplane.APIError

NewRestoreDatabaseNotFound builds a control-plane service restore-database endpoint not_found error.

func NewRestoreDatabaseOperationAlreadyInProgress

func NewRestoreDatabaseOperationAlreadyInProgress(body *RestoreDatabaseOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewRestoreDatabaseOperationAlreadyInProgress builds a control-plane service restore-database endpoint operation_already_in_progress error.

func NewRestoreDatabaseResponseOK

func NewRestoreDatabaseResponseOK(body *RestoreDatabaseResponseBody) *controlplane.RestoreDatabaseResponse

NewRestoreDatabaseResponseOK builds a "control-plane" service "restore-database" endpoint result from a HTTP "OK" response.

func NewRestoreDatabaseServerError

func NewRestoreDatabaseServerError(body *RestoreDatabaseServerErrorResponseBody) *controlplane.APIError

NewRestoreDatabaseServerError builds a control-plane service restore-database endpoint server_error error.

func NewStartInstanceClusterNotInitialized

func NewStartInstanceClusterNotInitialized(body *StartInstanceClusterNotInitializedResponseBody) *controlplane.APIError

NewStartInstanceClusterNotInitialized builds a control-plane service start-instance endpoint cluster_not_initialized error.

func NewStartInstanceInvalidInput

func NewStartInstanceInvalidInput(body *StartInstanceInvalidInputResponseBody) *controlplane.APIError

NewStartInstanceInvalidInput builds a control-plane service start-instance endpoint invalid_input error.

func NewStartInstanceNotFound

func NewStartInstanceNotFound(body *StartInstanceNotFoundResponseBody) *controlplane.APIError

NewStartInstanceNotFound builds a control-plane service start-instance endpoint not_found error.

func NewStartInstanceResponseOK

func NewStartInstanceResponseOK(body *StartInstanceResponseBody) *controlplane.StartInstanceResponse

NewStartInstanceResponseOK builds a "control-plane" service "start-instance" endpoint result from a HTTP "OK" response.

func NewStartInstanceServerError

func NewStartInstanceServerError(body *StartInstanceServerErrorResponseBody) *controlplane.APIError

NewStartInstanceServerError builds a control-plane service start-instance endpoint server_error error.

func NewStopInstanceClusterNotInitialized

func NewStopInstanceClusterNotInitialized(body *StopInstanceClusterNotInitializedResponseBody) *controlplane.APIError

NewStopInstanceClusterNotInitialized builds a control-plane service stop-instance endpoint cluster_not_initialized error.

func NewStopInstanceInvalidInput

func NewStopInstanceInvalidInput(body *StopInstanceInvalidInputResponseBody) *controlplane.APIError

NewStopInstanceInvalidInput builds a control-plane service stop-instance endpoint invalid_input error.

func NewStopInstanceNotFound

func NewStopInstanceNotFound(body *StopInstanceNotFoundResponseBody) *controlplane.APIError

NewStopInstanceNotFound builds a control-plane service stop-instance endpoint not_found error.

func NewStopInstanceResponseOK

func NewStopInstanceResponseOK(body *StopInstanceResponseBody) *controlplane.StopInstanceResponse

NewStopInstanceResponseOK builds a "control-plane" service "stop-instance" endpoint result from a HTTP "OK" response.

func NewStopInstanceServerError

func NewStopInstanceServerError(body *StopInstanceServerErrorResponseBody) *controlplane.APIError

NewStopInstanceServerError builds a control-plane service stop-instance endpoint server_error error.

func NewSwitchoverDatabaseNodeClusterNotInitialized

func NewSwitchoverDatabaseNodeClusterNotInitialized(body *SwitchoverDatabaseNodeClusterNotInitializedResponseBody) *controlplane.APIError

NewSwitchoverDatabaseNodeClusterNotInitialized builds a control-plane service switchover-database-node endpoint cluster_not_initialized error.

func NewSwitchoverDatabaseNodeDatabaseNotModifiable

func NewSwitchoverDatabaseNodeDatabaseNotModifiable(body *SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody) *controlplane.APIError

NewSwitchoverDatabaseNodeDatabaseNotModifiable builds a control-plane service switchover-database-node endpoint database_not_modifiable error.

func NewSwitchoverDatabaseNodeInvalidInput

func NewSwitchoverDatabaseNodeInvalidInput(body *SwitchoverDatabaseNodeInvalidInputResponseBody) *controlplane.APIError

NewSwitchoverDatabaseNodeInvalidInput builds a control-plane service switchover-database-node endpoint invalid_input error.

func NewSwitchoverDatabaseNodeNotFound

func NewSwitchoverDatabaseNodeNotFound(body *SwitchoverDatabaseNodeNotFoundResponseBody) *controlplane.APIError

NewSwitchoverDatabaseNodeNotFound builds a control-plane service switchover-database-node endpoint not_found error.

func NewSwitchoverDatabaseNodeOperationAlreadyInProgress

func NewSwitchoverDatabaseNodeOperationAlreadyInProgress(body *SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewSwitchoverDatabaseNodeOperationAlreadyInProgress builds a control-plane service switchover-database-node endpoint operation_already_in_progress error.

func NewSwitchoverDatabaseNodeResponseOK

func NewSwitchoverDatabaseNodeResponseOK(body *SwitchoverDatabaseNodeResponseBody) *controlplane.SwitchoverDatabaseNodeResponse

NewSwitchoverDatabaseNodeResponseOK builds a "control-plane" service "switchover-database-node" endpoint result from a HTTP "OK" response.

func NewSwitchoverDatabaseNodeServerError

func NewSwitchoverDatabaseNodeServerError(body *SwitchoverDatabaseNodeServerErrorResponseBody) *controlplane.APIError

NewSwitchoverDatabaseNodeServerError builds a control-plane service switchover-database-node endpoint server_error error.

func NewUpdateDatabaseClusterNotInitialized

func NewUpdateDatabaseClusterNotInitialized(body *UpdateDatabaseClusterNotInitializedResponseBody) *controlplane.APIError

NewUpdateDatabaseClusterNotInitialized builds a control-plane service update-database endpoint cluster_not_initialized error.

func NewUpdateDatabaseDatabaseNotModifiable

func NewUpdateDatabaseDatabaseNotModifiable(body *UpdateDatabaseDatabaseNotModifiableResponseBody) *controlplane.APIError

NewUpdateDatabaseDatabaseNotModifiable builds a control-plane service update-database endpoint database_not_modifiable error.

func NewUpdateDatabaseInvalidInput

func NewUpdateDatabaseInvalidInput(body *UpdateDatabaseInvalidInputResponseBody) *controlplane.APIError

NewUpdateDatabaseInvalidInput builds a control-plane service update-database endpoint invalid_input error.

func NewUpdateDatabaseNotFound

func NewUpdateDatabaseNotFound(body *UpdateDatabaseNotFoundResponseBody) *controlplane.APIError

NewUpdateDatabaseNotFound builds a control-plane service update-database endpoint not_found error.

func NewUpdateDatabaseOperationAlreadyInProgress

func NewUpdateDatabaseOperationAlreadyInProgress(body *UpdateDatabaseOperationAlreadyInProgressResponseBody) *controlplane.APIError

NewUpdateDatabaseOperationAlreadyInProgress builds a control-plane service update-database endpoint operation_already_in_progress error.

func NewUpdateDatabaseResponseOK

func NewUpdateDatabaseResponseOK(body *UpdateDatabaseResponseBody) *controlplane.UpdateDatabaseResponse

NewUpdateDatabaseResponseOK builds a "control-plane" service "update-database" endpoint result from a HTTP "OK" response.

func NewUpdateDatabaseServerError

func NewUpdateDatabaseServerError(body *UpdateDatabaseServerErrorResponseBody) *controlplane.APIError

NewUpdateDatabaseServerError builds a control-plane service update-database endpoint server_error error.

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 ValidateBackupConfigSpecResponseBody

func ValidateBackupConfigSpecResponseBody(body *BackupConfigSpecResponseBody) (err error)

ValidateBackupConfigSpecResponseBody runs a no-op validation on BackupConfigSpecResponseBody

func ValidateBackupDatabaseNodeClusterNotInitializedResponseBody

func ValidateBackupDatabaseNodeClusterNotInitializedResponseBody(body *BackupDatabaseNodeClusterNotInitializedResponseBody) (err error)

ValidateBackupDatabaseNodeClusterNotInitializedResponseBody runs a no-op validation on backup-database-node_cluster_not_initialized_response_body

func ValidateBackupDatabaseNodeDatabaseNotModifiableResponseBody

func ValidateBackupDatabaseNodeDatabaseNotModifiableResponseBody(body *BackupDatabaseNodeDatabaseNotModifiableResponseBody) (err error)

ValidateBackupDatabaseNodeDatabaseNotModifiableResponseBody runs a no-op validation on backup-database-node_database_not_modifiable_response_body

func ValidateBackupDatabaseNodeInvalidInputResponseBody

func ValidateBackupDatabaseNodeInvalidInputResponseBody(body *BackupDatabaseNodeInvalidInputResponseBody) (err error)

ValidateBackupDatabaseNodeInvalidInputResponseBody runs a no-op validation on backup-database-node_invalid_input_response_body

func ValidateBackupDatabaseNodeNotFoundResponseBody

func ValidateBackupDatabaseNodeNotFoundResponseBody(body *BackupDatabaseNodeNotFoundResponseBody) (err error)

ValidateBackupDatabaseNodeNotFoundResponseBody runs a no-op validation on backup-database-node_not_found_response_body

func ValidateBackupDatabaseNodeOperationAlreadyInProgressResponseBody

func ValidateBackupDatabaseNodeOperationAlreadyInProgressResponseBody(body *BackupDatabaseNodeOperationAlreadyInProgressResponseBody) (err error)

ValidateBackupDatabaseNodeOperationAlreadyInProgressResponseBody runs a no-op validation on backup-database-node_operation_already_in_progress_response_body

func ValidateBackupDatabaseNodeResponseBody

func ValidateBackupDatabaseNodeResponseBody(body *BackupDatabaseNodeResponseBody) (err error)

ValidateBackupDatabaseNodeResponseBody runs a no-op validation on Backup-Database-NodeResponseBody

func ValidateBackupDatabaseNodeServerErrorResponseBody

func ValidateBackupDatabaseNodeServerErrorResponseBody(body *BackupDatabaseNodeServerErrorResponseBody) (err error)

ValidateBackupDatabaseNodeServerErrorResponseBody runs a no-op validation on backup-database-node_server_error_response_body

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 ValidateBackupRepositorySpecResponseBody

func ValidateBackupRepositorySpecResponseBody(body *BackupRepositorySpecResponseBody) (err error)

ValidateBackupRepositorySpecResponseBody runs a no-op validation on BackupRepositorySpecResponseBody

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 ValidateBackupScheduleSpecResponseBody

func ValidateBackupScheduleSpecResponseBody(body *BackupScheduleSpecResponseBody) (err error)

ValidateBackupScheduleSpecResponseBody runs a no-op validation on BackupScheduleSpecResponseBody

func ValidateCancelDatabaseTaskInvalidInputResponseBody

func ValidateCancelDatabaseTaskInvalidInputResponseBody(body *CancelDatabaseTaskInvalidInputResponseBody) (err error)

ValidateCancelDatabaseTaskInvalidInputResponseBody runs a no-op validation on cancel-database-task_invalid_input_response_body

func ValidateCancelDatabaseTaskNotFoundResponseBody

func ValidateCancelDatabaseTaskNotFoundResponseBody(body *CancelDatabaseTaskNotFoundResponseBody) (err error)

ValidateCancelDatabaseTaskNotFoundResponseBody runs a no-op validation on cancel-database-task_not_found_response_body

func ValidateCancelDatabaseTaskResponseBody

func ValidateCancelDatabaseTaskResponseBody(body *CancelDatabaseTaskResponseBody) (err error)

ValidateCancelDatabaseTaskResponseBody runs a no-op validation on Cancel-Database-TaskResponseBody

func ValidateCancelDatabaseTaskServerErrorResponseBody

func ValidateCancelDatabaseTaskServerErrorResponseBody(body *CancelDatabaseTaskServerErrorResponseBody) (err error)

ValidateCancelDatabaseTaskServerErrorResponseBody runs a no-op validation on cancel-database-task_server_error_response_body

func ValidateClusterCredentialsResponseBody

func ValidateClusterCredentialsResponseBody(body *ClusterCredentialsResponseBody) (err error)

ValidateClusterCredentialsResponseBody runs a no-op validation on ClusterCredentialsResponseBody

func ValidateClusterStatusResponseBody

func ValidateClusterStatusResponseBody(body *ClusterStatusResponseBody) (err error)

ValidateClusterStatusResponseBody runs a no-op validation on ClusterStatusResponseBody

func ValidateComponentStatusResponseBody

func ValidateComponentStatusResponseBody(body *ComponentStatusResponseBody) (err error)

ValidateComponentStatusResponseBody runs a no-op validation on ComponentStatusResponseBody

func ValidateCreateDatabaseClusterNotInitializedResponseBody

func ValidateCreateDatabaseClusterNotInitializedResponseBody(body *CreateDatabaseClusterNotInitializedResponseBody) (err error)

ValidateCreateDatabaseClusterNotInitializedResponseBody runs a no-op validation on create-database_cluster_not_initialized_response_body

func ValidateCreateDatabaseDatabaseAlreadyExistsResponseBody

func ValidateCreateDatabaseDatabaseAlreadyExistsResponseBody(body *CreateDatabaseDatabaseAlreadyExistsResponseBody) (err error)

ValidateCreateDatabaseDatabaseAlreadyExistsResponseBody runs a no-op validation on create-database_database_already_exists_response_body

func ValidateCreateDatabaseInvalidInputResponseBody

func ValidateCreateDatabaseInvalidInputResponseBody(body *CreateDatabaseInvalidInputResponseBody) (err error)

ValidateCreateDatabaseInvalidInputResponseBody runs a no-op validation on create-database_invalid_input_response_body

func ValidateCreateDatabaseOperationAlreadyInProgressResponseBody

func ValidateCreateDatabaseOperationAlreadyInProgressResponseBody(body *CreateDatabaseOperationAlreadyInProgressResponseBody) (err error)

ValidateCreateDatabaseOperationAlreadyInProgressResponseBody runs a no-op validation on create-database_operation_already_in_progress_response_body

func ValidateCreateDatabaseResponseBody

func ValidateCreateDatabaseResponseBody(body *CreateDatabaseResponseBody) (err error)

ValidateCreateDatabaseResponseBody runs a no-op validation on Create-DatabaseResponseBody

func ValidateCreateDatabaseServerErrorResponseBody

func ValidateCreateDatabaseServerErrorResponseBody(body *CreateDatabaseServerErrorResponseBody) (err error)

ValidateCreateDatabaseServerErrorResponseBody runs a no-op validation on create-database_server_error_response_body

func ValidateDatabaseConnectionRequestBody added in v0.7.0

func ValidateDatabaseConnectionRequestBody(body *DatabaseConnectionRequestBody) (err error)

ValidateDatabaseConnectionRequestBody runs the validations defined on DatabaseConnectionRequestBody

func ValidateDatabaseConnectionRequestBodyRequestBody added in v0.7.0

func ValidateDatabaseConnectionRequestBodyRequestBody(body *DatabaseConnectionRequestBodyRequestBody) (err error)

ValidateDatabaseConnectionRequestBodyRequestBody runs the validations defined on DatabaseConnectionRequestBodyRequestBody

func ValidateDatabaseConnectionResponseBody added in v0.7.0

func ValidateDatabaseConnectionResponseBody(body *DatabaseConnectionResponseBody) (err error)

ValidateDatabaseConnectionResponseBody runs a no-op validation on DatabaseConnectionResponseBody

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 ValidateDatabaseNodeSpecResponseBody

func ValidateDatabaseNodeSpecResponseBody(body *DatabaseNodeSpecResponseBody) (err error)

ValidateDatabaseNodeSpecResponseBody runs a no-op validation on DatabaseNodeSpecResponseBody

func ValidateDatabaseResponseBody

func ValidateDatabaseResponseBody(body *DatabaseResponseBody) (err error)

ValidateDatabaseResponseBody runs a no-op validation on DatabaseResponseBody

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 ValidateDatabaseSpecResponseBody

func ValidateDatabaseSpecResponseBody(body *DatabaseSpecResponseBody) (err error)

ValidateDatabaseSpecResponseBody runs a no-op validation on DatabaseSpecResponseBody

func ValidateDatabaseSummaryResponseBody added in v0.7.0

func ValidateDatabaseSummaryResponseBody(body *DatabaseSummaryResponseBody) (err error)

ValidateDatabaseSummaryResponseBody runs a no-op validation on DatabaseSummaryResponseBody

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 ValidateDatabaseUserSpecResponseBody

func ValidateDatabaseUserSpecResponseBody(body *DatabaseUserSpecResponseBody) (err error)

ValidateDatabaseUserSpecResponseBody runs a no-op validation on DatabaseUserSpecResponseBody

func ValidateDeleteDatabaseClusterNotInitializedResponseBody

func ValidateDeleteDatabaseClusterNotInitializedResponseBody(body *DeleteDatabaseClusterNotInitializedResponseBody) (err error)

ValidateDeleteDatabaseClusterNotInitializedResponseBody runs a no-op validation on delete-database_cluster_not_initialized_response_body

func ValidateDeleteDatabaseDatabaseNotModifiableResponseBody

func ValidateDeleteDatabaseDatabaseNotModifiableResponseBody(body *DeleteDatabaseDatabaseNotModifiableResponseBody) (err error)

ValidateDeleteDatabaseDatabaseNotModifiableResponseBody runs a no-op validation on delete-database_database_not_modifiable_response_body

func ValidateDeleteDatabaseInvalidInputResponseBody

func ValidateDeleteDatabaseInvalidInputResponseBody(body *DeleteDatabaseInvalidInputResponseBody) (err error)

ValidateDeleteDatabaseInvalidInputResponseBody runs a no-op validation on delete-database_invalid_input_response_body

func ValidateDeleteDatabaseNotFoundResponseBody

func ValidateDeleteDatabaseNotFoundResponseBody(body *DeleteDatabaseNotFoundResponseBody) (err error)

ValidateDeleteDatabaseNotFoundResponseBody runs a no-op validation on delete-database_not_found_response_body

func ValidateDeleteDatabaseOperationAlreadyInProgressResponseBody

func ValidateDeleteDatabaseOperationAlreadyInProgressResponseBody(body *DeleteDatabaseOperationAlreadyInProgressResponseBody) (err error)

ValidateDeleteDatabaseOperationAlreadyInProgressResponseBody runs a no-op validation on delete-database_operation_already_in_progress_response_body

func ValidateDeleteDatabaseResponseBody

func ValidateDeleteDatabaseResponseBody(body *DeleteDatabaseResponseBody) (err error)

ValidateDeleteDatabaseResponseBody runs a no-op validation on Delete-DatabaseResponseBody

func ValidateDeleteDatabaseServerErrorResponseBody

func ValidateDeleteDatabaseServerErrorResponseBody(body *DeleteDatabaseServerErrorResponseBody) (err error)

ValidateDeleteDatabaseServerErrorResponseBody runs a no-op validation on delete-database_server_error_response_body

func ValidateEtcdClusterMemberResponseBody

func ValidateEtcdClusterMemberResponseBody(body *EtcdClusterMemberResponseBody) (err error)

ValidateEtcdClusterMemberResponseBody runs a no-op validation on EtcdClusterMemberResponseBody

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 ValidateExtraNetworkSpecResponseBody

func ValidateExtraNetworkSpecResponseBody(body *ExtraNetworkSpecResponseBody) (err error)

ValidateExtraNetworkSpecResponseBody runs a no-op validation on ExtraNetworkSpecResponseBody

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 ValidateExtraVolumesSpecResponseBody

func ValidateExtraVolumesSpecResponseBody(body *ExtraVolumesSpecResponseBody) (err error)

ValidateExtraVolumesSpecResponseBody runs a no-op validation on ExtraVolumesSpecResponseBody

func ValidateFailoverDatabaseNodeClusterNotInitializedResponseBody

func ValidateFailoverDatabaseNodeClusterNotInitializedResponseBody(body *FailoverDatabaseNodeClusterNotInitializedResponseBody) (err error)

ValidateFailoverDatabaseNodeClusterNotInitializedResponseBody runs a no-op validation on failover-database-node_cluster_not_initialized_response_body

func ValidateFailoverDatabaseNodeDatabaseNotModifiableResponseBody

func ValidateFailoverDatabaseNodeDatabaseNotModifiableResponseBody(body *FailoverDatabaseNodeDatabaseNotModifiableResponseBody) (err error)

ValidateFailoverDatabaseNodeDatabaseNotModifiableResponseBody runs a no-op validation on failover-database-node_database_not_modifiable_response_body

func ValidateFailoverDatabaseNodeInvalidInputResponseBody

func ValidateFailoverDatabaseNodeInvalidInputResponseBody(body *FailoverDatabaseNodeInvalidInputResponseBody) (err error)

ValidateFailoverDatabaseNodeInvalidInputResponseBody runs a no-op validation on failover-database-node_invalid_input_response_body

func ValidateFailoverDatabaseNodeNotFoundResponseBody

func ValidateFailoverDatabaseNodeNotFoundResponseBody(body *FailoverDatabaseNodeNotFoundResponseBody) (err error)

ValidateFailoverDatabaseNodeNotFoundResponseBody runs a no-op validation on failover-database-node_not_found_response_body

func ValidateFailoverDatabaseNodeOperationAlreadyInProgressResponseBody

func ValidateFailoverDatabaseNodeOperationAlreadyInProgressResponseBody(body *FailoverDatabaseNodeOperationAlreadyInProgressResponseBody) (err error)

ValidateFailoverDatabaseNodeOperationAlreadyInProgressResponseBody runs a no-op validation on failover-database-node_operation_already_in_progress_response_body

func ValidateFailoverDatabaseNodeResponseBody

func ValidateFailoverDatabaseNodeResponseBody(body *FailoverDatabaseNodeResponseBody) (err error)

ValidateFailoverDatabaseNodeResponseBody runs a no-op validation on Failover-Database-NodeResponseBody

func ValidateFailoverDatabaseNodeServerErrorResponseBody

func ValidateFailoverDatabaseNodeServerErrorResponseBody(body *FailoverDatabaseNodeServerErrorResponseBody) (err error)

ValidateFailoverDatabaseNodeServerErrorResponseBody runs a no-op validation on failover-database-node_server_error_response_body

func ValidateGetClusterClusterNotInitializedResponseBody

func ValidateGetClusterClusterNotInitializedResponseBody(body *GetClusterClusterNotInitializedResponseBody) (err error)

ValidateGetClusterClusterNotInitializedResponseBody runs a no-op validation on get-cluster_cluster_not_initialized_response_body

func ValidateGetClusterResponseBody

func ValidateGetClusterResponseBody(body *GetClusterResponseBody) (err error)

ValidateGetClusterResponseBody runs a no-op validation on Get-ClusterResponseBody

func ValidateGetClusterServerErrorResponseBody

func ValidateGetClusterServerErrorResponseBody(body *GetClusterServerErrorResponseBody) (err error)

ValidateGetClusterServerErrorResponseBody runs a no-op validation on get-cluster_server_error_response_body

func ValidateGetDatabaseClusterNotInitializedResponseBody

func ValidateGetDatabaseClusterNotInitializedResponseBody(body *GetDatabaseClusterNotInitializedResponseBody) (err error)

ValidateGetDatabaseClusterNotInitializedResponseBody runs a no-op validation on get-database_cluster_not_initialized_response_body

func ValidateGetDatabaseInvalidInputResponseBody

func ValidateGetDatabaseInvalidInputResponseBody(body *GetDatabaseInvalidInputResponseBody) (err error)

ValidateGetDatabaseInvalidInputResponseBody runs a no-op validation on get-database_invalid_input_response_body

func ValidateGetDatabaseNotFoundResponseBody

func ValidateGetDatabaseNotFoundResponseBody(body *GetDatabaseNotFoundResponseBody) (err error)

ValidateGetDatabaseNotFoundResponseBody runs a no-op validation on get-database_not_found_response_body

func ValidateGetDatabaseResponseBody added in v0.7.0

func ValidateGetDatabaseResponseBody(body *GetDatabaseResponseBody) (err error)

ValidateGetDatabaseResponseBody runs a no-op validation on Get-DatabaseResponseBody

func ValidateGetDatabaseServerErrorResponseBody

func ValidateGetDatabaseServerErrorResponseBody(body *GetDatabaseServerErrorResponseBody) (err error)

ValidateGetDatabaseServerErrorResponseBody runs a no-op validation on get-database_server_error_response_body

func ValidateGetDatabaseTaskClusterNotInitializedResponseBody

func ValidateGetDatabaseTaskClusterNotInitializedResponseBody(body *GetDatabaseTaskClusterNotInitializedResponseBody) (err error)

ValidateGetDatabaseTaskClusterNotInitializedResponseBody runs a no-op validation on get-database-task_cluster_not_initialized_response_body

func ValidateGetDatabaseTaskInvalidInputResponseBody

func ValidateGetDatabaseTaskInvalidInputResponseBody(body *GetDatabaseTaskInvalidInputResponseBody) (err error)

ValidateGetDatabaseTaskInvalidInputResponseBody runs a no-op validation on get-database-task_invalid_input_response_body

func ValidateGetDatabaseTaskLogClusterNotInitializedResponseBody

func ValidateGetDatabaseTaskLogClusterNotInitializedResponseBody(body *GetDatabaseTaskLogClusterNotInitializedResponseBody) (err error)

ValidateGetDatabaseTaskLogClusterNotInitializedResponseBody runs a no-op validation on get-database-task-log_cluster_not_initialized_response_body

func ValidateGetDatabaseTaskLogInvalidInputResponseBody

func ValidateGetDatabaseTaskLogInvalidInputResponseBody(body *GetDatabaseTaskLogInvalidInputResponseBody) (err error)

ValidateGetDatabaseTaskLogInvalidInputResponseBody runs a no-op validation on get-database-task-log_invalid_input_response_body

func ValidateGetDatabaseTaskLogNotFoundResponseBody

func ValidateGetDatabaseTaskLogNotFoundResponseBody(body *GetDatabaseTaskLogNotFoundResponseBody) (err error)

ValidateGetDatabaseTaskLogNotFoundResponseBody runs a no-op validation on get-database-task-log_not_found_response_body

func ValidateGetDatabaseTaskLogResponseBody

func ValidateGetDatabaseTaskLogResponseBody(body *GetDatabaseTaskLogResponseBody) (err error)

ValidateGetDatabaseTaskLogResponseBody runs a no-op validation on Get-Database-Task-LogResponseBody

func ValidateGetDatabaseTaskLogServerErrorResponseBody

func ValidateGetDatabaseTaskLogServerErrorResponseBody(body *GetDatabaseTaskLogServerErrorResponseBody) (err error)

ValidateGetDatabaseTaskLogServerErrorResponseBody runs a no-op validation on get-database-task-log_server_error_response_body

func ValidateGetDatabaseTaskNotFoundResponseBody

func ValidateGetDatabaseTaskNotFoundResponseBody(body *GetDatabaseTaskNotFoundResponseBody) (err error)

ValidateGetDatabaseTaskNotFoundResponseBody runs a no-op validation on get-database-task_not_found_response_body

func ValidateGetDatabaseTaskResponseBody

func ValidateGetDatabaseTaskResponseBody(body *GetDatabaseTaskResponseBody) (err error)

ValidateGetDatabaseTaskResponseBody runs a no-op validation on Get-Database-TaskResponseBody

func ValidateGetDatabaseTaskServerErrorResponseBody

func ValidateGetDatabaseTaskServerErrorResponseBody(body *GetDatabaseTaskServerErrorResponseBody) (err error)

ValidateGetDatabaseTaskServerErrorResponseBody runs a no-op validation on get-database-task_server_error_response_body

func ValidateGetHostClusterNotInitializedResponseBody

func ValidateGetHostClusterNotInitializedResponseBody(body *GetHostClusterNotInitializedResponseBody) (err error)

ValidateGetHostClusterNotInitializedResponseBody runs a no-op validation on get-host_cluster_not_initialized_response_body

func ValidateGetHostInvalidInputResponseBody

func ValidateGetHostInvalidInputResponseBody(body *GetHostInvalidInputResponseBody) (err error)

ValidateGetHostInvalidInputResponseBody runs a no-op validation on get-host_invalid_input_response_body

func ValidateGetHostNotFoundResponseBody

func ValidateGetHostNotFoundResponseBody(body *GetHostNotFoundResponseBody) (err error)

ValidateGetHostNotFoundResponseBody runs a no-op validation on get-host_not_found_response_body

func ValidateGetHostResponseBody

func ValidateGetHostResponseBody(body *GetHostResponseBody) (err error)

ValidateGetHostResponseBody runs a no-op validation on Get-HostResponseBody

func ValidateGetHostServerErrorResponseBody

func ValidateGetHostServerErrorResponseBody(body *GetHostServerErrorResponseBody) (err error)

ValidateGetHostServerErrorResponseBody runs a no-op validation on get-host_server_error_response_body

func ValidateGetHostTaskClusterNotInitializedResponseBody added in v0.7.0

func ValidateGetHostTaskClusterNotInitializedResponseBody(body *GetHostTaskClusterNotInitializedResponseBody) (err error)

ValidateGetHostTaskClusterNotInitializedResponseBody runs a no-op validation on get-host-task_cluster_not_initialized_response_body

func ValidateGetHostTaskInvalidInputResponseBody added in v0.7.0

func ValidateGetHostTaskInvalidInputResponseBody(body *GetHostTaskInvalidInputResponseBody) (err error)

ValidateGetHostTaskInvalidInputResponseBody runs a no-op validation on get-host-task_invalid_input_response_body

func ValidateGetHostTaskLogClusterNotInitializedResponseBody added in v0.7.0

func ValidateGetHostTaskLogClusterNotInitializedResponseBody(body *GetHostTaskLogClusterNotInitializedResponseBody) (err error)

ValidateGetHostTaskLogClusterNotInitializedResponseBody runs a no-op validation on get-host-task-log_cluster_not_initialized_response_body

func ValidateGetHostTaskLogInvalidInputResponseBody added in v0.7.0

func ValidateGetHostTaskLogInvalidInputResponseBody(body *GetHostTaskLogInvalidInputResponseBody) (err error)

ValidateGetHostTaskLogInvalidInputResponseBody runs a no-op validation on get-host-task-log_invalid_input_response_body

func ValidateGetHostTaskLogNotFoundResponseBody added in v0.7.0

func ValidateGetHostTaskLogNotFoundResponseBody(body *GetHostTaskLogNotFoundResponseBody) (err error)

ValidateGetHostTaskLogNotFoundResponseBody runs a no-op validation on get-host-task-log_not_found_response_body

func ValidateGetHostTaskLogResponseBody added in v0.7.0

func ValidateGetHostTaskLogResponseBody(body *GetHostTaskLogResponseBody) (err error)

ValidateGetHostTaskLogResponseBody runs a no-op validation on Get-Host-Task-LogResponseBody

func ValidateGetHostTaskLogServerErrorResponseBody added in v0.7.0

func ValidateGetHostTaskLogServerErrorResponseBody(body *GetHostTaskLogServerErrorResponseBody) (err error)

ValidateGetHostTaskLogServerErrorResponseBody runs a no-op validation on get-host-task-log_server_error_response_body

func ValidateGetHostTaskNotFoundResponseBody added in v0.7.0

func ValidateGetHostTaskNotFoundResponseBody(body *GetHostTaskNotFoundResponseBody) (err error)

ValidateGetHostTaskNotFoundResponseBody runs a no-op validation on get-host-task_not_found_response_body

func ValidateGetHostTaskResponseBody added in v0.7.0

func ValidateGetHostTaskResponseBody(body *GetHostTaskResponseBody) (err error)

ValidateGetHostTaskResponseBody runs a no-op validation on Get-Host-TaskResponseBody

func ValidateGetHostTaskServerErrorResponseBody added in v0.7.0

func ValidateGetHostTaskServerErrorResponseBody(body *GetHostTaskServerErrorResponseBody) (err error)

ValidateGetHostTaskServerErrorResponseBody runs a no-op validation on get-host-task_server_error_response_body

func ValidateGetJoinOptionsClusterNotInitializedResponseBody

func ValidateGetJoinOptionsClusterNotInitializedResponseBody(body *GetJoinOptionsClusterNotInitializedResponseBody) (err error)

ValidateGetJoinOptionsClusterNotInitializedResponseBody runs a no-op validation on get-join-options_cluster_not_initialized_response_body

func ValidateGetJoinOptionsInvalidInputResponseBody added in v0.6.0

func ValidateGetJoinOptionsInvalidInputResponseBody(body *GetJoinOptionsInvalidInputResponseBody) (err error)

ValidateGetJoinOptionsInvalidInputResponseBody runs a no-op validation on get-join-options_invalid_input_response_body

func ValidateGetJoinOptionsInvalidJoinTokenResponseBody

func ValidateGetJoinOptionsInvalidJoinTokenResponseBody(body *GetJoinOptionsInvalidJoinTokenResponseBody) (err error)

ValidateGetJoinOptionsInvalidJoinTokenResponseBody runs a no-op validation on get-join-options_invalid_join_token_response_body

func ValidateGetJoinOptionsResponseBody

func ValidateGetJoinOptionsResponseBody(body *GetJoinOptionsResponseBody) (err error)

ValidateGetJoinOptionsResponseBody runs a no-op validation on Get-Join-OptionsResponseBody

func ValidateGetJoinOptionsServerErrorResponseBody

func ValidateGetJoinOptionsServerErrorResponseBody(body *GetJoinOptionsServerErrorResponseBody) (err error)

ValidateGetJoinOptionsServerErrorResponseBody runs a no-op validation on get-join-options_server_error_response_body

func ValidateGetJoinTokenClusterNotInitializedResponseBody

func ValidateGetJoinTokenClusterNotInitializedResponseBody(body *GetJoinTokenClusterNotInitializedResponseBody) (err error)

ValidateGetJoinTokenClusterNotInitializedResponseBody runs a no-op validation on get-join-token_cluster_not_initialized_response_body

func ValidateGetJoinTokenResponseBody

func ValidateGetJoinTokenResponseBody(body *GetJoinTokenResponseBody) (err error)

ValidateGetJoinTokenResponseBody runs a no-op validation on Get-Join-TokenResponseBody

func ValidateGetJoinTokenServerErrorResponseBody

func ValidateGetJoinTokenServerErrorResponseBody(body *GetJoinTokenServerErrorResponseBody) (err error)

ValidateGetJoinTokenServerErrorResponseBody runs a no-op validation on get-join-token_server_error_response_body

func ValidateGetVersionResponseBody

func ValidateGetVersionResponseBody(body *GetVersionResponseBody) (err error)

ValidateGetVersionResponseBody runs a no-op validation on Get-VersionResponseBody

func ValidateGetVersionServerErrorResponseBody

func ValidateGetVersionServerErrorResponseBody(body *GetVersionServerErrorResponseBody) (err error)

ValidateGetVersionServerErrorResponseBody runs a no-op validation on get-version_server_error_response_body

func ValidateHealthCheckResultResponseBody added in v0.7.0

func ValidateHealthCheckResultResponseBody(body *HealthCheckResultResponseBody) (err error)

ValidateHealthCheckResultResponseBody runs a no-op validation on HealthCheckResultResponseBody

func ValidateHostCohortResponseBody

func ValidateHostCohortResponseBody(body *HostCohortResponseBody) (err error)

ValidateHostCohortResponseBody runs a no-op validation on HostCohortResponseBody

func ValidateHostResponseBody

func ValidateHostResponseBody(body *HostResponseBody) (err error)

ValidateHostResponseBody runs a no-op validation on HostResponseBody

func ValidateHostStatusResponseBody

func ValidateHostStatusResponseBody(body *HostStatusResponseBody) (err error)

ValidateHostStatusResponseBody runs a no-op validation on HostStatusResponseBody

func ValidateInitClusterClusterAlreadyInitializedResponseBody

func ValidateInitClusterClusterAlreadyInitializedResponseBody(body *InitClusterClusterAlreadyInitializedResponseBody) (err error)

ValidateInitClusterClusterAlreadyInitializedResponseBody runs a no-op validation on init-cluster_cluster_already_initialized_response_body

func ValidateInitClusterOperationNotSupportedResponseBody

func ValidateInitClusterOperationNotSupportedResponseBody(body *InitClusterOperationNotSupportedResponseBody) (err error)

ValidateInitClusterOperationNotSupportedResponseBody runs a no-op validation on init-cluster_operation_not_supported_response_body

func ValidateInitClusterResponseBody

func ValidateInitClusterResponseBody(body *InitClusterResponseBody) (err error)

ValidateInitClusterResponseBody runs a no-op validation on Init-ClusterResponseBody

func ValidateInitClusterServerErrorResponseBody

func ValidateInitClusterServerErrorResponseBody(body *InitClusterServerErrorResponseBody) (err error)

ValidateInitClusterServerErrorResponseBody runs a no-op validation on init-cluster_server_error_response_body

func ValidateInstanceResponseBody

func ValidateInstanceResponseBody(body *InstanceResponseBody) (err error)

ValidateInstanceResponseBody runs a no-op validation on InstanceResponseBody

func ValidateInstanceSpockStatusResponseBody

func ValidateInstanceSpockStatusResponseBody(body *InstanceSpockStatusResponseBody) (err error)

ValidateInstanceSpockStatusResponseBody runs a no-op validation on InstanceSpockStatusResponseBody

func ValidateInstanceSubscriptionResponseBody

func ValidateInstanceSubscriptionResponseBody(body *InstanceSubscriptionResponseBody) (err error)

ValidateInstanceSubscriptionResponseBody runs a no-op validation on InstanceSubscriptionResponseBody

func ValidateJoinClusterClusterAlreadyInitializedResponseBody

func ValidateJoinClusterClusterAlreadyInitializedResponseBody(body *JoinClusterClusterAlreadyInitializedResponseBody) (err error)

ValidateJoinClusterClusterAlreadyInitializedResponseBody runs a no-op validation on join-cluster_cluster_already_initialized_response_body

func ValidateJoinClusterInvalidInputResponseBody added in v0.6.0

func ValidateJoinClusterInvalidInputResponseBody(body *JoinClusterInvalidInputResponseBody) (err error)

ValidateJoinClusterInvalidInputResponseBody runs a no-op validation on join-cluster_invalid_input_response_body

func ValidateJoinClusterInvalidJoinTokenResponseBody

func ValidateJoinClusterInvalidJoinTokenResponseBody(body *JoinClusterInvalidJoinTokenResponseBody) (err error)

ValidateJoinClusterInvalidJoinTokenResponseBody runs a no-op validation on join-cluster_invalid_join_token_response_body

func ValidateJoinClusterServerErrorResponseBody

func ValidateJoinClusterServerErrorResponseBody(body *JoinClusterServerErrorResponseBody) (err error)

ValidateJoinClusterServerErrorResponseBody runs a no-op validation on join-cluster_server_error_response_body

func ValidateListDatabaseTasksClusterNotInitializedResponseBody

func ValidateListDatabaseTasksClusterNotInitializedResponseBody(body *ListDatabaseTasksClusterNotInitializedResponseBody) (err error)

ValidateListDatabaseTasksClusterNotInitializedResponseBody runs a no-op validation on list-database-tasks_cluster_not_initialized_response_body

func ValidateListDatabaseTasksInvalidInputResponseBody

func ValidateListDatabaseTasksInvalidInputResponseBody(body *ListDatabaseTasksInvalidInputResponseBody) (err error)

ValidateListDatabaseTasksInvalidInputResponseBody runs a no-op validation on list-database-tasks_invalid_input_response_body

func ValidateListDatabaseTasksNotFoundResponseBody

func ValidateListDatabaseTasksNotFoundResponseBody(body *ListDatabaseTasksNotFoundResponseBody) (err error)

ValidateListDatabaseTasksNotFoundResponseBody runs a no-op validation on list-database-tasks_not_found_response_body

func ValidateListDatabaseTasksResponseBody

func ValidateListDatabaseTasksResponseBody(body *ListDatabaseTasksResponseBody) (err error)

ValidateListDatabaseTasksResponseBody runs a no-op validation on List-Database-TasksResponseBody

func ValidateListDatabaseTasksServerErrorResponseBody

func ValidateListDatabaseTasksServerErrorResponseBody(body *ListDatabaseTasksServerErrorResponseBody) (err error)

ValidateListDatabaseTasksServerErrorResponseBody runs a no-op validation on list-database-tasks_server_error_response_body

func ValidateListDatabasesClusterNotInitializedResponseBody

func ValidateListDatabasesClusterNotInitializedResponseBody(body *ListDatabasesClusterNotInitializedResponseBody) (err error)

ValidateListDatabasesClusterNotInitializedResponseBody runs a no-op validation on list-databases_cluster_not_initialized_response_body

func ValidateListDatabasesResponseBody added in v0.7.0

func ValidateListDatabasesResponseBody(body *ListDatabasesResponseBody) (err error)

ValidateListDatabasesResponseBody runs a no-op validation on List-DatabasesResponseBody

func ValidateListDatabasesServerErrorResponseBody

func ValidateListDatabasesServerErrorResponseBody(body *ListDatabasesServerErrorResponseBody) (err error)

ValidateListDatabasesServerErrorResponseBody runs a no-op validation on list-databases_server_error_response_body

func ValidateListHostTasksClusterNotInitializedResponseBody added in v0.7.0

func ValidateListHostTasksClusterNotInitializedResponseBody(body *ListHostTasksClusterNotInitializedResponseBody) (err error)

ValidateListHostTasksClusterNotInitializedResponseBody runs a no-op validation on list-host-tasks_cluster_not_initialized_response_body

func ValidateListHostTasksInvalidInputResponseBody added in v0.7.0

func ValidateListHostTasksInvalidInputResponseBody(body *ListHostTasksInvalidInputResponseBody) (err error)

ValidateListHostTasksInvalidInputResponseBody runs a no-op validation on list-host-tasks_invalid_input_response_body

func ValidateListHostTasksNotFoundResponseBody added in v0.7.0

func ValidateListHostTasksNotFoundResponseBody(body *ListHostTasksNotFoundResponseBody) (err error)

ValidateListHostTasksNotFoundResponseBody runs a no-op validation on list-host-tasks_not_found_response_body

func ValidateListHostTasksResponseBody added in v0.7.0

func ValidateListHostTasksResponseBody(body *ListHostTasksResponseBody) (err error)

ValidateListHostTasksResponseBody runs a no-op validation on List-Host-TasksResponseBody

func ValidateListHostTasksServerErrorResponseBody added in v0.7.0

func ValidateListHostTasksServerErrorResponseBody(body *ListHostTasksServerErrorResponseBody) (err error)

ValidateListHostTasksServerErrorResponseBody runs a no-op validation on list-host-tasks_server_error_response_body

func ValidateListHostsClusterNotInitializedResponseBody

func ValidateListHostsClusterNotInitializedResponseBody(body *ListHostsClusterNotInitializedResponseBody) (err error)

ValidateListHostsClusterNotInitializedResponseBody runs a no-op validation on list-hosts_cluster_not_initialized_response_body

func ValidateListHostsResponseBody

func ValidateListHostsResponseBody(body *ListHostsResponseBody) (err error)

ValidateListHostsResponseBody runs a no-op validation on List-HostsResponseBody

func ValidateListHostsServerErrorResponseBody

func ValidateListHostsServerErrorResponseBody(body *ListHostsServerErrorResponseBody) (err error)

ValidateListHostsServerErrorResponseBody runs a no-op validation on list-hosts_server_error_response_body

func ValidateListTasksClusterNotInitializedResponseBody added in v0.7.0

func ValidateListTasksClusterNotInitializedResponseBody(body *ListTasksClusterNotInitializedResponseBody) (err error)

ValidateListTasksClusterNotInitializedResponseBody runs a no-op validation on list-tasks_cluster_not_initialized_response_body

func ValidateListTasksInvalidInputResponseBody added in v0.7.0

func ValidateListTasksInvalidInputResponseBody(body *ListTasksInvalidInputResponseBody) (err error)

ValidateListTasksInvalidInputResponseBody runs a no-op validation on list-tasks_invalid_input_response_body

func ValidateListTasksResponseBody added in v0.7.0

func ValidateListTasksResponseBody(body *ListTasksResponseBody) (err error)

ValidateListTasksResponseBody runs a no-op validation on List-TasksResponseBody

func ValidateListTasksServerErrorResponseBody added in v0.7.0

func ValidateListTasksServerErrorResponseBody(body *ListTasksServerErrorResponseBody) (err error)

ValidateListTasksServerErrorResponseBody runs a no-op validation on list-tasks_server_error_response_body

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 ValidateOrchestratorOptsResponseBody

func ValidateOrchestratorOptsResponseBody(body *OrchestratorOptsResponseBody) (err error)

ValidateOrchestratorOptsResponseBody runs a no-op validation on OrchestratorOptsResponseBody

func ValidatePgEdgeVersionResponseBody

func ValidatePgEdgeVersionResponseBody(body *PgEdgeVersionResponseBody) (err error)

ValidatePgEdgeVersionResponseBody runs a no-op validation on PgEdgeVersionResponseBody

func ValidatePortMappingResponseBody added in v0.7.0

func ValidatePortMappingResponseBody(body *PortMappingResponseBody) (err error)

ValidatePortMappingResponseBody runs a no-op validation on PortMappingResponseBody

func ValidateRemoveHostClusterNotInitializedResponseBody

func ValidateRemoveHostClusterNotInitializedResponseBody(body *RemoveHostClusterNotInitializedResponseBody) (err error)

ValidateRemoveHostClusterNotInitializedResponseBody runs a no-op validation on remove-host_cluster_not_initialized_response_body

func ValidateRemoveHostInvalidInputResponseBody

func ValidateRemoveHostInvalidInputResponseBody(body *RemoveHostInvalidInputResponseBody) (err error)

ValidateRemoveHostInvalidInputResponseBody runs a no-op validation on remove-host_invalid_input_response_body

func ValidateRemoveHostNotFoundResponseBody

func ValidateRemoveHostNotFoundResponseBody(body *RemoveHostNotFoundResponseBody) (err error)

ValidateRemoveHostNotFoundResponseBody runs a no-op validation on remove-host_not_found_response_body

func ValidateRemoveHostResponseBody added in v0.6.0

func ValidateRemoveHostResponseBody(body *RemoveHostResponseBody) (err error)

ValidateRemoveHostResponseBody runs a no-op validation on Remove-HostResponseBody

func ValidateRemoveHostServerErrorResponseBody

func ValidateRemoveHostServerErrorResponseBody(body *RemoveHostServerErrorResponseBody) (err error)

ValidateRemoveHostServerErrorResponseBody runs a no-op validation on remove-host_server_error_response_body

func ValidateRestartInstanceClusterNotInitializedResponseBody

func ValidateRestartInstanceClusterNotInitializedResponseBody(body *RestartInstanceClusterNotInitializedResponseBody) (err error)

ValidateRestartInstanceClusterNotInitializedResponseBody runs a no-op validation on restart-instance_cluster_not_initialized_response_body

func ValidateRestartInstanceInvalidInputResponseBody

func ValidateRestartInstanceInvalidInputResponseBody(body *RestartInstanceInvalidInputResponseBody) (err error)

ValidateRestartInstanceInvalidInputResponseBody runs a no-op validation on restart-instance_invalid_input_response_body

func ValidateRestartInstanceNotFoundResponseBody

func ValidateRestartInstanceNotFoundResponseBody(body *RestartInstanceNotFoundResponseBody) (err error)

ValidateRestartInstanceNotFoundResponseBody runs a no-op validation on restart-instance_not_found_response_body

func ValidateRestartInstanceResponseBody

func ValidateRestartInstanceResponseBody(body *RestartInstanceResponseBody) (err error)

ValidateRestartInstanceResponseBody runs a no-op validation on Restart-InstanceResponseBody

func ValidateRestartInstanceServerErrorResponseBody

func ValidateRestartInstanceServerErrorResponseBody(body *RestartInstanceServerErrorResponseBody) (err error)

ValidateRestartInstanceServerErrorResponseBody runs a no-op validation on restart-instance_server_error_response_body

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 ValidateRestoreConfigSpecResponseBody

func ValidateRestoreConfigSpecResponseBody(body *RestoreConfigSpecResponseBody) (err error)

ValidateRestoreConfigSpecResponseBody runs a no-op validation on RestoreConfigSpecResponseBody

func ValidateRestoreDatabaseClusterNotInitializedResponseBody

func ValidateRestoreDatabaseClusterNotInitializedResponseBody(body *RestoreDatabaseClusterNotInitializedResponseBody) (err error)

ValidateRestoreDatabaseClusterNotInitializedResponseBody runs a no-op validation on restore-database_cluster_not_initialized_response_body

func ValidateRestoreDatabaseDatabaseNotModifiableResponseBody

func ValidateRestoreDatabaseDatabaseNotModifiableResponseBody(body *RestoreDatabaseDatabaseNotModifiableResponseBody) (err error)

ValidateRestoreDatabaseDatabaseNotModifiableResponseBody runs a no-op validation on restore-database_database_not_modifiable_response_body

func ValidateRestoreDatabaseInvalidInputResponseBody

func ValidateRestoreDatabaseInvalidInputResponseBody(body *RestoreDatabaseInvalidInputResponseBody) (err error)

ValidateRestoreDatabaseInvalidInputResponseBody runs a no-op validation on restore-database_invalid_input_response_body

func ValidateRestoreDatabaseNotFoundResponseBody

func ValidateRestoreDatabaseNotFoundResponseBody(body *RestoreDatabaseNotFoundResponseBody) (err error)

ValidateRestoreDatabaseNotFoundResponseBody runs a no-op validation on restore-database_not_found_response_body

func ValidateRestoreDatabaseOperationAlreadyInProgressResponseBody

func ValidateRestoreDatabaseOperationAlreadyInProgressResponseBody(body *RestoreDatabaseOperationAlreadyInProgressResponseBody) (err error)

ValidateRestoreDatabaseOperationAlreadyInProgressResponseBody runs a no-op validation on restore-database_operation_already_in_progress_response_body

func ValidateRestoreDatabaseResponseBody

func ValidateRestoreDatabaseResponseBody(body *RestoreDatabaseResponseBody) (err error)

ValidateRestoreDatabaseResponseBody runs a no-op validation on Restore-DatabaseResponseBody

func ValidateRestoreDatabaseServerErrorResponseBody

func ValidateRestoreDatabaseServerErrorResponseBody(body *RestoreDatabaseServerErrorResponseBody) (err error)

ValidateRestoreDatabaseServerErrorResponseBody runs a no-op validation on restore-database_server_error_response_body

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 ValidateRestoreRepositorySpecResponseBody

func ValidateRestoreRepositorySpecResponseBody(body *RestoreRepositorySpecResponseBody) (err error)

ValidateRestoreRepositorySpecResponseBody runs a no-op validation on RestoreRepositorySpecResponseBody

func ValidateServiceInstanceResponseBody added in v0.7.0

func ValidateServiceInstanceResponseBody(body *ServiceInstanceResponseBody) (err error)

ValidateServiceInstanceResponseBody runs a no-op validation on ServiceInstanceResponseBody

func ValidateServiceInstanceStatusResponseBody added in v0.7.0

func ValidateServiceInstanceStatusResponseBody(body *ServiceInstanceStatusResponseBody) (err error)

ValidateServiceInstanceStatusResponseBody runs a no-op validation on ServiceInstanceStatusResponseBody

func ValidateServiceSpecRequestBody added in v0.7.0

func ValidateServiceSpecRequestBody(body *ServiceSpecRequestBody) (err error)

ValidateServiceSpecRequestBody runs the validations defined on ServiceSpecRequestBody

func ValidateServiceSpecRequestBodyRequestBody added in v0.7.0

func ValidateServiceSpecRequestBodyRequestBody(body *ServiceSpecRequestBodyRequestBody) (err error)

ValidateServiceSpecRequestBodyRequestBody runs the validations defined on ServiceSpecRequestBodyRequestBody

func ValidateServiceSpecResponseBody added in v0.7.0

func ValidateServiceSpecResponseBody(body *ServiceSpecResponseBody) (err error)

ValidateServiceSpecResponseBody runs a no-op validation on ServiceSpecResponseBody

func ValidateStartInstanceClusterNotInitializedResponseBody

func ValidateStartInstanceClusterNotInitializedResponseBody(body *StartInstanceClusterNotInitializedResponseBody) (err error)

ValidateStartInstanceClusterNotInitializedResponseBody runs a no-op validation on start-instance_cluster_not_initialized_response_body

func ValidateStartInstanceInvalidInputResponseBody

func ValidateStartInstanceInvalidInputResponseBody(body *StartInstanceInvalidInputResponseBody) (err error)

ValidateStartInstanceInvalidInputResponseBody runs a no-op validation on start-instance_invalid_input_response_body

func ValidateStartInstanceNotFoundResponseBody

func ValidateStartInstanceNotFoundResponseBody(body *StartInstanceNotFoundResponseBody) (err error)

ValidateStartInstanceNotFoundResponseBody runs a no-op validation on start-instance_not_found_response_body

func ValidateStartInstanceResponseBody

func ValidateStartInstanceResponseBody(body *StartInstanceResponseBody) (err error)

ValidateStartInstanceResponseBody runs a no-op validation on Start-InstanceResponseBody

func ValidateStartInstanceServerErrorResponseBody

func ValidateStartInstanceServerErrorResponseBody(body *StartInstanceServerErrorResponseBody) (err error)

ValidateStartInstanceServerErrorResponseBody runs a no-op validation on start-instance_server_error_response_body

func ValidateStopInstanceClusterNotInitializedResponseBody

func ValidateStopInstanceClusterNotInitializedResponseBody(body *StopInstanceClusterNotInitializedResponseBody) (err error)

ValidateStopInstanceClusterNotInitializedResponseBody runs a no-op validation on stop-instance_cluster_not_initialized_response_body

func ValidateStopInstanceInvalidInputResponseBody

func ValidateStopInstanceInvalidInputResponseBody(body *StopInstanceInvalidInputResponseBody) (err error)

ValidateStopInstanceInvalidInputResponseBody runs a no-op validation on stop-instance_invalid_input_response_body

func ValidateStopInstanceNotFoundResponseBody

func ValidateStopInstanceNotFoundResponseBody(body *StopInstanceNotFoundResponseBody) (err error)

ValidateStopInstanceNotFoundResponseBody runs a no-op validation on stop-instance_not_found_response_body

func ValidateStopInstanceResponseBody

func ValidateStopInstanceResponseBody(body *StopInstanceResponseBody) (err error)

ValidateStopInstanceResponseBody runs a no-op validation on Stop-InstanceResponseBody

func ValidateStopInstanceServerErrorResponseBody

func ValidateStopInstanceServerErrorResponseBody(body *StopInstanceServerErrorResponseBody) (err error)

ValidateStopInstanceServerErrorResponseBody runs a no-op validation on stop-instance_server_error_response_body

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 ValidateSwarmOptsResponseBody

func ValidateSwarmOptsResponseBody(body *SwarmOptsResponseBody) (err error)

ValidateSwarmOptsResponseBody runs a no-op validation on SwarmOptsResponseBody

func ValidateSwitchoverDatabaseNodeClusterNotInitializedResponseBody

func ValidateSwitchoverDatabaseNodeClusterNotInitializedResponseBody(body *SwitchoverDatabaseNodeClusterNotInitializedResponseBody) (err error)

ValidateSwitchoverDatabaseNodeClusterNotInitializedResponseBody runs a no-op validation on switchover-database-node_cluster_not_initialized_response_body

func ValidateSwitchoverDatabaseNodeDatabaseNotModifiableResponseBody

func ValidateSwitchoverDatabaseNodeDatabaseNotModifiableResponseBody(body *SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody) (err error)

ValidateSwitchoverDatabaseNodeDatabaseNotModifiableResponseBody runs a no-op validation on switchover-database-node_database_not_modifiable_response_body

func ValidateSwitchoverDatabaseNodeInvalidInputResponseBody

func ValidateSwitchoverDatabaseNodeInvalidInputResponseBody(body *SwitchoverDatabaseNodeInvalidInputResponseBody) (err error)

ValidateSwitchoverDatabaseNodeInvalidInputResponseBody runs a no-op validation on switchover-database-node_invalid_input_response_body

func ValidateSwitchoverDatabaseNodeNotFoundResponseBody

func ValidateSwitchoverDatabaseNodeNotFoundResponseBody(body *SwitchoverDatabaseNodeNotFoundResponseBody) (err error)

ValidateSwitchoverDatabaseNodeNotFoundResponseBody runs a no-op validation on switchover-database-node_not_found_response_body

func ValidateSwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody

func ValidateSwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody(body *SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody) (err error)

ValidateSwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody runs a no-op validation on switchover-database-node_operation_already_in_progress_response_body

func ValidateSwitchoverDatabaseNodeResponseBody

func ValidateSwitchoverDatabaseNodeResponseBody(body *SwitchoverDatabaseNodeResponseBody) (err error)

ValidateSwitchoverDatabaseNodeResponseBody runs a no-op validation on Switchover-Database-NodeResponseBody

func ValidateSwitchoverDatabaseNodeServerErrorResponseBody

func ValidateSwitchoverDatabaseNodeServerErrorResponseBody(body *SwitchoverDatabaseNodeServerErrorResponseBody) (err error)

ValidateSwitchoverDatabaseNodeServerErrorResponseBody runs a no-op validation on switchover-database-node_server_error_response_body

func ValidateTaskLogEntryResponseBody

func ValidateTaskLogEntryResponseBody(body *TaskLogEntryResponseBody) (err error)

ValidateTaskLogEntryResponseBody runs a no-op validation on TaskLogEntryResponseBody

func ValidateTaskResponseBody

func ValidateTaskResponseBody(body *TaskResponseBody) (err error)

ValidateTaskResponseBody runs a no-op validation on TaskResponseBody

func ValidateUpdateDatabaseClusterNotInitializedResponseBody

func ValidateUpdateDatabaseClusterNotInitializedResponseBody(body *UpdateDatabaseClusterNotInitializedResponseBody) (err error)

ValidateUpdateDatabaseClusterNotInitializedResponseBody runs a no-op validation on update-database_cluster_not_initialized_response_body

func ValidateUpdateDatabaseDatabaseNotModifiableResponseBody

func ValidateUpdateDatabaseDatabaseNotModifiableResponseBody(body *UpdateDatabaseDatabaseNotModifiableResponseBody) (err error)

ValidateUpdateDatabaseDatabaseNotModifiableResponseBody runs a no-op validation on update-database_database_not_modifiable_response_body

func ValidateUpdateDatabaseInvalidInputResponseBody

func ValidateUpdateDatabaseInvalidInputResponseBody(body *UpdateDatabaseInvalidInputResponseBody) (err error)

ValidateUpdateDatabaseInvalidInputResponseBody runs a no-op validation on update-database_invalid_input_response_body

func ValidateUpdateDatabaseNotFoundResponseBody

func ValidateUpdateDatabaseNotFoundResponseBody(body *UpdateDatabaseNotFoundResponseBody) (err error)

ValidateUpdateDatabaseNotFoundResponseBody runs a no-op validation on update-database_not_found_response_body

func ValidateUpdateDatabaseOperationAlreadyInProgressResponseBody

func ValidateUpdateDatabaseOperationAlreadyInProgressResponseBody(body *UpdateDatabaseOperationAlreadyInProgressResponseBody) (err error)

ValidateUpdateDatabaseOperationAlreadyInProgressResponseBody runs a no-op validation on update-database_operation_already_in_progress_response_body

func ValidateUpdateDatabaseResponseBody

func ValidateUpdateDatabaseResponseBody(body *UpdateDatabaseResponseBody) (err error)

ValidateUpdateDatabaseResponseBody runs a no-op validation on Update-DatabaseResponseBody

func ValidateUpdateDatabaseServerErrorResponseBody

func ValidateUpdateDatabaseServerErrorResponseBody(body *UpdateDatabaseServerErrorResponseBody) (err error)

ValidateUpdateDatabaseServerErrorResponseBody runs a no-op validation on update-database_server_error_response_body

Types

type BackupConfigSpecRequestBody

type BackupConfigSpecRequestBody struct {
	// The repositories for this backup configuration.
	Repositories []*BackupRepositorySpecRequestBody `json:"repositories"`
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecRequestBody `json:"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 `json:"repositories"`
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecRequestBodyRequestBody `json:"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 `json:"repositories"`
	// The schedules for this backup configuration.
	Schedules []*BackupScheduleSpecResponseBody `json:"schedules,omitempty"`
}

BackupConfigSpecResponseBody is used to define fields on response body types.

type BackupDatabaseNodeClusterNotInitializedResponseBody

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

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

type BackupDatabaseNodeDatabaseNotModifiableResponseBody

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

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

type BackupDatabaseNodeInvalidInputResponseBody

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

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

type BackupDatabaseNodeNotFoundResponseBody

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

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

type BackupDatabaseNodeOperationAlreadyInProgressResponseBody

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

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

type BackupDatabaseNodeRequestBody

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

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

func NewBackupDatabaseNodeRequestBody

func NewBackupDatabaseNodeRequestBody(p *controlplane.BackupDatabaseNodePayload) *BackupDatabaseNodeRequestBody

NewBackupDatabaseNodeRequestBody builds the HTTP request body from the payload of the "backup-database-node" endpoint of the "control-plane" service.

type BackupDatabaseNodeResponseBody

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

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

type BackupDatabaseNodeServerErrorResponseBody

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

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

type BackupRepositorySpecRequestBody

type BackupRepositorySpecRequestBody struct {
	// The unique identifier of this repository.
	ID *string `json:"id,omitempty"`
	// The type of this repository.
	Type string `json:"type"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `json:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `json:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `json:"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 `json:"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 `json:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `json:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `json:"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 `json:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `json:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `json:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `json:"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 `json:"azure_key,omitempty"`
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int `json:"retention_full,omitempty"`
	// The type of measure used for retention_full.
	RetentionFullType *string `json:"retention_full_type,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `json:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `json:"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 `json:"id,omitempty"`
	// The type of this repository.
	Type string `json:"type"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `json:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `json:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `json:"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 `json:"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 `json:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `json:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `json:"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 `json:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `json:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `json:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `json:"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 `json:"azure_key,omitempty"`
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int `json:"retention_full,omitempty"`
	// The type of measure used for retention_full.
	RetentionFullType *string `json:"retention_full_type,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `json:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `json:"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 `json:"id,omitempty"`
	// The type of this repository.
	Type *string `json:"type"`
	// The S3 bucket name for this repository. Only applies when type = 's3'.
	S3Bucket *string `json:"s3_bucket,omitempty"`
	// The region of the S3 bucket for this repository. Only applies when type =
	// 's3'.
	S3Region *string `json:"s3_region,omitempty"`
	// The optional S3 endpoint for this repository. Only applies when type = 's3'.
	S3Endpoint *string `json:"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 `json:"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 `json:"s3_key_secret,omitempty"`
	// The GCS bucket name for this repository. Only applies when type = 'gcs'.
	GcsBucket *string `json:"gcs_bucket,omitempty"`
	// The optional GCS endpoint for this repository. Only applies when type =
	// 'gcs'.
	GcsEndpoint *string `json:"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 `json:"gcs_key,omitempty"`
	// The Azure account name for this repository. Only applies when type = 'azure'.
	AzureAccount *string `json:"azure_account,omitempty"`
	// The Azure container name for this repository. Only applies when type =
	// 'azure'.
	AzureContainer *string `json:"azure_container,omitempty"`
	// The optional Azure endpoint for this repository. Only applies when type =
	// 'azure'.
	AzureEndpoint *string `json:"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 `json:"azure_key,omitempty"`
	// The count of full backups to retain or the time to retain full backups.
	RetentionFull *int `json:"retention_full,omitempty"`
	// The type of measure used for retention_full.
	RetentionFullType *string `json:"retention_full_type,omitempty"`
	// The base path within the repository to store backups. Required for type =
	// 'posix' and 'cifs'.
	BasePath *string `json:"base_path,omitempty"`
	// Additional options to apply to this repository.
	CustomOptions map[string]string `json:"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 `json:"id"`
	// The type of backup to take on this schedule.
	Type string `json:"type"`
	// The cron expression for this schedule.
	CronExpression string `json:"cron_expression"`
}

BackupScheduleSpecRequestBody is used to define fields on request body types.

type BackupScheduleSpecRequestBodyRequestBody

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

BackupScheduleSpecRequestBodyRequestBody is used to define fields on request body types.

type BackupScheduleSpecResponseBody

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

BackupScheduleSpecResponseBody is used to define fields on response body types.

type CancelDatabaseTaskInvalidInputResponseBody

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

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

type CancelDatabaseTaskNotFoundResponseBody

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

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

type CancelDatabaseTaskResponseBody

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

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

type CancelDatabaseTaskServerErrorResponseBody

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

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

type Client

type Client struct {
	// InitCluster Doer is the HTTP client used to make requests to the
	// init-cluster endpoint.
	InitClusterDoer goahttp.Doer

	// JoinCluster Doer is the HTTP client used to make requests to the
	// join-cluster endpoint.
	JoinClusterDoer goahttp.Doer

	// GetJoinToken Doer is the HTTP client used to make requests to the
	// get-join-token endpoint.
	GetJoinTokenDoer goahttp.Doer

	// GetJoinOptions Doer is the HTTP client used to make requests to the
	// get-join-options endpoint.
	GetJoinOptionsDoer goahttp.Doer

	// GetCluster Doer is the HTTP client used to make requests to the get-cluster
	// endpoint.
	GetClusterDoer goahttp.Doer

	// ListHosts Doer is the HTTP client used to make requests to the list-hosts
	// endpoint.
	ListHostsDoer goahttp.Doer

	// GetHost Doer is the HTTP client used to make requests to the get-host
	// endpoint.
	GetHostDoer goahttp.Doer

	// RemoveHost Doer is the HTTP client used to make requests to the remove-host
	// endpoint.
	RemoveHostDoer goahttp.Doer

	// ListDatabases Doer is the HTTP client used to make requests to the
	// list-databases endpoint.
	ListDatabasesDoer goahttp.Doer

	// CreateDatabase Doer is the HTTP client used to make requests to the
	// create-database endpoint.
	CreateDatabaseDoer goahttp.Doer

	// GetDatabase Doer is the HTTP client used to make requests to the
	// get-database endpoint.
	GetDatabaseDoer goahttp.Doer

	// UpdateDatabase Doer is the HTTP client used to make requests to the
	// update-database endpoint.
	UpdateDatabaseDoer goahttp.Doer

	// DeleteDatabase Doer is the HTTP client used to make requests to the
	// delete-database endpoint.
	DeleteDatabaseDoer goahttp.Doer

	// BackupDatabaseNode Doer is the HTTP client used to make requests to the
	// backup-database-node endpoint.
	BackupDatabaseNodeDoer goahttp.Doer

	// SwitchoverDatabaseNode Doer is the HTTP client used to make requests to the
	// switchover-database-node endpoint.
	SwitchoverDatabaseNodeDoer goahttp.Doer

	// FailoverDatabaseNode Doer is the HTTP client used to make requests to the
	// failover-database-node endpoint.
	FailoverDatabaseNodeDoer goahttp.Doer

	// ListDatabaseTasks Doer is the HTTP client used to make requests to the
	// list-database-tasks endpoint.
	ListDatabaseTasksDoer goahttp.Doer

	// GetDatabaseTask Doer is the HTTP client used to make requests to the
	// get-database-task endpoint.
	GetDatabaseTaskDoer goahttp.Doer

	// GetDatabaseTaskLog Doer is the HTTP client used to make requests to the
	// get-database-task-log endpoint.
	GetDatabaseTaskLogDoer goahttp.Doer

	// ListHostTasks Doer is the HTTP client used to make requests to the
	// list-host-tasks endpoint.
	ListHostTasksDoer goahttp.Doer

	// GetHostTask Doer is the HTTP client used to make requests to the
	// get-host-task endpoint.
	GetHostTaskDoer goahttp.Doer

	// GetHostTaskLog Doer is the HTTP client used to make requests to the
	// get-host-task-log endpoint.
	GetHostTaskLogDoer goahttp.Doer

	// ListTasks Doer is the HTTP client used to make requests to the list-tasks
	// endpoint.
	ListTasksDoer goahttp.Doer

	// RestoreDatabase Doer is the HTTP client used to make requests to the
	// restore-database endpoint.
	RestoreDatabaseDoer goahttp.Doer

	// GetVersion Doer is the HTTP client used to make requests to the get-version
	// endpoint.
	GetVersionDoer goahttp.Doer

	// RestartInstance Doer is the HTTP client used to make requests to the
	// restart-instance endpoint.
	RestartInstanceDoer goahttp.Doer

	// StopInstance Doer is the HTTP client used to make requests to the
	// stop-instance endpoint.
	StopInstanceDoer goahttp.Doer

	// StartInstance Doer is the HTTP client used to make requests to the
	// start-instance endpoint.
	StartInstanceDoer goahttp.Doer

	// CancelDatabaseTask Doer is the HTTP client used to make requests to the
	// cancel-database-task endpoint.
	CancelDatabaseTaskDoer goahttp.Doer

	// RestoreResponseBody controls whether the response bodies are reset after
	// decoding so they can be read again.
	RestoreResponseBody bool
	// contains filtered or unexported fields
}

Client lists the control-plane service endpoint HTTP clients.

func NewClient

func NewClient(
	scheme string,
	host string,
	doer goahttp.Doer,
	enc func(*http.Request) goahttp.Encoder,
	dec func(*http.Response) goahttp.Decoder,
	restoreBody bool,
) *Client

NewClient instantiates HTTP clients for all the control-plane service servers.

func (*Client) BackupDatabaseNode

func (c *Client) BackupDatabaseNode() goa.Endpoint

BackupDatabaseNode returns an endpoint that makes HTTP requests to the control-plane service backup-database-node server.

func (*Client) BuildBackupDatabaseNodeRequest

func (c *Client) BuildBackupDatabaseNodeRequest(ctx context.Context, v any) (*http.Request, error)

BuildBackupDatabaseNodeRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "backup-database-node" endpoint

func (*Client) BuildCancelDatabaseTaskRequest

func (c *Client) BuildCancelDatabaseTaskRequest(ctx context.Context, v any) (*http.Request, error)

BuildCancelDatabaseTaskRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "cancel-database-task" endpoint

func (*Client) BuildCreateDatabaseRequest

func (c *Client) BuildCreateDatabaseRequest(ctx context.Context, v any) (*http.Request, error)

BuildCreateDatabaseRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "create-database" endpoint

func (*Client) BuildDeleteDatabaseRequest

func (c *Client) BuildDeleteDatabaseRequest(ctx context.Context, v any) (*http.Request, error)

BuildDeleteDatabaseRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "delete-database" endpoint

func (*Client) BuildFailoverDatabaseNodeRequest

func (c *Client) BuildFailoverDatabaseNodeRequest(ctx context.Context, v any) (*http.Request, error)

BuildFailoverDatabaseNodeRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "failover-database-node" endpoint

func (*Client) BuildGetClusterRequest

func (c *Client) BuildGetClusterRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetClusterRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-cluster" endpoint

func (*Client) BuildGetDatabaseRequest

func (c *Client) BuildGetDatabaseRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetDatabaseRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-database" endpoint

func (*Client) BuildGetDatabaseTaskLogRequest

func (c *Client) BuildGetDatabaseTaskLogRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetDatabaseTaskLogRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-database-task-log" endpoint

func (*Client) BuildGetDatabaseTaskRequest

func (c *Client) BuildGetDatabaseTaskRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetDatabaseTaskRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-database-task" endpoint

func (*Client) BuildGetHostRequest

func (c *Client) BuildGetHostRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetHostRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-host" endpoint

func (*Client) BuildGetHostTaskLogRequest added in v0.7.0

func (c *Client) BuildGetHostTaskLogRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetHostTaskLogRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-host-task-log" endpoint

func (*Client) BuildGetHostTaskRequest added in v0.7.0

func (c *Client) BuildGetHostTaskRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetHostTaskRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-host-task" endpoint

func (*Client) BuildGetJoinOptionsRequest

func (c *Client) BuildGetJoinOptionsRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetJoinOptionsRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-join-options" endpoint

func (*Client) BuildGetJoinTokenRequest

func (c *Client) BuildGetJoinTokenRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetJoinTokenRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-join-token" endpoint

func (*Client) BuildGetVersionRequest

func (c *Client) BuildGetVersionRequest(ctx context.Context, v any) (*http.Request, error)

BuildGetVersionRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "get-version" endpoint

func (*Client) BuildInitClusterRequest

func (c *Client) BuildInitClusterRequest(ctx context.Context, v any) (*http.Request, error)

BuildInitClusterRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "init-cluster" endpoint

func (*Client) BuildJoinClusterRequest

func (c *Client) BuildJoinClusterRequest(ctx context.Context, v any) (*http.Request, error)

BuildJoinClusterRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "join-cluster" endpoint

func (*Client) BuildListDatabaseTasksRequest

func (c *Client) BuildListDatabaseTasksRequest(ctx context.Context, v any) (*http.Request, error)

BuildListDatabaseTasksRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "list-database-tasks" endpoint

func (*Client) BuildListDatabasesRequest

func (c *Client) BuildListDatabasesRequest(ctx context.Context, v any) (*http.Request, error)

BuildListDatabasesRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "list-databases" endpoint

func (*Client) BuildListHostTasksRequest added in v0.7.0

func (c *Client) BuildListHostTasksRequest(ctx context.Context, v any) (*http.Request, error)

BuildListHostTasksRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "list-host-tasks" endpoint

func (*Client) BuildListHostsRequest

func (c *Client) BuildListHostsRequest(ctx context.Context, v any) (*http.Request, error)

BuildListHostsRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "list-hosts" endpoint

func (*Client) BuildListTasksRequest added in v0.7.0

func (c *Client) BuildListTasksRequest(ctx context.Context, v any) (*http.Request, error)

BuildListTasksRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "list-tasks" endpoint

func (*Client) BuildRemoveHostRequest

func (c *Client) BuildRemoveHostRequest(ctx context.Context, v any) (*http.Request, error)

BuildRemoveHostRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "remove-host" endpoint

func (*Client) BuildRestartInstanceRequest

func (c *Client) BuildRestartInstanceRequest(ctx context.Context, v any) (*http.Request, error)

BuildRestartInstanceRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "restart-instance" endpoint

func (*Client) BuildRestoreDatabaseRequest

func (c *Client) BuildRestoreDatabaseRequest(ctx context.Context, v any) (*http.Request, error)

BuildRestoreDatabaseRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "restore-database" endpoint

func (*Client) BuildStartInstanceRequest

func (c *Client) BuildStartInstanceRequest(ctx context.Context, v any) (*http.Request, error)

BuildStartInstanceRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "start-instance" endpoint

func (*Client) BuildStopInstanceRequest

func (c *Client) BuildStopInstanceRequest(ctx context.Context, v any) (*http.Request, error)

BuildStopInstanceRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "stop-instance" endpoint

func (*Client) BuildSwitchoverDatabaseNodeRequest

func (c *Client) BuildSwitchoverDatabaseNodeRequest(ctx context.Context, v any) (*http.Request, error)

BuildSwitchoverDatabaseNodeRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "switchover-database-node" endpoint

func (*Client) BuildUpdateDatabaseRequest

func (c *Client) BuildUpdateDatabaseRequest(ctx context.Context, v any) (*http.Request, error)

BuildUpdateDatabaseRequest instantiates a HTTP request object with method and path set to call the "control-plane" service "update-database" endpoint

func (*Client) CancelDatabaseTask

func (c *Client) CancelDatabaseTask() goa.Endpoint

CancelDatabaseTask returns an endpoint that makes HTTP requests to the control-plane service cancel-database-task server.

func (*Client) CreateDatabase

func (c *Client) CreateDatabase() goa.Endpoint

CreateDatabase returns an endpoint that makes HTTP requests to the control-plane service create-database server.

func (*Client) DeleteDatabase

func (c *Client) DeleteDatabase() goa.Endpoint

DeleteDatabase returns an endpoint that makes HTTP requests to the control-plane service delete-database server.

func (*Client) FailoverDatabaseNode

func (c *Client) FailoverDatabaseNode() goa.Endpoint

FailoverDatabaseNode returns an endpoint that makes HTTP requests to the control-plane service failover-database-node server.

func (*Client) GetCluster

func (c *Client) GetCluster() goa.Endpoint

GetCluster returns an endpoint that makes HTTP requests to the control-plane service get-cluster server.

func (*Client) GetDatabase

func (c *Client) GetDatabase() goa.Endpoint

GetDatabase returns an endpoint that makes HTTP requests to the control-plane service get-database server.

func (*Client) GetDatabaseTask

func (c *Client) GetDatabaseTask() goa.Endpoint

GetDatabaseTask returns an endpoint that makes HTTP requests to the control-plane service get-database-task server.

func (*Client) GetDatabaseTaskLog

func (c *Client) GetDatabaseTaskLog() goa.Endpoint

GetDatabaseTaskLog returns an endpoint that makes HTTP requests to the control-plane service get-database-task-log server.

func (*Client) GetHost

func (c *Client) GetHost() goa.Endpoint

GetHost returns an endpoint that makes HTTP requests to the control-plane service get-host server.

func (*Client) GetHostTask added in v0.7.0

func (c *Client) GetHostTask() goa.Endpoint

GetHostTask returns an endpoint that makes HTTP requests to the control-plane service get-host-task server.

func (*Client) GetHostTaskLog added in v0.7.0

func (c *Client) GetHostTaskLog() goa.Endpoint

GetHostTaskLog returns an endpoint that makes HTTP requests to the control-plane service get-host-task-log server.

func (*Client) GetJoinOptions

func (c *Client) GetJoinOptions() goa.Endpoint

GetJoinOptions returns an endpoint that makes HTTP requests to the control-plane service get-join-options server.

func (*Client) GetJoinToken

func (c *Client) GetJoinToken() goa.Endpoint

GetJoinToken returns an endpoint that makes HTTP requests to the control-plane service get-join-token server.

func (*Client) GetVersion

func (c *Client) GetVersion() goa.Endpoint

GetVersion returns an endpoint that makes HTTP requests to the control-plane service get-version server.

func (*Client) InitCluster

func (c *Client) InitCluster() goa.Endpoint

InitCluster returns an endpoint that makes HTTP requests to the control-plane service init-cluster server.

func (*Client) JoinCluster

func (c *Client) JoinCluster() goa.Endpoint

JoinCluster returns an endpoint that makes HTTP requests to the control-plane service join-cluster server.

func (*Client) ListDatabaseTasks

func (c *Client) ListDatabaseTasks() goa.Endpoint

ListDatabaseTasks returns an endpoint that makes HTTP requests to the control-plane service list-database-tasks server.

func (*Client) ListDatabases

func (c *Client) ListDatabases() goa.Endpoint

ListDatabases returns an endpoint that makes HTTP requests to the control-plane service list-databases server.

func (*Client) ListHostTasks added in v0.7.0

func (c *Client) ListHostTasks() goa.Endpoint

ListHostTasks returns an endpoint that makes HTTP requests to the control-plane service list-host-tasks server.

func (*Client) ListHosts

func (c *Client) ListHosts() goa.Endpoint

ListHosts returns an endpoint that makes HTTP requests to the control-plane service list-hosts server.

func (*Client) ListTasks added in v0.7.0

func (c *Client) ListTasks() goa.Endpoint

ListTasks returns an endpoint that makes HTTP requests to the control-plane service list-tasks server.

func (*Client) RemoveHost

func (c *Client) RemoveHost() goa.Endpoint

RemoveHost returns an endpoint that makes HTTP requests to the control-plane service remove-host server.

func (*Client) RestartInstance

func (c *Client) RestartInstance() goa.Endpoint

RestartInstance returns an endpoint that makes HTTP requests to the control-plane service restart-instance server.

func (*Client) RestoreDatabase

func (c *Client) RestoreDatabase() goa.Endpoint

RestoreDatabase returns an endpoint that makes HTTP requests to the control-plane service restore-database server.

func (*Client) StartInstance

func (c *Client) StartInstance() goa.Endpoint

StartInstance returns an endpoint that makes HTTP requests to the control-plane service start-instance server.

func (*Client) StopInstance

func (c *Client) StopInstance() goa.Endpoint

StopInstance returns an endpoint that makes HTTP requests to the control-plane service stop-instance server.

func (*Client) SwitchoverDatabaseNode

func (c *Client) SwitchoverDatabaseNode() goa.Endpoint

SwitchoverDatabaseNode returns an endpoint that makes HTTP requests to the control-plane service switchover-database-node server.

func (*Client) UpdateDatabase

func (c *Client) UpdateDatabase() goa.Endpoint

UpdateDatabase returns an endpoint that makes HTTP requests to the control-plane service update-database server.

type ClusterCredentialsResponseBody

type ClusterCredentialsResponseBody struct {
	// The Etcd username for the new host.
	Username *string `json:"username"`
	// The Etcd password for the new host.
	Password *string `json:"password"`
	// The base64-encoded CA certificate for the cluster.
	CaCert *string `json:"ca_cert"`
	// The base64-encoded etcd client certificate for the new cluster member.
	ClientCert *string `json:"client_cert"`
	// The base64-encoded etcd client key for the new cluster member.
	ClientKey *string `json:"client_key"`
	// The base64-encoded etcd server certificate for the new cluster member.
	ServerCert *string `json:"server_cert"`
	// The base64-encoded etcd server key for the new cluster member.
	ServerKey *string `json:"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 `json:"state"`
}

ClusterStatusResponseBody is used to define fields on response body types.

type ComponentStatusResponseBody

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

ComponentStatusResponseBody is used to define fields on response body types.

type CreateDatabaseClusterNotInitializedResponseBody

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

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

type CreateDatabaseDatabaseAlreadyExistsResponseBody

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

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

type CreateDatabaseInvalidInputResponseBody

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

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

type CreateDatabaseOperationAlreadyInProgressResponseBody

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

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

type CreateDatabaseRequestBody

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

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

func NewCreateDatabaseRequestBody

func NewCreateDatabaseRequestBody(p *controlplane.CreateDatabaseRequest) *CreateDatabaseRequestBody

NewCreateDatabaseRequestBody builds the HTTP request body from the payload of the "create-database" endpoint of the "control-plane" service.

type CreateDatabaseResponseBody

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

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

type CreateDatabaseServerErrorResponseBody

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

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

type DatabaseConnectionRequestBody added in v0.7.0

type DatabaseConnectionRequestBody struct {
	// Optional ordered list of database node names. When set, the service's
	// database connection includes only the listed nodes in the specified order.
	TargetNodes []string `json:"target_nodes,omitempty"`
	// Optional libpq target_session_attrs value. When set, overrides the default
	// derived from the service config. Valid values: primary, prefer-standby,
	// standby, read-write, any.
	TargetSessionAttrs *string `json:"target_session_attrs,omitempty"`
}

DatabaseConnectionRequestBody is used to define fields on request body types.

type DatabaseConnectionRequestBodyRequestBody added in v0.7.0

type DatabaseConnectionRequestBodyRequestBody struct {
	// Optional ordered list of database node names. When set, the service's
	// database connection includes only the listed nodes in the specified order.
	TargetNodes []string `json:"target_nodes,omitempty"`
	// Optional libpq target_session_attrs value. When set, overrides the default
	// derived from the service config. Valid values: primary, prefer-standby,
	// standby, read-write, any.
	TargetSessionAttrs *string `json:"target_session_attrs,omitempty"`
}

DatabaseConnectionRequestBodyRequestBody is used to define fields on request body types.

type DatabaseConnectionResponseBody added in v0.7.0

type DatabaseConnectionResponseBody struct {
	// Optional ordered list of database node names. When set, the service's
	// database connection includes only the listed nodes in the specified order.
	TargetNodes []string `json:"target_nodes,omitempty"`
	// Optional libpq target_session_attrs value. When set, overrides the default
	// derived from the service config. Valid values: primary, prefer-standby,
	// standby, read-write, any.
	TargetSessionAttrs *string `json:"target_session_attrs,omitempty"`
}

DatabaseConnectionResponseBody is used to define fields on response body types.

type DatabaseNodeSpecRequestBody

type DatabaseNodeSpecRequestBody struct {
	// The name of the database node.
	Name string `json:"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 `json:"host_ids"`
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string `json:"postgres_version,omitempty"`
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int `json:"port,omitempty"`
	// The port used by Patroni for this node. Overrides the Patroni port set in
	// the DatabaseSpec. NOTE: This field is not currently supported for Docker
	// Swarm.
	PatroniPort *int `json:"patroni_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 `json:"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 `json:"memory,omitempty"`
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any `json:"postgresql_conf,omitempty"`
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecRequestBody `json:"backup_config,omitempty"`
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecRequestBody `json:"restore_config,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBody `json:"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 `json:"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 `json:"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 `json:"host_ids"`
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string `json:"postgres_version,omitempty"`
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int `json:"port,omitempty"`
	// The port used by Patroni for this node. Overrides the Patroni port set in
	// the DatabaseSpec. NOTE: This field is not currently supported for Docker
	// Swarm.
	PatroniPort *int `json:"patroni_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 `json:"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 `json:"memory,omitempty"`
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any `json:"postgresql_conf,omitempty"`
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecRequestBodyRequestBody `json:"backup_config,omitempty"`
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecRequestBodyRequestBody `json:"restore_config,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBodyRequestBody `json:"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 `json:"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 `json:"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 `json:"host_ids"`
	// The Postgres version for this node in 'major.minor' format. Overrides the
	// Postgres version set in the DatabaseSpec.
	PostgresVersion *string `json:"postgres_version,omitempty"`
	// The port used by the Postgres database for this node. Overrides the Postgres
	// port set in the DatabaseSpec.
	Port *int `json:"port,omitempty"`
	// The port used by Patroni for this node. Overrides the Patroni port set in
	// the DatabaseSpec. NOTE: This field is not currently supported for Docker
	// Swarm.
	PatroniPort *int `json:"patroni_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 `json:"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 `json:"memory,omitempty"`
	// Additional postgresql.conf settings for this particular node. Will be merged
	// with the settings provided by control-plane.
	PostgresqlConf map[string]any `json:"postgresql_conf,omitempty"`
	// The backup configuration for this node. Overrides the backup configuration
	// set in the DatabaseSpec.
	BackupConfig *BackupConfigSpecResponseBody `json:"backup_config,omitempty"`
	// The restore configuration for this node. Overrides the restore configuration
	// set in the DatabaseSpec.
	RestoreConfig *RestoreConfigSpecResponseBody `json:"restore_config,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsResponseBody `json:"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 `json:"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 `json:"id"`
	// Unique identifier for the database's owner.
	TenantID *string `json:"tenant_id,omitempty"`
	// The time that the database was created.
	CreatedAt *string `json:"created_at"`
	// The time that the database was last updated.
	UpdatedAt *string `json:"updated_at"`
	// Current state of the database.
	State *string `json:"state"`
	// All of the instances in the database.
	Instances []*InstanceResponseBody `json:"instances,omitempty"`
	// Service instances running alongside this database.
	ServiceInstances []*ServiceInstanceResponseBody `json:"service_instances,omitempty"`
	// The user-provided specification for the database.
	Spec *DatabaseSpecResponseBody `json:"spec,omitempty"`
}

DatabaseResponseBody is used to define fields on response body types.

type DatabaseSpecRequestBody

type DatabaseSpecRequestBody struct {
	// The name of the Postgres database.
	DatabaseName string `json:"database_name"`
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string `json:"postgres_version,omitempty"`
	// The major version of the Spock extension.
	SpockVersion *string `json:"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 `json:"port,omitempty"`
	// The port used by Patroni for this database. NOTE: This field is not
	// currently supported for Docker Swarm.
	PatroniPort *int `json:"patroni_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 `json:"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 `json:"memory,omitempty"`
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecRequestBody `json:"nodes"`
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecRequestBody `json:"database_users,omitempty"`
	// Service instances to run alongside the database (e.g., MCP servers).
	Services []*ServiceSpecRequestBody `json:"services,omitempty"`
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecRequestBody `json:"backup_config,omitempty"`
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecRequestBody `json:"restore_config,omitempty"`
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any `json:"postgresql_conf,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBody `json:"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 `json:"database_name"`
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string `json:"postgres_version,omitempty"`
	// The major version of the Spock extension.
	SpockVersion *string `json:"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 `json:"port,omitempty"`
	// The port used by Patroni for this database. NOTE: This field is not
	// currently supported for Docker Swarm.
	PatroniPort *int `json:"patroni_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 `json:"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 `json:"memory,omitempty"`
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecRequestBodyRequestBody `json:"nodes"`
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecRequestBodyRequestBody `json:"database_users,omitempty"`
	// Service instances to run alongside the database (e.g., MCP servers).
	Services []*ServiceSpecRequestBodyRequestBody `json:"services,omitempty"`
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecRequestBodyRequestBody `json:"backup_config,omitempty"`
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecRequestBodyRequestBody `json:"restore_config,omitempty"`
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any `json:"postgresql_conf,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsRequestBodyRequestBody `json:"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 `json:"database_name"`
	// The Postgres version in 'major.minor' format.
	PostgresVersion *string `json:"postgres_version,omitempty"`
	// The major version of the Spock extension.
	SpockVersion *string `json:"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 `json:"port,omitempty"`
	// The port used by Patroni for this database. NOTE: This field is not
	// currently supported for Docker Swarm.
	PatroniPort *int `json:"patroni_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 `json:"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 `json:"memory,omitempty"`
	// The Spock nodes for this database.
	Nodes []*DatabaseNodeSpecResponseBody `json:"nodes"`
	// The users to create for this database.
	DatabaseUsers []*DatabaseUserSpecResponseBody `json:"database_users,omitempty"`
	// Service instances to run alongside the database (e.g., MCP servers).
	Services []*ServiceSpecResponseBody `json:"services,omitempty"`
	// The backup configuration for this database.
	BackupConfig *BackupConfigSpecResponseBody `json:"backup_config,omitempty"`
	// The restore configuration for this database.
	RestoreConfig *RestoreConfigSpecResponseBody `json:"restore_config,omitempty"`
	// Additional postgresql.conf settings. Will be merged with the settings
	// provided by control-plane.
	PostgresqlConf map[string]any `json:"postgresql_conf,omitempty"`
	// Orchestrator-specific configuration options.
	OrchestratorOpts *OrchestratorOptsResponseBody `json:"orchestrator_opts,omitempty"`
}

DatabaseSpecResponseBody is used to define fields on response body types.

type DatabaseSummaryResponseBody added in v0.7.0

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

DatabaseSummaryResponseBody is used to define fields on response body types.

type DatabaseUserSpecRequestBody

type DatabaseUserSpecRequestBody struct {
	// The username for this database user.
	Username string `json:"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 `json:"password,omitempty"`
	// If true, this user will be granted database ownership.
	DbOwner *bool `json:"db_owner,omitempty"`
	// The attributes to assign to this database user.
	Attributes []string `json:"attributes,omitempty"`
	// The roles to assign to this database user.
	Roles []string `json:"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 `json:"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 `json:"password,omitempty"`
	// If true, this user will be granted database ownership.
	DbOwner *bool `json:"db_owner,omitempty"`
	// The attributes to assign to this database user.
	Attributes []string `json:"attributes,omitempty"`
	// The roles to assign to this database user.
	Roles []string `json:"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 `json:"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 `json:"password,omitempty"`
	// If true, this user will be granted database ownership.
	DbOwner *bool `json:"db_owner,omitempty"`
	// The attributes to assign to this database user.
	Attributes []string `json:"attributes,omitempty"`
	// The roles to assign to this database user.
	Roles []string `json:"roles,omitempty"`
}

DatabaseUserSpecResponseBody is used to define fields on response body types.

type DeleteDatabaseClusterNotInitializedResponseBody

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

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

type DeleteDatabaseDatabaseNotModifiableResponseBody

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

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

type DeleteDatabaseInvalidInputResponseBody

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

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

type DeleteDatabaseNotFoundResponseBody

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

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

type DeleteDatabaseOperationAlreadyInProgressResponseBody

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

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

type DeleteDatabaseResponseBody

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

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

type DeleteDatabaseServerErrorResponseBody

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

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

type EtcdClusterMemberResponseBody

type EtcdClusterMemberResponseBody struct {
	// The name of the Etcd cluster member.
	Name *string `json:"name"`
	// The Etcd peer endpoint for this cluster member.
	PeerUrls []string `json:"peer_urls"`
	// The Etcd client endpoint for this cluster member.
	ClientUrls []string `json:"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 `json:"id"`
	// Optional network-scoped aliases for the container.
	Aliases []string `json:"aliases,omitempty"`
	// Optional driver options for the network connection.
	DriverOpts map[string]string `json:"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 `json:"id"`
	// Optional network-scoped aliases for the container.
	Aliases []string `json:"aliases,omitempty"`
	// Optional driver options for the network connection.
	DriverOpts map[string]string `json:"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 `json:"id"`
	// Optional network-scoped aliases for the container.
	Aliases []string `json:"aliases,omitempty"`
	// Optional driver options for the network connection.
	DriverOpts map[string]string `json:"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 `json:"host_path"`
	// The path inside the container where the volume will be mounted.
	DestinationPath string `json:"destination_path"`
}

ExtraVolumesSpecRequestBody is used to define fields on request body types.

type ExtraVolumesSpecRequestBodyRequestBody

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

ExtraVolumesSpecRequestBodyRequestBody is used to define fields on request body types.

type ExtraVolumesSpecResponseBody

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

ExtraVolumesSpecResponseBody is used to define fields on response body types.

type FailoverDatabaseNodeClusterNotInitializedResponseBody

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

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

type FailoverDatabaseNodeDatabaseNotModifiableResponseBody

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

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

type FailoverDatabaseNodeInvalidInputResponseBody

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

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

type FailoverDatabaseNodeNotFoundResponseBody

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

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

type FailoverDatabaseNodeOperationAlreadyInProgressResponseBody

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

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

type FailoverDatabaseNodeRequestBody

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

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

func NewFailoverDatabaseNodeRequestBody

func NewFailoverDatabaseNodeRequestBody(p *controlplane.FailoverDatabaseNodeRequest) *FailoverDatabaseNodeRequestBody

NewFailoverDatabaseNodeRequestBody builds the HTTP request body from the payload of the "failover-database-node" endpoint of the "control-plane" service.

type FailoverDatabaseNodeResponseBody

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

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

type FailoverDatabaseNodeServerErrorResponseBody

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

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

type GetClusterClusterNotInitializedResponseBody

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

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

type GetClusterResponseBody

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

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

type GetClusterServerErrorResponseBody

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

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

type GetDatabaseClusterNotInitializedResponseBody

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

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

type GetDatabaseInvalidInputResponseBody

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

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

type GetDatabaseNotFoundResponseBody

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

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

type GetDatabaseResponseBody

type GetDatabaseResponseBody struct {
	// Unique identifier for the database.
	ID *string `json:"id"`
	// Unique identifier for the database's owner.
	TenantID *string `json:"tenant_id,omitempty"`
	// The time that the database was created.
	CreatedAt *string `json:"created_at"`
	// The time that the database was last updated.
	UpdatedAt *string `json:"updated_at"`
	// Current state of the database.
	State *string `json:"state"`
	// All of the instances in the database.
	Instances []*InstanceResponseBody `json:"instances,omitempty"`
	// Service instances running alongside this database.
	ServiceInstances []*ServiceInstanceResponseBody `json:"service_instances,omitempty"`
	// The user-provided specification for the database.
	Spec *DatabaseSpecResponseBody `json:"spec,omitempty"`
}

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

type GetDatabaseServerErrorResponseBody

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

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

type GetDatabaseTaskClusterNotInitializedResponseBody

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

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

type GetDatabaseTaskInvalidInputResponseBody

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

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

type GetDatabaseTaskLogClusterNotInitializedResponseBody

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

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

type GetDatabaseTaskLogInvalidInputResponseBody

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

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

type GetDatabaseTaskLogNotFoundResponseBody

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

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

type GetDatabaseTaskLogResponseBody

type GetDatabaseTaskLogResponseBody struct {
	// The scope of the task (database or host).
	Scope *string `json:"scope"`
	// The entity ID (database_id or host_id) that this task log belongs to.
	EntityID *string `json:"entity_id"`
	// The database ID of the task log. Deprecated: use entity_id instead.
	DatabaseID *string `json:"database_id,omitempty"`
	// The unique ID of the task log.
	TaskID *string `json:"task_id"`
	// The status of the task.
	TaskStatus *string `json:"task_status"`
	// The ID of the last entry in the task log.
	LastEntryID *string `json:"last_entry_id,omitempty"`
	// Entries in the task log.
	Entries []*TaskLogEntryResponseBody `json:"entries"`
}

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

type GetDatabaseTaskLogServerErrorResponseBody

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

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

type GetDatabaseTaskNotFoundResponseBody

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

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

type GetDatabaseTaskResponseBody

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

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

type GetDatabaseTaskServerErrorResponseBody

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

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

type GetHostClusterNotInitializedResponseBody

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

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

type GetHostInvalidInputResponseBody

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

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

type GetHostNotFoundResponseBody

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

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

type GetHostResponseBody

type GetHostResponseBody struct {
	// Unique identifier for the host.
	ID *string `json:"id"`
	// The orchestrator used by this host.
	Orchestrator *string `json:"orchestrator"`
	// The data directory for the host.
	DataDir *string `json:"data_dir"`
	// The cohort that this host belongs to.
	Cohort *HostCohortResponseBody `json:"cohort,omitempty"`
	// The addresses that this host advertises to other hosts.
	PeerAddresses []string `json:"peer_addresses"`
	// The addresses that this host advertises to client applications.
	ClientAddresses []string `json:"client_addresses"`
	// The number of CPUs on this host.
	Cpus *int `json:"cpus,omitempty"`
	// The amount of memory available on this host.
	Memory *string `json:"memory,omitempty"`
	// Current status of the host.
	Status *HostStatusResponseBody `json:"status"`
	// The default PgEdge version for this host.
	DefaultPgedgeVersion *PgEdgeVersionResponseBody `json:"default_pgedge_version,omitempty"`
	// The PgEdge versions supported by this host.
	SupportedPgedgeVersions []*PgEdgeVersionResponseBody `json:"supported_pgedge_versions,omitempty"`
	// The etcd mode for this host.
	EtcdMode *string `json:"etcd_mode,omitempty"`
}

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

type GetHostServerErrorResponseBody

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

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

type GetHostTaskClusterNotInitializedResponseBody added in v0.7.0

type GetHostTaskClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskInvalidInputResponseBody added in v0.7.0

type GetHostTaskInvalidInputResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskLogClusterNotInitializedResponseBody added in v0.7.0

type GetHostTaskLogClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskLogInvalidInputResponseBody added in v0.7.0

type GetHostTaskLogInvalidInputResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskLogNotFoundResponseBody added in v0.7.0

type GetHostTaskLogNotFoundResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskLogResponseBody added in v0.7.0

type GetHostTaskLogResponseBody struct {
	// The scope of the task (database or host).
	Scope *string `json:"scope"`
	// The entity ID (database_id or host_id) that this task log belongs to.
	EntityID *string `json:"entity_id"`
	// The database ID of the task log. Deprecated: use entity_id instead.
	DatabaseID *string `json:"database_id,omitempty"`
	// The unique ID of the task log.
	TaskID *string `json:"task_id"`
	// The status of the task.
	TaskStatus *string `json:"task_status"`
	// The ID of the last entry in the task log.
	LastEntryID *string `json:"last_entry_id,omitempty"`
	// Entries in the task log.
	Entries []*TaskLogEntryResponseBody `json:"entries"`
}

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

type GetHostTaskLogServerErrorResponseBody added in v0.7.0

type GetHostTaskLogServerErrorResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskNotFoundResponseBody added in v0.7.0

type GetHostTaskNotFoundResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetHostTaskResponseBody added in v0.7.0

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

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

type GetHostTaskServerErrorResponseBody added in v0.7.0

type GetHostTaskServerErrorResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type GetJoinOptionsClusterNotInitializedResponseBody

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

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

type GetJoinOptionsInvalidInputResponseBody added in v0.6.0

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

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

type GetJoinOptionsInvalidJoinTokenResponseBody

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

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

type GetJoinOptionsRequestBody

type GetJoinOptionsRequestBody struct {
	// Token to join the cluster.
	Token string `json:"token"`
	// The unique identifier for the host that's joining the cluster.
	HostID string `json:"host_id"`
	// The peer addresses of the host that's joining the cluster.
	Addresses []string `json:"addresses"`
	// True if the joining member is configured to run an embedded an etcd server.
	EmbeddedEtcdEnabled bool `json:"embedded_etcd_enabled"`
}

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

func NewGetJoinOptionsRequestBody

func NewGetJoinOptionsRequestBody(p *controlplane.ClusterJoinRequest) *GetJoinOptionsRequestBody

NewGetJoinOptionsRequestBody builds the HTTP request body from the payload of the "get-join-options" endpoint of the "control-plane" service.

type GetJoinOptionsResponseBody

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

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

type GetJoinOptionsServerErrorResponseBody

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

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

type GetJoinTokenClusterNotInitializedResponseBody

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

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

type GetJoinTokenResponseBody

type GetJoinTokenResponseBody struct {
	// Token to join an existing cluster.
	Token *string `json:"token"`
	// Existing server to join
	ServerUrls []string `json:"server_urls"`
}

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

type GetJoinTokenServerErrorResponseBody

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

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

type GetVersionResponseBody

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

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

type GetVersionServerErrorResponseBody

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

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

type HealthCheckResultResponseBody added in v0.7.0

type HealthCheckResultResponseBody struct {
	// The health status.
	Status *string `json:"status"`
	// Optional message about the health status.
	Message *string `json:"message,omitempty"`
	// The time this health check was performed.
	CheckedAt *string `json:"checked_at"`
}

HealthCheckResultResponseBody is used to define fields on response body types.

type HostCohortResponseBody

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

HostCohortResponseBody is used to define fields on response body types.

type HostResponseBody

type HostResponseBody struct {
	// Unique identifier for the host.
	ID *string `json:"id"`
	// The orchestrator used by this host.
	Orchestrator *string `json:"orchestrator"`
	// The data directory for the host.
	DataDir *string `json:"data_dir"`
	// The cohort that this host belongs to.
	Cohort *HostCohortResponseBody `json:"cohort,omitempty"`
	// The addresses that this host advertises to other hosts.
	PeerAddresses []string `json:"peer_addresses"`
	// The addresses that this host advertises to client applications.
	ClientAddresses []string `json:"client_addresses"`
	// The number of CPUs on this host.
	Cpus *int `json:"cpus,omitempty"`
	// The amount of memory available on this host.
	Memory *string `json:"memory,omitempty"`
	// Current status of the host.
	Status *HostStatusResponseBody `json:"status"`
	// The default PgEdge version for this host.
	DefaultPgedgeVersion *PgEdgeVersionResponseBody `json:"default_pgedge_version,omitempty"`
	// The PgEdge versions supported by this host.
	SupportedPgedgeVersions []*PgEdgeVersionResponseBody `json:"supported_pgedge_versions,omitempty"`
	// The etcd mode for this host.
	EtcdMode *string `json:"etcd_mode,omitempty"`
}

HostResponseBody is used to define fields on response body types.

type HostStatusResponseBody

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

HostStatusResponseBody is used to define fields on response body types.

type InitClusterClusterAlreadyInitializedResponseBody

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

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

type InitClusterOperationNotSupportedResponseBody

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

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

type InitClusterResponseBody

type InitClusterResponseBody struct {
	// Token to join an existing cluster.
	Token *string `json:"token"`
	// Existing server to join
	ServerUrls []string `json:"server_urls"`
}

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

type InitClusterServerErrorResponseBody

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

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

type InstanceConnectionInfoResponseBody

type InstanceConnectionInfoResponseBody struct {
	// The addresses of the host that's running this instance.
	Addresses []string `json:"addresses,omitempty"`
	// The host port that Postgres is listening on for this instance.
	Port *int `json:"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 `json:"version,omitempty"`
	PatroniState *string `json:"patroni_state,omitempty"`
	Role         *string `json:"role,omitempty"`
	// True if this instance has a pending restart from a configuration change.
	PendingRestart *bool `json:"pending_restart,omitempty"`
	// True if Patroni is paused for this instance.
	PatroniPaused *bool `json:"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 `json:"id"`
	// The ID of the host this instance is running on.
	HostID *string `json:"host_id"`
	// The Spock node name for this instance.
	NodeName *string `json:"node_name"`
	// The time that the instance was created.
	CreatedAt *string `json:"created_at"`
	// The time that the instance was last modified.
	UpdatedAt *string `json:"updated_at"`
	// The time that the instance status information was last updated.
	StatusUpdatedAt *string `json:"status_updated_at,omitempty"`
	State           *string `json:"state"`
	// Connection information for the instance.
	ConnectionInfo *InstanceConnectionInfoResponseBody `json:"connection_info,omitempty"`
	// Postgres status information for the instance.
	Postgres *InstancePostgresStatusResponseBody `json:"postgres,omitempty"`
	// Spock status information for the instance.
	Spock *InstanceSpockStatusResponseBody `json:"spock,omitempty"`
	// An error message if the instance is in an error state.
	Error *string `json:"error,omitempty"`
}

InstanceResponseBody is used to define fields on response body types.

type InstanceSpockStatusResponseBody

type InstanceSpockStatusResponseBody struct {
	// The current spock.readonly setting.
	ReadOnly *string `json:"read_only,omitempty"`
	// The version of Spock for this instance.
	Version *string `json:"version,omitempty"`
	// Status information for this instance's Spock subscriptions.
	Subscriptions []*InstanceSubscriptionResponseBody `json:"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 `json:"provider_node"`
	// The name of the subscription.
	Name *string `json:"name"`
	// The current status of the subscription.
	Status *string `json:"status"`
}

InstanceSubscriptionResponseBody is used to define fields on response body types.

type JoinClusterClusterAlreadyInitializedResponseBody

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

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

type JoinClusterInvalidInputResponseBody added in v0.6.0

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

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

type JoinClusterInvalidJoinTokenResponseBody

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

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

type JoinClusterRequestBody

type JoinClusterRequestBody struct {
	// Token to join an existing cluster.
	Token string `json:"token"`
	// Existing server to join
	ServerUrls []string `json:"server_urls"`
}

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

func NewJoinClusterRequestBody

func NewJoinClusterRequestBody(p *controlplane.ClusterJoinToken) *JoinClusterRequestBody

NewJoinClusterRequestBody builds the HTTP request body from the payload of the "join-cluster" endpoint of the "control-plane" service.

type JoinClusterServerErrorResponseBody

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

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

type ListDatabaseTasksClusterNotInitializedResponseBody

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

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

type ListDatabaseTasksInvalidInputResponseBody

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

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

type ListDatabaseTasksNotFoundResponseBody

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

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

type ListDatabaseTasksResponseBody

type ListDatabaseTasksResponseBody struct {
	// The tasks for the given database.
	Tasks []*TaskResponseBody `json:"tasks"`
}

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

type ListDatabaseTasksServerErrorResponseBody

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

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

type ListDatabasesClusterNotInitializedResponseBody

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

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

type ListDatabasesResponseBody

type ListDatabasesResponseBody struct {
	// The databases managed by this cluster.
	Databases []*DatabaseSummaryResponseBody `json:"databases"`
}

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

type ListDatabasesServerErrorResponseBody

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

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

type ListHostTasksClusterNotInitializedResponseBody added in v0.7.0

type ListHostTasksClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type ListHostTasksInvalidInputResponseBody added in v0.7.0

type ListHostTasksInvalidInputResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type ListHostTasksNotFoundResponseBody added in v0.7.0

type ListHostTasksNotFoundResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type ListHostTasksResponseBody added in v0.7.0

type ListHostTasksResponseBody struct {
	// The tasks for the given host.
	Tasks []*TaskResponseBody `json:"tasks"`
}

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

type ListHostTasksServerErrorResponseBody added in v0.7.0

type ListHostTasksServerErrorResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type ListHostsClusterNotInitializedResponseBody

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

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

type ListHostsResponseBody

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

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

type ListHostsServerErrorResponseBody

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

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

type ListTasksClusterNotInitializedResponseBody added in v0.7.0

type ListTasksClusterNotInitializedResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type ListTasksInvalidInputResponseBody added in v0.7.0

type ListTasksInvalidInputResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type ListTasksResponseBody added in v0.7.0

type ListTasksResponseBody struct {
	// The tasks for the given entity.
	Tasks []*TaskResponseBody `json:"tasks"`
}

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

type ListTasksServerErrorResponseBody added in v0.7.0

type ListTasksServerErrorResponseBody struct {
	// The name of the error.
	Name *string `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type OrchestratorOptsRequestBody

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

OrchestratorOptsRequestBody is used to define fields on request body types.

type OrchestratorOptsRequestBodyRequestBody

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

OrchestratorOptsRequestBodyRequestBody is used to define fields on request body types.

type OrchestratorOptsResponseBody

type OrchestratorOptsResponseBody struct {
	// Swarm-specific configuration.
	Swarm *SwarmOptsResponseBody `json:"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 `json:"postgres_version"`
	// The Spock major version.
	SpockVersion *string `json:"spock_version"`
}

PgEdgeVersionResponseBody is used to define fields on response body types.

type PortMappingResponseBody added in v0.7.0

type PortMappingResponseBody struct {
	// The name of the port (e.g., 'http', 'web-client').
	Name *string `json:"name"`
	// The port number inside the container.
	ContainerPort *int `json:"container_port,omitempty"`
	// The port number on the host (if port-forwarded).
	HostPort *int `json:"host_port,omitempty"`
}

PortMappingResponseBody is used to define fields on response body types.

type RemoveHostClusterNotInitializedResponseBody

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

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

type RemoveHostInvalidInputResponseBody

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

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

type RemoveHostNotFoundResponseBody

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

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

type RemoveHostResponseBody added in v0.6.0

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

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

type RemoveHostServerErrorResponseBody

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

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

type RestartInstanceClusterNotInitializedResponseBody

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

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

type RestartInstanceInvalidInputResponseBody

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

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

type RestartInstanceNotFoundResponseBody

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

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

type RestartInstanceResponseBody

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

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

type RestartInstanceServerErrorResponseBody

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

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

type RestoreConfigSpecRequestBody

type RestoreConfigSpecRequestBody struct {
	// The ID of the database to restore this database from.
	SourceDatabaseID string `json:"source_database_id"`
	// The name of the node to restore this database from.
	SourceNodeName string `json:"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 `json:"source_database_name"`
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecRequestBody `json:"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 `json:"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 `json:"source_database_id"`
	// The name of the node to restore this database from.
	SourceNodeName string `json:"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 `json:"source_database_name"`
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecRequestBodyRequestBody `json:"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 `json:"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 `json:"source_database_id"`
	// The name of the node to restore this database from.
	SourceNodeName *string `json:"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 `json:"source_database_name"`
	// The repository to restore this database from.
	Repository *RestoreRepositorySpecResponseBody `json:"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 `json:"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 `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type RestoreDatabaseDatabaseNotModifiableResponseBody

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

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

type RestoreDatabaseInvalidInputResponseBody

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

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

type RestoreDatabaseNotFoundResponseBody

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

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

type RestoreDatabaseOperationAlreadyInProgressResponseBody

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

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

type RestoreDatabaseRequestBody

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

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

func NewRestoreDatabaseRequestBody

func NewRestoreDatabaseRequestBody(p *controlplane.RestoreDatabasePayload) *RestoreDatabaseRequestBody

NewRestoreDatabaseRequestBody builds the HTTP request body from the payload of the "restore-database" endpoint of the "control-plane" service.

type RestoreDatabaseResponseBody

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

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

type RestoreDatabaseServerErrorResponseBody

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

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

type RestoreRepositorySpecRequestBody

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

RestoreRepositorySpecResponseBody is used to define fields on response body types.

type ServiceInstanceResponseBody added in v0.7.0

type ServiceInstanceResponseBody struct {
	// Unique identifier for the service instance.
	ServiceInstanceID *string `json:"service_instance_id"`
	// The service ID from the DatabaseSpec.
	ServiceID *string `json:"service_id"`
	// The ID of the database this service belongs to.
	DatabaseID *string `json:"database_id"`
	// The ID of the host this service instance is running on.
	HostID *string `json:"host_id"`
	// Current state of the service instance.
	State *string `json:"state"`
	// Runtime status information for the service instance.
	Status *ServiceInstanceStatusResponseBody `json:"status,omitempty"`
	// The time that the service instance was created.
	CreatedAt *string `json:"created_at"`
	// The time that the service instance was last updated.
	UpdatedAt *string `json:"updated_at"`
	// An error message if the service instance is in an error state.
	Error *string `json:"error,omitempty"`
}

ServiceInstanceResponseBody is used to define fields on response body types.

type ServiceInstanceStatusResponseBody added in v0.7.0

type ServiceInstanceStatusResponseBody struct {
	// The Docker container ID.
	ContainerID *string `json:"container_id,omitempty"`
	// The container image version currently running.
	ImageVersion *string `json:"image_version,omitempty"`
	// The addresses of the host that's running this service instance.
	Addresses []string `json:"addresses,omitempty"`
	// Port mappings for this service instance.
	Ports []*PortMappingResponseBody `json:"ports,omitempty"`
	// Most recent health check result.
	HealthCheck *HealthCheckResultResponseBody `json:"health_check,omitempty"`
	// The time of the last health check attempt.
	LastHealthAt *string `json:"last_health_at,omitempty"`
	// Whether the service is ready to accept requests.
	ServiceReady *bool `json:"service_ready,omitempty"`
}

ServiceInstanceStatusResponseBody is used to define fields on response body types.

type ServiceSpecRequestBody added in v0.7.0

type ServiceSpecRequestBody struct {
	// The unique identifier for this service.
	ServiceID string `json:"service_id"`
	// The type of service to run.
	ServiceType string `json:"service_type"`
	// The version of the service in semver format (e.g., '1.0.0') or the literal
	// 'latest'.
	Version string `json:"version"`
	// The IDs of the hosts that should run this service. One service instance will
	// be created per host.
	HostIds []string `json:"host_ids"`
	// The port to publish the service on the host. If 0, Docker assigns a random
	// port. If unspecified, no port is published and the service is not accessible
	// from outside the Docker network.
	Port *int `json:"port,omitempty"`
	// Service-specific configuration. For MCP services, this includes
	// llm_provider, llm_model, and provider-specific API keys.
	Config map[string]any `json:"config"`
	// The number of CPUs to allocate for this service. It can include the SI
	// suffix 'm', e.g. '500m' for 500 millicpus. Defaults to container defaults if
	// unspecified.
	Cpus *string `json:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for this service.
	// Defaults to container defaults if unspecified.
	Memory *string `json:"memory,omitempty"`
	// Orchestrator-specific options for this service.
	OrchestratorOpts *OrchestratorOptsRequestBody `json:"orchestrator_opts,omitempty"`
	// Optional database connection routing configuration.
	DatabaseConnection *DatabaseConnectionRequestBody `json:"database_connection,omitempty"`
}

ServiceSpecRequestBody is used to define fields on request body types.

type ServiceSpecRequestBodyRequestBody added in v0.7.0

type ServiceSpecRequestBodyRequestBody struct {
	// The unique identifier for this service.
	ServiceID string `json:"service_id"`
	// The type of service to run.
	ServiceType string `json:"service_type"`
	// The version of the service in semver format (e.g., '1.0.0') or the literal
	// 'latest'.
	Version string `json:"version"`
	// The IDs of the hosts that should run this service. One service instance will
	// be created per host.
	HostIds []string `json:"host_ids"`
	// The port to publish the service on the host. If 0, Docker assigns a random
	// port. If unspecified, no port is published and the service is not accessible
	// from outside the Docker network.
	Port *int `json:"port,omitempty"`
	// Service-specific configuration. For MCP services, this includes
	// llm_provider, llm_model, and provider-specific API keys.
	Config map[string]any `json:"config"`
	// The number of CPUs to allocate for this service. It can include the SI
	// suffix 'm', e.g. '500m' for 500 millicpus. Defaults to container defaults if
	// unspecified.
	Cpus *string `json:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for this service.
	// Defaults to container defaults if unspecified.
	Memory *string `json:"memory,omitempty"`
	// Orchestrator-specific options for this service.
	OrchestratorOpts *OrchestratorOptsRequestBodyRequestBody `json:"orchestrator_opts,omitempty"`
	// Optional database connection routing configuration.
	DatabaseConnection *DatabaseConnectionRequestBodyRequestBody `json:"database_connection,omitempty"`
}

ServiceSpecRequestBodyRequestBody is used to define fields on request body types.

type ServiceSpecResponseBody added in v0.7.0

type ServiceSpecResponseBody struct {
	// The unique identifier for this service.
	ServiceID *string `json:"service_id"`
	// The type of service to run.
	ServiceType *string `json:"service_type"`
	// The version of the service in semver format (e.g., '1.0.0') or the literal
	// 'latest'.
	Version *string `json:"version"`
	// The IDs of the hosts that should run this service. One service instance will
	// be created per host.
	HostIds []string `json:"host_ids"`
	// The port to publish the service on the host. If 0, Docker assigns a random
	// port. If unspecified, no port is published and the service is not accessible
	// from outside the Docker network.
	Port *int `json:"port,omitempty"`
	// Service-specific configuration. For MCP services, this includes
	// llm_provider, llm_model, and provider-specific API keys.
	Config map[string]any `json:"config"`
	// The number of CPUs to allocate for this service. It can include the SI
	// suffix 'm', e.g. '500m' for 500 millicpus. Defaults to container defaults if
	// unspecified.
	Cpus *string `json:"cpus,omitempty"`
	// The amount of memory in SI or IEC notation to allocate for this service.
	// Defaults to container defaults if unspecified.
	Memory *string `json:"memory,omitempty"`
	// Orchestrator-specific options for this service.
	OrchestratorOpts *OrchestratorOptsResponseBody `json:"orchestrator_opts,omitempty"`
	// Optional database connection routing configuration.
	DatabaseConnection *DatabaseConnectionResponseBody `json:"database_connection,omitempty"`
}

ServiceSpecResponseBody is used to define fields on response body types.

type StartInstanceClusterNotInitializedResponseBody

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

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

type StartInstanceInvalidInputResponseBody

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

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

type StartInstanceNotFoundResponseBody

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

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

type StartInstanceResponseBody

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

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

type StartInstanceServerErrorResponseBody

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

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

type StopInstanceClusterNotInitializedResponseBody

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

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

type StopInstanceInvalidInputResponseBody

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

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

type StopInstanceNotFoundResponseBody

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

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

type StopInstanceResponseBody

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

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

type StopInstanceServerErrorResponseBody

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

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

type SwarmOptsRequestBody

type SwarmOptsRequestBody struct {
	// A list of extra volumes to mount. Each entry defines a host and container
	// path.
	ExtraVolumes []*ExtraVolumesSpecRequestBody `json:"extra_volumes,omitempty"`
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecRequestBody `json:"extra_networks,omitempty"`
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string `json:"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 `json:"extra_volumes,omitempty"`
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecRequestBodyRequestBody `json:"extra_networks,omitempty"`
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string `json:"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 `json:"extra_volumes,omitempty"`
	// A list of additional Docker Swarm networks to attach containers in this
	// database to.
	ExtraNetworks []*ExtraNetworkSpecResponseBody `json:"extra_networks,omitempty"`
	// Arbitrary labels to apply to the Docker Swarm service
	ExtraLabels map[string]string `json:"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 `json:"name"`
	// The error message.
	Message *string `json:"message"`
}

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

type SwitchoverDatabaseNodeDatabaseNotModifiableResponseBody

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

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

type SwitchoverDatabaseNodeInvalidInputResponseBody

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

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

type SwitchoverDatabaseNodeNotFoundResponseBody

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

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

type SwitchoverDatabaseNodeOperationAlreadyInProgressResponseBody

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

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

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.

func NewSwitchoverDatabaseNodeRequestBody

func NewSwitchoverDatabaseNodeRequestBody(p *controlplane.SwitchoverDatabaseNodePayload) *SwitchoverDatabaseNodeRequestBody

NewSwitchoverDatabaseNodeRequestBody builds the HTTP request body from the payload of the "switchover-database-node" endpoint of the "control-plane" service.

type SwitchoverDatabaseNodeResponseBody

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

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

type SwitchoverDatabaseNodeServerErrorResponseBody

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

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

type TaskLogEntryResponseBody

type TaskLogEntryResponseBody struct {
	// The timestamp of the log entry.
	Timestamp *string `json:"timestamp"`
	// The log message.
	Message *string `json:"message"`
	// Additional fields for the log entry.
	Fields map[string]any `json:"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 `json:"parent_id,omitempty"`
	// The scope of the task (database or host).
	Scope *string `json:"scope"`
	// The entity ID (database_id or host_id) that this task belongs to.
	EntityID *string `json:"entity_id"`
	// The database ID of the task.
	DatabaseID *string `json:"database_id,omitempty"`
	// The name of the node that the task is operating on.
	NodeName *string `json:"node_name,omitempty"`
	// The ID of the instance that the task is operating on.
	InstanceID *string `json:"instance_id,omitempty"`
	// The ID of the host that the task is running on.
	HostID *string `json:"host_id,omitempty"`
	// The unique ID of the task.
	TaskID *string `json:"task_id"`
	// The time when the task was created.
	CreatedAt *string `json:"created_at"`
	// The time when the task was completed.
	CompletedAt *string `json:"completed_at,omitempty"`
	// The type of the task.
	Type *string `json:"type"`
	// The status of the task.
	Status *string `json:"status"`
	// The error message if the task failed.
	Error *string `json:"error,omitempty"`
}

TaskResponseBody is used to define fields on response body types.

type UpdateDatabaseClusterNotInitializedResponseBody

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

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

type UpdateDatabaseDatabaseNotModifiableResponseBody

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

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

type UpdateDatabaseInvalidInputResponseBody

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

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

type UpdateDatabaseNotFoundResponseBody

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

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

type UpdateDatabaseOperationAlreadyInProgressResponseBody

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

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

type UpdateDatabaseRequestBody

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

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

func NewUpdateDatabaseRequestBody

func NewUpdateDatabaseRequestBody(p *controlplane.UpdateDatabasePayload) *UpdateDatabaseRequestBody

NewUpdateDatabaseRequestBody builds the HTTP request body from the payload of the "update-database" endpoint of the "control-plane" service.

type UpdateDatabaseResponseBody

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

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

type UpdateDatabaseServerErrorResponseBody

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL