Categorygithub.com/updater/cloudcraft-go
modulepackage
0.0.0-20231012215004-0a3d80e3b521
Repository: https://github.com/updater/cloudcraft-go.git
Documentation: pkg.go.dev

# README

cloudcraft-go

Go client library for accessing the https://cloudcraft.co API

# Functions

Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
CheckResponse checks the API response for errors, and returns them if present.
DoRequest submits an HTTP request.
DoRequestWithClient submits an HTTP request using the specified client.
Int is a helper routine that allocates a new int32 value to store v and returns a pointer to it, but unlike Int32 its argument value is an int.
New returns a new Cloudcraft API client instance.
NewArgError creates an InputError.
NewClient returns a new Cloudcraft API client, using the given http.Client to perform all requests.
NewFromToken returns a new Cloudcraft API client with the given API token.
SetBaseURL is a client option for setting the base URL.
SetRequestHeaders sets optional HTTP headers on the client that are sent on each HTTP request.
SetUserAgent is a client option for setting the user agent.
StreamToString converts a reader to a string.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
Stringify attempts to create a string representation of Cloudcraft types.

# Structs

ArgError is an error that represents an error with an input to cloudcraft-go.
AwsAccount represents a Cloudcraft AwsAccount.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
AwsAccountsServiceOp handles communication with the AwsAccount related methods of the Cloudcraft API.
Blueprint represents a Cloudcraft Blueprint.
BlueprintCreateRequest represents a request to create a Blueprint.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BlueprintsServiceOp handles communication with the Blueprint related methods of the Cloudcraft API.
BlueprintCreateRequest represents a request to update a Blueprint.
No description provided by the author
An ErrorResponse reports the error caused by an API request.
Response is a Cloudcraft response.
Timestamp represents a time that can be unmarshalled from a JSON string formatted as either an RFC3339 or Unix timestamp.
User represents a Cloudcraft User.
UsersServiceOp handles communication with the User related methods of the Cloudcraft API.

# Interfaces

AwsAccountsService is an interface for interfacing with the AwsAccounts endpoints of the Cloudcraft API See: https://developers.cloudcraft.co/#dbc3d135-6447-47f2-b043-bae65b722246.
BlueprintsService is an interface for interfacing with the Blueprints endpoints of the Cloudcraft API See: https://developers.cloudcraft.co/#dbc3d135-6447-47f2-b043-bae65b722246.
ResourceWithURN is an interface for interfacing with the types that implement the URN method.
UsersService is an interface for interfacing with the Users endpoints of the Cloudcraft API See: https://developers.cloudcraft.co/#398fa0e6-3139-41e6-a5c2-3b9a31e15d6d.

# Type aliases

ClientOpt are options for New.
No description provided by the author