README
¶
go-client-codegen
go-client-codegen is an automatically code generated Aiven Go Client. It is generated from the Aiven API specification.
Setup
go get github.com/aiven/go-client-codegen
Configuration and Usage
Via Environment Variables
| Name | Type | Description |
|---|---|---|
AIVEN_TOKEN |
string |
Aiven API Authentication Token |
AIVEN_WEB_URL |
string |
Aiven API URL |
AIVEN_USER_AGENT |
string |
User Agent |
AIVEN_DEBUG |
bool |
Debug Output Flag (stderr) |
Via Constructor Options
import "github.com/aiven/go-client-codegen"
client, err := aiven.NewClient(DebugOpt(true), UserAgentOpt("foo"))
if err != nil {
return err
}
services, err := client.ServiceList(ctx, "bar-project")
See CONTRIBUTING.md for instructions on how to contribute to the development of go-client-codegen.
License
go-client-codegen is licensed under the Apache license, version 2.0. Full license text is available in the LICENSE file.
Please note that the project explicitly does not require a CLA (Contributor License Agreement) from its contributors.
Contact
Bug reports and patches are very welcome, please post them as GitHub issues and pull requests at https://github.com/aiven/go-client-codegen. To report any possible vulnerabilities or other serious issues please see our security policy.
Documentation
¶
Overview ¶
Package aiven provides a client for interacting with the Aiven API.
Package aiven provides a client for interacting with the Aiven API.
Package aiven provides a client for interacting with the Aiven API.
Package aiven provides a client for interacting with the Aiven API.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func IsAlreadyExists ¶
IsAlreadyExists returns true if the error message and error code that indicates that entity already exists
func IsNotFound ¶
IsNotFound returns true if the specified error has status 404
func OmitNotFound ¶
OmitNotFound sometimes 404 is expected, and not an error. For instance, when a resource is deleted in a retry loop.
Types ¶
type Client ¶
type Client interface {
account.Handler
accountauthentication.Handler
accountteam.Handler
accountteammember.Handler
billinggroup.Handler
clickhouse.Handler
cloud.Handler
domain.Handler
flink.Handler
flinkapplication.Handler
flinkapplicationdeployment.Handler
flinkapplicationversion.Handler
flinkjob.Handler
kafka.Handler
kafkaconnect.Handler
kafkamirrormaker.Handler
kafkaschemaregistry.Handler
kafkatopic.Handler
mysql.Handler
opensearch.Handler
organization.Handler
organizationuser.Handler
postgresql.Handler
privatelink.Handler
project.Handler
projectbilling.Handler
service.Handler
serviceintegration.Handler
serviceuser.Handler
staticip.Handler
user.Handler
usergroup.Handler
vpc.Handler
}
type Error ¶
type Error struct {
Message string `json:"message"`
MoreInfo string `json:"more_info"`
Status int `json:"status"`
}
Error represents an Aiven API Error.
type OperationIDKey ¶
type OperationIDKey struct{}
OperationIDKey is the key used to store the operation ID in the context.
Source Files
Directories