modulepackage
0.0.0-20180924124721-7648d1e9c170
Repository: https://github.com/compose/gocomposeapi.git
Documentation: pkg.go.dev
# README
gocomposeapi
A Go wrapper for the Compose API
This is a basic wrapper around the Compose API as documented on apidocs.compose.com
# Functions
NewClient returns a Client for further interaction with the API.
ProcessErrors tries to turn errors into an Errors struct.
# Structs
Account structure.
AccountParams is the list of parameters that can be updated on an existing account.
Alert type which holds each Alert.
Alerts type which contains all the Alerts and a summary.
AuditEvent is the returned information for a single Compose audit event.
AuditEventsParams is the structure of entirely optional options for filtering or paging through audit events.
Backup structure.
Client is a structure that holds session information for the API.
Cluster structure.
ConnectionStrings structure, part of the Deployment struct.
CreateDeploymentParams Parameters to be completed before creating a deployment.
Database structure.
Datacenter structure.
Deployment structure.
DeploymentParams core parameters for a new deployment.
DeploymentWhitelist - representation of an applied whitelist entry.
DeploymentWhitelistParams - construct to pass to CreateDeploymentWhitelist.
Errors struct for parsing error returns.
Link structure for JSON+HAL links.
Links structure, part of the Deployment struct.
Logfile structure.
PatchDeploymentParams is used to pass parameters to PatchDeployment.
Recipe structure.
RestoreBackupParams Parameters to be completed before creating a deployment.
Scalings represents the used, allocated, starting and minimum unit scale of a deployment.
ScalingsParams represents the parameters needed to scale a deployment.
SimpleError struct for parsing simple error returns.
Team structure.
TeamParams core parameters for a new team.
TeamRole the name of the role and list of teams with that role for a deployment.
TeamRoleParams the core parameters to create or delete a team role.
User structure.
UserParams structure.
Version structure.
VersionTransition a struct wrapper for version transition information.