Categorygithub.com/mariadb-corporation/skysql-api-go
modulepackage
0.0.26
Repository: https://github.com/mariadb-corporation/skysql-api-go.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
0
Files
4.5k SLOC

# README

MariaDB SkySQL DBaaS API Golang SDK

The MariaDB SkySQL DBaaS API Golang SDK is a Technical Preview. Software in Tech Preview should not be used for production workloads.

This project contains a golang client generated from the OpenAPI specification for the SkySQL API created deepmap/oapi-codegen.

The following files are autogenerated and should not be modified directly:

  • openapi.json
  • types.go
  • client.go
  • go.sum

If changes do need to be made the generated package, please do so by overriding the templates that are used: https://github.com/deepmap/oapi-codegen#making-changes-to-code-generation

# Packages

No description provided by the author

# Functions

NewAddAllowedAddressRequest calls the generic AddAllowedAddress builder with application/json body.
NewAddAllowedAddressRequestWithBody generates requests for AddAllowedAddress with any type of body.
Creates a new Client, with reasonable defaults.
NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling.
NewCreateConfigurationRequest calls the generic CreateConfiguration builder with application/json body.
NewCreateConfigurationRequestWithBody generates requests for CreateConfiguration with any type of body.
NewCreateServiceRequest calls the generic CreateService builder with application/json body.
NewCreateServiceRequestWithBody generates requests for CreateService with any type of body.
NewDeleteConfigurationRequest generates requests for DeleteConfiguration.
NewDeleteServiceRequest generates requests for DeleteService.
NewGetCurrentUserTierRequest generates requests for GetCurrentUserTier.
NewListAllowedAddressesRequest generates requests for ListAllowedAddresses.
NewListConfigurationsRequest generates requests for ListConfigurations.
NewListServicesRequest generates requests for ListServices.
NewReadAllowlistStatusRequest generates requests for ReadAllowlistStatus.
NewReadConfigurationRequest generates requests for ReadConfiguration.
NewReadProvidersRequest generates requests for ReadProviders.
NewReadQuotasRequest generates requests for ReadQuotas.
NewReadRegionsRequest generates requests for ReadRegions.
NewReadServiceRequest generates requests for ReadService.
NewReadServiceTypesRequest generates requests for ReadServiceTypes.
NewReadSizesRequest generates requests for ReadSizes.
NewReadStatusRequest generates requests for ReadStatus.
NewReadTiersRequest generates requests for ReadTiers.
NewReadTopologiesRequest generates requests for ReadTopologies.
NewReadVersionsRequest generates requests for ReadVersions.
NewRemoveAllowedAddressRequest generates requests for RemoveAllowedAddress.
NewRetrieveApiVersionRequest generates requests for RetrieveApiVersion.
NewRetrieveDefaultCredentialsRequest generates requests for RetrieveDefaultCredentials.
NewUpdateConfigurationRequest calls the generic UpdateConfiguration builder with application/json body.
NewUpdateConfigurationRequestWithBody generates requests for UpdateConfiguration with any type of body.
NewUpdateServiceRequest calls the generic UpdateService builder with application/json body.
NewUpdateServiceRequestWithBody generates requests for UpdateService with any type of body.
NewUpdateStatusRequest calls the generic UpdateStatus builder with application/json body.
NewUpdateStatusRequestWithBody generates requests for UpdateStatus with any type of body.
ParseAddAllowedAddressResponse parses an HTTP response from a AddAllowedAddressWithResponse call.
ParseCreateConfigurationResponse parses an HTTP response from a CreateConfigurationWithResponse call.
ParseCreateServiceResponse parses an HTTP response from a CreateServiceWithResponse call.
ParseDeleteConfigurationResponse parses an HTTP response from a DeleteConfigurationWithResponse call.
ParseDeleteServiceResponse parses an HTTP response from a DeleteServiceWithResponse call.
ParseGetCurrentUserTierResponse parses an HTTP response from a GetCurrentUserTierWithResponse call.
ParseListAllowedAddressesResponse parses an HTTP response from a ListAllowedAddressesWithResponse call.
ParseListConfigurationsResponse parses an HTTP response from a ListConfigurationsWithResponse call.
ParseListServicesResponse parses an HTTP response from a ListServicesWithResponse call.
ParseReadAllowlistStatusResponse parses an HTTP response from a ReadAllowlistStatusWithResponse call.
ParseReadConfigurationResponse parses an HTTP response from a ReadConfigurationWithResponse call.
ParseReadProvidersResponse parses an HTTP response from a ReadProvidersWithResponse call.
ParseReadQuotasResponse parses an HTTP response from a ReadQuotasWithResponse call.
ParseReadRegionsResponse parses an HTTP response from a ReadRegionsWithResponse call.
ParseReadServiceResponse parses an HTTP response from a ReadServiceWithResponse call.
ParseReadServiceTypesResponse parses an HTTP response from a ReadServiceTypesWithResponse call.
ParseReadSizesResponse parses an HTTP response from a ReadSizesWithResponse call.
ParseReadStatusResponse parses an HTTP response from a ReadStatusWithResponse call.
ParseReadTiersResponse parses an HTTP response from a ReadTiersWithResponse call.
ParseReadTopologiesResponse parses an HTTP response from a ReadTopologiesWithResponse call.
ParseReadVersionsResponse parses an HTTP response from a ReadVersionsWithResponse call.
ParseRemoveAllowedAddressResponse parses an HTTP response from a RemoveAllowedAddressWithResponse call.
ParseRetrieveApiVersionResponse parses an HTTP response from a RetrieveApiVersionWithResponse call.
ParseRetrieveDefaultCredentialsResponse parses an HTTP response from a RetrieveDefaultCredentialsWithResponse call.
ParseUpdateConfigurationResponse parses an HTTP response from a UpdateConfigurationWithResponse call.
ParseUpdateServiceResponse parses an HTTP response from a UpdateServiceWithResponse call.
ParseUpdateStatusResponse parses an HTTP response from a UpdateStatusWithResponse call.
WithBaseURL overrides the baseURL.
WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client.
WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request.

# Constants

Defines values for AllowlistStatuses.
Defines values for AllowlistStatuses.
No description provided by the author
Defines values for ServiceInSslTls.
Defines values for ServiceInSslTls.
Defines values for ServiceInSslTls.
Defines values for ServiceInTier.
Defines values for ServiceInTier.
Defines values for ServiceInTopology.
Defines values for ServiceInTopology.
Defines values for ServiceInTopology.
Defines values for ServiceInTopology.
Defines values for ServiceInTopology.
Defines values for ServiceOutSslTls.
Defines values for ServiceOutSslTls.
Defines values for ServiceOutSslTls.
Defines values for SnowProviders.
Defines values for SnowProviders.
Defines values for SnowProviders.
Defines values for SnowProviders.
Defines values for SnowProviders.
Defines values for SnowProviders.
Defines values for SnowProviders.
Defines values for SnowProviders.

# Structs

No description provided by the author
IP Address that has been added to the services network allowlist.
Status of the service allowlist to indicate if address changes are provisioning.
Client which conforms to the OpenAPI3 specification for this service.
ClientWithResponses builds on ClientInterface to offer response payloads.
GET Configuration Response.
Configuration Response Base Model.
GET Configuration Response nested configuration version.
Request body to create a new MariaDB Configuration.
Update Configuration Response.
No description provided by the author
No description provided by the author
A credential issued for initial connection to a database, intended to be immediately replaced by the user.
No description provided by the author
No description provided by the author
No description provided by the author
HTTPValidationError defines model for HTTPValidationError.
IP Address representation in SkySQL.
ListAllowedAddressesParams defines parameters for ListAllowedAddresses.
No description provided by the author
ListConfigurationsParams defines parameters for ListConfigurations.
No description provided by the author
ListServicesParams defines parameters for ListServices.
No description provided by the author
Generic message body containing error details for failed requests.
Cloud provider, e.g.
A quota progress response.
No description provided by the author
No description provided by the author
ReadProvidersParams defines parameters for ReadProviders.
No description provided by the author
No description provided by the author
ReadRegionsParams defines parameters for ReadRegions.
No description provided by the author
No description provided by the author
ReadServiceTypesParams defines parameters for ReadServiceTypes.
No description provided by the author
ReadSizesParams defines parameters for ReadSizes.
No description provided by the author
No description provided by the author
ReadTiersParams defines parameters for ReadTiers.
No description provided by the author
ReadTopologiesParams defines parameters for ReadTopologies.
No description provided by the author
ReadVersionsParams defines parameters for ReadVersions.
No description provided by the author
Geographic region, as defined by the providers.
RemoveAllowedAddressParams defines parameters for RemoveAllowedAddress.
No description provided by the author
No description provided by the author
No description provided by the author
Request body to create a new MariaDB services deployed by SkySQL.
Base class for Service responses.
Response body for a services status.
Request body to update a service.
A database service type, e.g.
Request body to update a services - currently limited to name only.
Node size, as defined by the providers.
Availability tier, e.g.
Cluster topology valid for a particular product, e.g.
Message details containing unmet expectations from failed specs.
Message body with details regarding failed specifications.
Request body to update a configuration.
No description provided by the author
No description provided by the author
No description provided by the author
ValidationError defines model for ValidationError.
Database version, e.g.

# Interfaces

The interface specification for the client above.
ClientWithResponsesInterface is the interface specification for the client with responses above.
Doer performs HTTP requests.
Actions that can be taken on a services in a Task.

# Type aliases

AddAllowedAddressJSONBody defines parameters for AddAllowedAddress.
AddAllowedAddressJSONRequestBody defines body for AddAllowedAddress for application/json ContentType.
Possible statuses for the allowlist.
ClientOption allows setting custom parameters during construction.
CreateConfigurationJSONBody defines parameters for CreateConfiguration.
CreateConfigurationJSONRequestBody defines body for CreateConfiguration for application/json ContentType.
CreateServiceJSONBody defines parameters for CreateService.
CreateServiceJSONRequestBody defines body for CreateService for application/json ContentType.
ReadSizesParamsTier defines parameters for ReadSizes.
ReadSizesParamsTopology defines parameters for ReadSizes.
ReadTopologiesParamsServiceType defines parameters for ReadTopologies.
RequestEditorFn is the function signature for the RequestEditor callback function.
ServiceInSslTls defines model for ServiceIn.SslTls.
ServiceInTier defines model for ServiceIn.Tier.
ServiceInTopology defines model for ServiceIn.Topology.
ServiceOutSslTls defines model for ServiceOut.SslTls.
Providers configured in snow.
UpdateConfigurationJSONBody defines parameters for UpdateConfiguration.
UpdateConfigurationJSONRequestBody defines body for UpdateConfiguration for application/json ContentType.
UpdateServiceJSONBody defines parameters for UpdateService.
UpdateServiceJSONRequestBody defines body for UpdateService for application/json ContentType.
UpdateStatusJSONBody defines parameters for UpdateStatus.
UpdateStatusJSONRequestBody defines body for UpdateStatus for application/json ContentType.