api

package
v1.4.2 Latest Latest
Warning

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

 Go to latest Published: Mar 7, 2024 License: BSD-3-Clause Imports: 26 Imported by: 0

Documentation

Index

Constants

View Source 
const IronstarArimaProductionAPIDomain = "https://uploads.ironstar.io"
View Source 
const IronstarProductionAPIDomain = "https://api.ironstar.io"
View Source 
const IronstarUploadAPIDomain = "https://uploads.ironstar.io"

Variables

View Source 
var ErrExternalAPICall = errors.New("External API call was unsuccessful!")
View Source 
var ErrIronstarAPICall = errors.New("Ironstar API call was unsuccessful!")

Functions

func DeleteBackup 

func DeleteBackup(creds types.Keylink, output string, payload types.DeleteBackupParams) error

func DeleteEnvironmentEnvVar 

func DeleteEnvironmentEnvVar(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, key string) error

func DeleteEnvironmentHook 

func DeleteEnvironmentHook(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, hookName string) error

func DownloadEnvironmentBackupComponent 

func DownloadEnvironmentBackupComponent(creds types.Keylink, output, subAliasOrHashedID, envNameOrHashedID, backupName, savePath string, buComp types.BackupIterationComponent) error

func GetArimaBaseURL 

func GetArimaBaseURL() string

func GetBaseUploadURL 

func GetBaseUploadURL() string

func GetCurrentAPIUsageTerms 

func GetCurrentAPIUsageTerms() (types.APIUsageTerms, error)

func GetDeployment 

func GetDeployment(creds types.Keylink, output, deployID string) (types.Deployment, error)

func GetDeploymentActivity 

func GetDeploymentActivity(creds types.Keylink, output, deployID string) ([]types.DeploymentActivityResponse, error)

func GetEnvironmentAntivirusScans 

func GetEnvironmentAntivirusScans(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string) ([]types.AntivirusScan, error)

func GetEnvironmentBackup 

func GetEnvironmentBackup(creds types.Keylink, output, subAliasOrHashedID, envNameOrHashedID, backupName, errorOutput string) (types.Backup, error)

func GetEnvironmentBackupIterations 

func GetEnvironmentBackupIterations(creds types.Keylink, output, subAliasOrHashedID, envNameOrHashedID, backupType string) ([]types.BackupIteration, error)

func GetEnvironmentCacheInvalidation 

func GetEnvironmentCacheInvalidation(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, invalidationName string) (types.CacheInvalidation, error)

func GetEnvironmentCacheInvalidations 

func GetEnvironmentCacheInvalidations(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string) ([]types.CacheInvalidation, error)

func GetEnvironmentContext 

func GetEnvironmentContext(creds types.Keylink, flg flags.Accumulator, subHashOrAlias string) (types.Environment, error)

func GetEnvironmentEnvVars 

func GetEnvironmentEnvVars(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string) ([]types.EnvVars, error)

func GetEnvironmentLogLabelValues added in v1.1.0 

func GetEnvironmentLogLabelValues(creds types.Keylink, subAliasOrHashedID, envNameOrHashedID, label string) ([]string, error)

func GetEnvironmentLogStreams 

func GetEnvironmentLogStreams(creds types.Keylink, subAliasOrHashedID, envNameOrHashedID string) ([]types.CWLogStreamsResponse, error)

func GetEnvironmentRestore 

func GetEnvironmentRestore(creds types.Keylink, output, subAliasOrHashedID, envNameOrHashedID, restoreName string) (types.RestoreRequest, error)

func GetEnvironmentRestoreIterations 

func GetEnvironmentRestoreIterations(creds types.Keylink, output, subAliasOrHashedID, envNameOrHashedID string) ([]types.RestoreRequest, error)

func GetLatestEnvironmentBackupIteration 

func GetLatestEnvironmentBackupIteration(creds types.Keylink, output, subAliasOrHashedID, envNameOrHashedID string) (types.BackupIteration, error)

func GetNankaiBaseURL 

func GetNankaiBaseURL() string

func GetRemoteCommand added in v1.3.0 

func GetRemoteCommand(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, rcni string) (*types.RemoteCommandResponse, error)

func GetRemoteCommands added in v1.3.0 

func GetRemoteCommands(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string) ([]types.RemoteCommandResponse, error)

func GetSubscription 

func GetSubscription(creds types.Keylink, output, hashOrAlias string) (types.Subscription, error)

func GetSubscriptionBackup 

func GetSubscriptionBackup(creds types.Keylink, output, subAliasOrHashedID, backupName, errorOutput string) (types.Backup, error)

func GetSubscriptionBackupIterations 

func GetSubscriptionBackupIterations(creds types.Keylink, output, subAliasOrHashedID, backupType string) ([]types.BackupIteration, error)

func GetSubscriptionContext 

func GetSubscriptionContext(creds types.Keylink, flg flags.Accumulator) (types.Subscription, error)

func GetSubscriptionEnvironment 

func GetSubscriptionEnvironment(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string) (types.Environment, error)

func GetSubscriptionEnvironmentContext 

func GetSubscriptionEnvironmentContext(creds types.Keylink, flg flags.Accumulator) (types.SubscriptionEnvironment, error)

func GetSubscriptionEnvironments 

func GetSubscriptionEnvironments(creds types.Keylink, output, hashOrAlias string) ([]types.Environment, error)

func GetSubscriptionRestoreIterations 

func GetSubscriptionRestoreIterations(creds types.Keylink, output, subAliasOrHashedID string) ([]types.RestoreRequest, error)

func GetSubscriptionSync 

func GetSubscriptionSync(creds types.Keylink, output string, subAliasOrHashedID, syncName string) (types.SyncRequest, error)

func GetSubscriptionSyncRequests 

func GetSubscriptionSyncRequests(creds types.Keylink, output string, subAliasOrHashedID string) ([]types.SyncRequest, error)

func GetUserSubscriptions 

func GetUserSubscriptions(creds types.Keylink, output string) ([]types.UserAccessResponse, error)

func PatchEnvironment 

func PatchEnvironment(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, restorePermission string) error

func PatchEnvironmentEnvVar 

func PatchEnvironmentEnvVar(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, key, value, varType string) error

func PostBackupRequest 

func PostBackupRequest(creds types.Keylink, output string, payload types.PostBackupRequestParams) (types.BackupRequest, error)

func PostEnvironmentCacheInvalidation 

func PostEnvironmentCacheInvalidation(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string) (types.CacheInvalidation, error)

func PostEnvironmentEnvVars 

func PostEnvironmentEnvVars(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, key, value, varType string) error

func PostEnvironmentHook 

func PostEnvironmentHook(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, hookName string) error

func PostRemoteCommandDrush added in v1.3.0 

func PostRemoteCommandDrush(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, args string, envVars []types.RemoteCommandEnvironmentVariable, timeout int) (*types.RemoteCommandResponse, error)

func PostRemoteCommandDrushCacheRebuild added in v1.3.0 

func PostRemoteCommandDrushCacheRebuild(creds types.Keylink, output, subHashOrAlias, envHashOrAlias string, envVars []types.RemoteCommandEnvironmentVariable, timeout int) (*types.RemoteCommandResponse, error)

func PostRemoteCommandShell added in v1.3.0 

func PostRemoteCommandShell(creds types.Keylink, output, subHashOrAlias, envHashOrAlias, workDir, command string, envVars []types.RemoteCommandEnvironmentVariable, timeout int) (*types.RemoteCommandResponse, error)

func PostRestoreRequest 

func PostRestoreRequest(creds types.Keylink, output string, payload types.PostRestoreRequestParams) (types.RestoreRequest, error)

func PostSyncRequest 

func PostSyncRequest(creds types.Keylink, output string, payload types.PostSyncRequestParams) (types.SyncRequest, error)

func PostSyncRequestUseLatestBackup 

func PostSyncRequestUseLatestBackup(creds types.Keylink, output string, payload types.PostSyncRequestParams) (types.RestoreRequest, error)

func PutNewRelicApplicationConfig 

func PutNewRelicApplicationConfig(creds types.Keylink, output, subId, envId string, payload types.PutNewRelicParams) error

func QueryEnvironmentLogs 

func QueryEnvironmentLogs(creds types.Keylink, subAliasOrHashedID, envNameOrHashedID string, payload map[string]interface{}) (*types.CustomerLogsResponse, error)

Types

type APIError 

type APIError struct {
	StatusCode    int    `json:"status_code,omitempty"`
	Result        string `json:"result,omitempty"`
	CallURL       string `json:"call_url,omitempty"`
	CallMethod    string `json:"call_method,omitempty"`
	IronstarCode  string `json:"ironstar_code,omitempty"`
	CorrelationId string `json:"correlation_id,omitempty"`
	Message       string `json:"message,omitempty"`
}

func (*APIError) Error 

func (err *APIError) Error(output string)

func (*APIError) ExternalError 

func (err *APIError) ExternalError()

type FailureBody 

type FailureBody struct {
	Message string `json:"message"`
	Code    string `json:"code"`
}

type RawResponse 

type RawResponse struct {
	StatusCode int         `json:"status_code,omitempty"`
	CallURL    string      `json:"call_url,omitempty"`
	CallMethod string      `json:"call_method,omitempty"`
	Header     http.Header `json:"header,omitempty"`
	Body       []byte      `json:"body,omitempty"`
}

func PostAcceptAPIUsageTerms 

func PostAcceptAPIUsageTerms(authToken string) (*RawResponse, error)

func UploadPackage 

func UploadPackage(creds types.Keylink, subHash, tarpath string, flg flags.Accumulator) (*RawResponse, error)

UploadPackage - Create a project tarball in tmp

func (*RawResponse) HandleExternalFailure 

func (res *RawResponse) HandleExternalFailure() error

func (*RawResponse) HandleFailure 

func (res *RawResponse) HandleFailure(output string) error

type Request 

type Request struct {
	RunTokenRefresh  bool
	Credentials      types.Keylink
	Method           string
	Path             string
	URL              string
	MapStringPayload map[string]interface{}
	BytePayload      []byte
	Retries          int
}

func (*Request) ArimaDownload 

func (r *Request) ArimaDownload(filepath, friendlyName string) (*RawResponse, error)

ArimaSend - Make a HTTP request to the Ironstar upload/download API (ARIMA)

func (*Request) ArimaSend 

func (r *Request) ArimaSend() (*RawResponse, error)

ArimaSend - Make a HTTP request to the Ironstar upload/download API (ARIMA)

func (*Request) BuildBytePayload 

func (r *Request) BuildBytePayload() error

func (*Request) HTTPSDownload 

func (r *Request) HTTPSDownload(filepath, friendlyName string) (*RawResponse, error)

func (*Request) HTTPSend 

func (r *Request) HTTPSend() (*RawResponse, error)

func (*Request) NankaiSend 

func (r *Request) NankaiSend() (*RawResponse, error)

NankaiSend - Make a HTTP request to the Ironstar API

type Stream 

type Stream struct {
	RunTokenRefresh bool
	Credentials     types.Keylink
	Method          string
	URL             string
	FilePath        string
	Payload         map[string]string
}

func (*Stream) Send 

func (s *Stream) Send() (*RawResponse, error)

Send - Make a HTTP request to the Ironstar API

type WriteCounter 

type WriteCounter struct {
	Total        uint64
	FriendlyName string
}

WriteCounter counts the number of bytes written to it. It implements to the io.Writer interface and we can pass this into io.TeeReader() which will report progress on each write cycle.

func (WriteCounter) PrintProgress 

func (wc WriteCounter) PrintProgress()

func (*WriteCounter) Write 

func (wc *WriteCounter) Write(p []byte) (int, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.