Documentation
¶
Overview ¶
package go-api-abrha is the Abrha API v2 client for Go.
Index ¶
- Constants
- func Bool(v bool) *booldeprecated
- func CIDRSourceFirewall(cidr string) string
- func CheckResponse(r *http.Response) error
- func DoRequest(ctx context.Context, req *http.Request) (*http.Response, error)
- func DoRequestWithClient(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)
- func ForEachAppSpecComponent[T any](s *AppSpec, fn func(component T) error) error
- func GetAppSpecComponent[T interface{ ... }](s *AppSpec, name string) (T, error)
- func IPSourceFirewall(ip string) string
- func Int(v int) *intdeprecated
- func PtrTo[T any](v T) *T
- func StreamToString(stream io.Reader) string
- func String(v string) *stringdeprecated
- func Stringify(message interface{}) string
- func ToURN(resourceType string, id interface{}) string
- type Account
- type AccountService
- type AccountServiceOp
- type Action
- type ActionRequest
- type ActionsService
- type ActionsServiceOp
- type Address
- type AlertDestinationUpdateRequest
- type AlertPolicy
- type AlertPolicyComp
- type AlertPolicyCreateRequest
- type AlertPolicyUpdateRequest
- type Alerts
- type App
- func (a *App) GetActiveDeployment() *Deployment
- func (a *App) GetBuildConfig() *AppBuildConfig
- func (a *App) GetCreatedAt() time.Time
- func (a *App) GetDedicatedIps() []*AppDedicatedIp
- func (a *App) GetDefaultIngress() string
- func (a *App) GetDomains() []*AppDomain
- func (a *App) GetID() string
- func (a *App) GetInProgressDeployment() *Deployment
- func (a *App) GetLastDeploymentActiveAt() time.Time
- func (a *App) GetLastDeploymentCreatedAt() time.Time
- func (a *App) GetLiveDomain() string
- func (a *App) GetLiveURL() string
- func (a *App) GetLiveURLBase() string
- func (a *App) GetOwnerUUID() string
- func (a *App) GetPendingDeployment() *Deployment
- func (a *App) GetPinnedDeployment() *Deployment
- func (a *App) GetProjectID() string
- func (a *App) GetRegion() *AppRegion
- func (a *App) GetSpec() *AppSpec
- func (a *App) GetTierSlug() string
- func (a *App) GetUpdatedAt() time.Time
- func (a App) URN() string
- type AppAlert
- func (a *AppAlert) GetComponentName() string
- func (a *AppAlert) GetEmails() []string
- func (a *AppAlert) GetID() string
- func (a *AppAlert) GetPhase() AppAlertPhase
- func (a *AppAlert) GetProgress() *AppAlertProgress
- func (a *AppAlert) GetSlackWebhooks() []*AppAlertSlackWebhook
- func (a *AppAlert) GetSpec() *AppAlertSpec
- type AppAlertPhase
- type AppAlertProgress
- type AppAlertProgressStep
- func (a *AppAlertProgressStep) GetEndedAt() time.Time
- func (a *AppAlertProgressStep) GetName() string
- func (a *AppAlertProgressStep) GetReason() *AppAlertProgressStepReason
- func (a *AppAlertProgressStep) GetStartedAt() time.Time
- func (a *AppAlertProgressStep) GetStatus() AppAlertProgressStepStatus
- func (a *AppAlertProgressStep) GetSteps() []*AppAlertProgressStep
- type AppAlertProgressStepReason
- type AppAlertProgressStepStatus
- type AppAlertSlackWebhook
- type AppAlertSpec
- type AppAlertSpecOperator
- type AppAlertSpecRule
- type AppAlertSpecWindow
- type AppAutoscalingSpec
- type AppAutoscalingSpecMetricCPU
- type AppAutoscalingSpecMetrics
- type AppBuildConfig
- type AppBuildConfigCNBVersioning
- type AppBuildableComponentSpec
- type AppCNBBuildableComponentSpec
- type AppCORSPolicy
- func (a *AppCORSPolicy) GetAllowCredentials() bool
- func (a *AppCORSPolicy) GetAllowHeaders() []string
- func (a *AppCORSPolicy) GetAllowMethods() []string
- func (a *AppCORSPolicy) GetAllowOrigins() []*AppStringMatch
- func (a *AppCORSPolicy) GetExposeHeaders() []string
- func (a *AppCORSPolicy) GetMaxAge() string
- type AppComponentSpec
- type AppComponentType
- type AppContainerComponentSpec
- type AppCreateRequest
- type AppDatabaseSpec
- func (a *AppDatabaseSpec) GetClusterName() string
- func (a *AppDatabaseSpec) GetDBName() string
- func (a *AppDatabaseSpec) GetDBUser() string
- func (a *AppDatabaseSpec) GetEngine() AppDatabaseSpecEngine
- func (a *AppDatabaseSpec) GetName() string
- func (a *AppDatabaseSpec) GetNumNodes() int64
- func (a *AppDatabaseSpec) GetProduction() bool
- func (a *AppDatabaseSpec) GetSize() string
- func (s *AppDatabaseSpec) GetType() AppComponentType
- func (a *AppDatabaseSpec) GetVersion() string
- type AppDatabaseSpecEngine
- type AppDedicatedIp
- type AppDedicatedIpStatus
- type AppDockerBuildableComponentSpec
- type AppDomain
- func (a *AppDomain) GetCertificateExpiresAt() time.Time
- func (a *AppDomain) GetID() string
- func (a *AppDomain) GetPhase() AppDomainPhase
- func (a *AppDomain) GetProgress() *AppDomainProgress
- func (a *AppDomain) GetRotateValidationRecords() bool
- func (a *AppDomain) GetSpec() *AppDomainSpec
- func (a *AppDomain) GetValidation() *AppDomainValidation
- func (a *AppDomain) GetValidations() []*AppDomainValidation
- type AppDomainPhase
- type AppDomainProgress
- type AppDomainProgressStep
- func (a *AppDomainProgressStep) GetEndedAt() time.Time
- func (a *AppDomainProgressStep) GetName() string
- func (a *AppDomainProgressStep) GetReason() *AppDomainProgressStepReason
- func (a *AppDomainProgressStep) GetStartedAt() time.Time
- func (a *AppDomainProgressStep) GetStatus() AppDomainProgressStepStatus
- func (a *AppDomainProgressStep) GetSteps() []*AppDomainProgressStep
- type AppDomainProgressStepReason
- type AppDomainProgressStepStatus
- type AppDomainSpec
- type AppDomainSpecType
- type AppDomainValidation
- type AppEgressSpec
- type AppEgressSpecType
- type AppExec
- type AppFunctionsSpec
- func (a *AppFunctionsSpec) GetAlerts() []*AppAlertSpec
- func (a *AppFunctionsSpec) GetBitbucket() *BitbucketSourceSpec
- func (a *AppFunctionsSpec) GetCORS() *AppCORSPolicy
- func (a *AppFunctionsSpec) GetEnvs() []*AppVariableDefinition
- func (a *AppFunctionsSpec) GetGit() *GitSourceSpec
- func (a *AppFunctionsSpec) GetGitHub() *GitHubSourceSpec
- func (a *AppFunctionsSpec) GetGitLab() *GitLabSourceSpec
- func (a *AppFunctionsSpec) GetLogDestinations() []*AppLogDestinationSpec
- func (a *AppFunctionsSpec) GetName() string
- func (a *AppFunctionsSpec) GetRoutes() []*AppRouteSpec
- func (a *AppFunctionsSpec) GetSourceDir() string
- func (s *AppFunctionsSpec) GetType() AppComponentType
- type AppIngressSpec
- type AppIngressSpecLoadBalancer
- type AppIngressSpecRule
- type AppIngressSpecRuleMatch
- type AppIngressSpecRuleRoutingComponent
- type AppIngressSpecRuleRoutingRedirect
- func (a *AppIngressSpecRuleRoutingRedirect) GetAuthority() string
- func (a *AppIngressSpecRuleRoutingRedirect) GetPort() int64
- func (a *AppIngressSpecRuleRoutingRedirect) GetRedirectCode() int64
- func (a *AppIngressSpecRuleRoutingRedirect) GetScheme() string
- func (a *AppIngressSpecRuleRoutingRedirect) GetUri() string
- type AppIngressSpecRuleStringMatch
- type AppInstanceSize
- func (a *AppInstanceSize) GetBandwidthAllowanceGib() string
- func (a *AppInstanceSize) GetCPUType() AppInstanceSizeCPUType
- func (a *AppInstanceSize) GetCPUs() string
- func (a *AppInstanceSize) GetDeprecationIntent() bool
- func (a *AppInstanceSize) GetFeaturePreview() bool
- func (a *AppInstanceSize) GetMemoryBytes() string
- func (a *AppInstanceSize) GetName() string
- func (a *AppInstanceSize) GetScalable() bool
- func (a *AppInstanceSize) GetSingleInstanceOnly() bool
- func (a *AppInstanceSize) GetSlug() string
- func (a *AppInstanceSize) GetTierDowngradeTo() string
- func (a *AppInstanceSize) GetTierSlug() string
- func (a *AppInstanceSize) GetTierUpgradeTo() string
- func (a *AppInstanceSize) GetUSDPerMonth() string
- func (a *AppInstanceSize) GetUSDPerSecond() string
- type AppInstanceSizeCPUType
- type AppJobSpec
- func (a *AppJobSpec) GetAlerts() []*AppAlertSpec
- func (a *AppJobSpec) GetBitbucket() *BitbucketSourceSpec
- func (a *AppJobSpec) GetBuildCommand() string
- func (a *AppJobSpec) GetDockerfilePath() string
- func (a *AppJobSpec) GetEnvironmentSlug() string
- func (a *AppJobSpec) GetEnvs() []*AppVariableDefinition
- func (a *AppJobSpec) GetGit() *GitSourceSpec
- func (a *AppJobSpec) GetGitHub() *GitHubSourceSpec
- func (a *AppJobSpec) GetGitLab() *GitLabSourceSpec
- func (a *AppJobSpec) GetImage() *ImageSourceSpec
- func (a *AppJobSpec) GetInstanceCount() int64
- func (a *AppJobSpec) GetInstanceSizeSlug() string
- func (a *AppJobSpec) GetKind() AppJobSpecKind
- func (a *AppJobSpec) GetLogDestinations() []*AppLogDestinationSpec
- func (a *AppJobSpec) GetName() string
- func (a *AppJobSpec) GetRunCommand() string
- func (a *AppJobSpec) GetSourceDir() string
- func (a *AppJobSpec) GetTermination() *AppJobSpecTermination
- func (s *AppJobSpec) GetType() AppComponentType
- type AppJobSpecKind
- type AppJobSpecTermination
- type AppLogDestinationSpec
- func (a *AppLogDestinationSpec) GetDatadog() *AppLogDestinationSpecDataDog
- func (a *AppLogDestinationSpec) GetEndpoint() string
- func (a *AppLogDestinationSpec) GetHeaders() []*AppLogDestinationSpecHeader
- func (a *AppLogDestinationSpec) GetLogtail() *AppLogDestinationSpecLogtail
- func (a *AppLogDestinationSpec) GetName() string
- func (a *AppLogDestinationSpec) GetOpenSearch() *AppLogDestinationSpecOpenSearch
- func (a *AppLogDestinationSpec) GetPapertrail() *AppLogDestinationSpecPapertrail
- func (a *AppLogDestinationSpec) GetTLSInsecure() bool
- type AppLogDestinationSpecDataDog
- type AppLogDestinationSpecHeader
- type AppLogDestinationSpecLogtail
- type AppLogDestinationSpecOpenSearch
- type AppLogDestinationSpecPapertrail
- type AppLogType
- type AppLogs
- type AppMaintenanceSpec
- type AppProposeRequest
- type AppProposeResponse
- func (a *AppProposeResponse) GetAppCost() float32
- func (a *AppProposeResponse) GetAppIsStarter() bool
- func (a *AppProposeResponse) GetAppIsStatic() bool
- func (a *AppProposeResponse) GetAppNameAvailable() bool
- func (a *AppProposeResponse) GetAppNameSuggestion() string
- func (a *AppProposeResponse) GetAppTierDowngradeCost() float32
- func (a *AppProposeResponse) GetAppTierUpgradeCost() float32
- func (a *AppProposeResponse) GetExistingStarterApps() string
- func (a *AppProposeResponse) GetExistingStaticApps() string
- func (a *AppProposeResponse) GetMaxFreeStarterApps() string
- func (a *AppProposeResponse) GetMaxFreeStaticApps() string
- func (a *AppProposeResponse) GetSpec() *AppSpec
- type AppRegion
- func (a *AppRegion) GetContinent() string
- func (a *AppRegion) GetDataCenters() []string
- func (a *AppRegion) GetDefault() bool
- func (a *AppRegion) GetDisabled() bool
- func (a *AppRegion) GetFlag() string
- func (a *AppRegion) GetLabel() string
- func (a *AppRegion) GetReason() string
- func (a *AppRegion) GetSlug() string
- type AppRestartRequest
- type AppRoutableComponentSpec
- type AppRouteSpec
- type AppServiceSpec
- func (a *AppServiceSpec) GetAlerts() []*AppAlertSpec
- func (a *AppServiceSpec) GetAutoscaling() *AppAutoscalingSpec
- func (a *AppServiceSpec) GetBitbucket() *BitbucketSourceSpec
- func (a *AppServiceSpec) GetBuildCommand() string
- func (a *AppServiceSpec) GetCORS() *AppCORSPolicy
- func (a *AppServiceSpec) GetDockerfilePath() string
- func (a *AppServiceSpec) GetEnvironmentSlug() string
- func (a *AppServiceSpec) GetEnvs() []*AppVariableDefinition
- func (a *AppServiceSpec) GetGit() *GitSourceSpec
- func (a *AppServiceSpec) GetGitHub() *GitHubSourceSpec
- func (a *AppServiceSpec) GetGitLab() *GitLabSourceSpec
- func (a *AppServiceSpec) GetHTTPPort() int64
- func (a *AppServiceSpec) GetHealthCheck() *AppServiceSpecHealthCheck
- func (a *AppServiceSpec) GetImage() *ImageSourceSpec
- func (a *AppServiceSpec) GetInstanceCount() int64
- func (a *AppServiceSpec) GetInstanceSizeSlug() string
- func (a *AppServiceSpec) GetInternalPorts() []int64
- func (a *AppServiceSpec) GetLogDestinations() []*AppLogDestinationSpec
- func (a *AppServiceSpec) GetName() string
- func (a *AppServiceSpec) GetProtocol() ServingProtocol
- func (a *AppServiceSpec) GetRoutes() []*AppRouteSpec
- func (a *AppServiceSpec) GetRunCommand() string
- func (a *AppServiceSpec) GetSourceDir() string
- func (a *AppServiceSpec) GetTermination() *AppServiceSpecTermination
- func (s *AppServiceSpec) GetType() AppComponentType
- type AppServiceSpecHealthCheck
- func (a *AppServiceSpecHealthCheck) GetFailureThreshold() int32
- func (a *AppServiceSpecHealthCheck) GetHTTPPath() string
- func (a *AppServiceSpecHealthCheck) GetInitialDelaySeconds() int32
- func (a *AppServiceSpecHealthCheck) GetPath() string
- func (a *AppServiceSpecHealthCheck) GetPeriodSeconds() int32
- func (a *AppServiceSpecHealthCheck) GetPort() int64
- func (a *AppServiceSpecHealthCheck) GetSuccessThreshold() int32
- func (a *AppServiceSpecHealthCheck) GetTimeoutSeconds() int32
- type AppServiceSpecTermination
- type AppSourceType
- type AppSpec
- func (s *AppSpec) ForEachAppComponentSpec(fn func(component AppComponentSpec) error) error
- func (a *AppSpec) GetAlerts() []*AppAlertSpec
- func (a *AppSpec) GetDatabases() []*AppDatabaseSpec
- func (a *AppSpec) GetDomains() []*AppDomainSpec
- func (a *AppSpec) GetEgress() *AppEgressSpec
- func (a *AppSpec) GetEnvs() []*AppVariableDefinition
- func (a *AppSpec) GetFeatures() []string
- func (a *AppSpec) GetFunctions() []*AppFunctionsSpec
- func (a *AppSpec) GetIngress() *AppIngressSpec
- func (a *AppSpec) GetJobs() []*AppJobSpec
- func (a *AppSpec) GetMaintenance() *AppMaintenanceSpec
- func (a *AppSpec) GetName() string
- func (a *AppSpec) GetRegion() string
- func (a *AppSpec) GetServices() []*AppServiceSpec
- func (a *AppSpec) GetStaticSites() []*AppStaticSiteSpec
- func (a *AppSpec) GetWorkers() []*AppWorkerSpec
- type AppStaticSiteSpec
- func (a *AppStaticSiteSpec) GetBitbucket() *BitbucketSourceSpec
- func (a *AppStaticSiteSpec) GetBuildCommand() string
- func (a *AppStaticSiteSpec) GetCORS() *AppCORSPolicy
- func (a *AppStaticSiteSpec) GetCatchallDocument() string
- func (a *AppStaticSiteSpec) GetDockerfilePath() string
- func (a *AppStaticSiteSpec) GetEnvironmentSlug() string
- func (a *AppStaticSiteSpec) GetEnvs() []*AppVariableDefinition
- func (a *AppStaticSiteSpec) GetErrorDocument() string
- func (a *AppStaticSiteSpec) GetGit() *GitSourceSpec
- func (a *AppStaticSiteSpec) GetGitHub() *GitHubSourceSpec
- func (a *AppStaticSiteSpec) GetGitLab() *GitLabSourceSpec
- func (a *AppStaticSiteSpec) GetIndexDocument() string
- func (a *AppStaticSiteSpec) GetName() string
- func (a *AppStaticSiteSpec) GetOutputDir() string
- func (a *AppStaticSiteSpec) GetRoutes() []*AppRouteSpec
- func (a *AppStaticSiteSpec) GetSourceDir() string
- func (s *AppStaticSiteSpec) GetType() AppComponentType
- type AppStringMatch
- type AppTier
- type AppUpdateRequest
- type AppVariableDefinition
- type AppVariableScope
- type AppVariableType
- type AppWorkerSpec
- func (a *AppWorkerSpec) GetAlerts() []*AppAlertSpec
- func (a *AppWorkerSpec) GetAutoscaling() *AppAutoscalingSpec
- func (a *AppWorkerSpec) GetBitbucket() *BitbucketSourceSpec
- func (a *AppWorkerSpec) GetBuildCommand() string
- func (a *AppWorkerSpec) GetDockerfilePath() string
- func (a *AppWorkerSpec) GetEnvironmentSlug() string
- func (a *AppWorkerSpec) GetEnvs() []*AppVariableDefinition
- func (a *AppWorkerSpec) GetGit() *GitSourceSpec
- func (a *AppWorkerSpec) GetGitHub() *GitHubSourceSpec
- func (a *AppWorkerSpec) GetGitLab() *GitLabSourceSpec
- func (a *AppWorkerSpec) GetImage() *ImageSourceSpec
- func (a *AppWorkerSpec) GetInstanceCount() int64
- func (a *AppWorkerSpec) GetInstanceSizeSlug() string
- func (a *AppWorkerSpec) GetLogDestinations() []*AppLogDestinationSpec
- func (a *AppWorkerSpec) GetName() string
- func (a *AppWorkerSpec) GetRunCommand() string
- func (a *AppWorkerSpec) GetSourceDir() string
- func (a *AppWorkerSpec) GetTermination() *AppWorkerSpecTermination
- func (s *AppWorkerSpec) GetType() AppComponentType
- type AppWorkerSpecTermination
- type AppsService
- type AppsServiceOp
- func (s *AppsServiceOp) Create(ctx context.Context, create *AppCreateRequest) (*App, *Response, error)
- func (s *AppsServiceOp) CreateDeployment(ctx context.Context, appID string, create ...*DeploymentCreateRequest) (*Deployment, *Response, error)
- func (s *AppsServiceOp) Delete(ctx context.Context, appID string) (*Response, error)
- func (s *AppsServiceOp) Detect(ctx context.Context, detect *DetectRequest) (*DetectResponse, *Response, error)
- func (s *AppsServiceOp) Get(ctx context.Context, appID string) (*App, *Response, error)
- func (s *AppsServiceOp) GetAppDatabaseConnectionDetails(ctx context.Context, appID string) ([]*GetDatabaseConnectionDetailsResponse, *Response, error)
- func (s *AppsServiceOp) GetDeployment(ctx context.Context, appID, deploymentID string) (*Deployment, *Response, error)
- func (s *AppsServiceOp) GetExec(ctx context.Context, appID, deploymentID, component string) (*AppExec, *Response, error)
- func (s *AppsServiceOp) GetInstanceSize(ctx context.Context, slug string) (*AppInstanceSize, *Response, error)
- func (s *AppsServiceOp) GetLogs(ctx context.Context, appID, deploymentID, component string, logType AppLogType, ...) (*AppLogs, *Response, error)
- func (s *AppsServiceOp) GetTier(ctx context.Context, slug string) (*AppTier, *Response, error)deprecated
- func (s *AppsServiceOp) List(ctx context.Context, opts *ListOptions) ([]*App, *Response, error)
- func (s *AppsServiceOp) ListAlerts(ctx context.Context, appID string) ([]*AppAlert, *Response, error)
- func (s *AppsServiceOp) ListBuildpacks(ctx context.Context) ([]*Buildpack, *Response, error)
- func (s *AppsServiceOp) ListDeployments(ctx context.Context, appID string, opts *ListOptions) ([]*Deployment, *Response, error)
- func (s *AppsServiceOp) ListInstanceSizes(ctx context.Context) ([]*AppInstanceSize, *Response, error)
- func (s *AppsServiceOp) ListRegions(ctx context.Context) ([]*AppRegion, *Response, error)
- func (s *AppsServiceOp) ListTiers(ctx context.Context) ([]*AppTier, *Response, error)deprecated
- func (s *AppsServiceOp) Propose(ctx context.Context, propose *AppProposeRequest) (*AppProposeResponse, *Response, error)
- func (s *AppsServiceOp) ResetDatabasePassword(ctx context.Context, appID string, component string) (*Deployment, *Response, error)
- func (s *AppsServiceOp) Restart(ctx context.Context, appID string, opts *AppRestartRequest) (*Deployment, *Response, error)
- func (s *AppsServiceOp) ToggleDatabaseTrustedSource(ctx context.Context, appID string, component string, ...) (*ToggleDatabaseTrustedSourceResponse, *Response, error)
- func (s *AppsServiceOp) Update(ctx context.Context, appID string, update *AppUpdateRequest) (*App, *Response, error)
- func (s *AppsServiceOp) UpdateAlertDestinations(ctx context.Context, appID, alertID string, ...) (*AppAlert, *Response, error)
- func (s *AppsServiceOp) UpgradeBuildpack(ctx context.Context, appID string, opts UpgradeBuildpackOptions) (*UpgradeBuildpackResponse, *Response, error)
- type ArgError
- type AssociatedResource
- type BackupWindow
- type Balance
- type BalanceService
- type BalanceServiceOp
- type BillingHistory
- type BillingHistoryEntry
- type BillingHistoryService
- type BillingHistoryServiceOp
- type BitbucketSourceSpec
- type Blob
- type Buildpack
- type CDN
- type CDNCreateRequest
- type CDNFlushCacheRequest
- type CDNService
- type CDNServiceOp
- func (c CDNServiceOp) Create(ctx context.Context, createRequest *CDNCreateRequest) (*CDN, *Response, error)
- func (c CDNServiceOp) Delete(ctx context.Context, id string) (*Response, error)
- func (c CDNServiceOp) FlushCache(ctx context.Context, id string, flushCacheRequest *CDNFlushCacheRequest) (*Response, error)
- func (c CDNServiceOp) Get(ctx context.Context, id string) (*CDN, *Response, error)
- func (c CDNServiceOp) List(ctx context.Context, opt *ListOptions) ([]CDN, *Response, error)
- func (c CDNServiceOp) UpdateCustomDomain(ctx context.Context, id string, updateRequest *CDNUpdateCustomDomainRequest) (*CDN, *Response, error)
- func (c CDNServiceOp) UpdateTTL(ctx context.Context, id string, updateRequest *CDNUpdateTTLRequest) (*CDN, *Response, error)
- type CDNSettings
- type CDNUpdateCustomDomainRequest
- type CDNUpdateTTLRequest
- type Certificate
- type CertificateRequest
- type CertificatesService
- type CertificatesServiceOp
- func (c *CertificatesServiceOp) Create(ctx context.Context, cr *CertificateRequest) (*Certificate, *Response, error)
- func (c *CertificatesServiceOp) Delete(ctx context.Context, cID string) (*Response, error)
- func (c *CertificatesServiceOp) Get(ctx context.Context, cID string) (*Certificate, *Response, error)
- func (c *CertificatesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Certificate, *Response, error)
- func (c *CertificatesServiceOp) ListByName(ctx context.Context, name string, opt *ListOptions) ([]Certificate, *Response, error)
- type Client
- func (c *Client) Do(ctx context.Context, req *http.Request, v interface{}) (*Response, error)
- func (c *Client) GetRate() Rate
- func (c *Client) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)
- func (c *Client) OnRequestCompleted(rc RequestCompletionCallback)
- type ClientOpt
- type ClusterlintDiagnostic
- type ClusterlintObject
- type ClusterlintOwner
- type CreateProjectRequest
- type CreateUptimeAlertRequest
- type CreateUptimeCheckRequest
- type CustomImageCreateRequest
- type Database
- type DatabaseBackup
- type DatabaseBackupRestore
- type DatabaseCA
- type DatabaseConnection
- type DatabaseCreateDBRequest
- type DatabaseCreateFirewallRule
- type DatabaseCreateLogsinkRequest
- type DatabaseCreatePoolRequest
- type DatabaseCreateReplicaRequest
- type DatabaseCreateRequest
- type DatabaseCreateTopicRequest
- type DatabaseCreateUserRequest
- type DatabaseDB
- type DatabaseEngineOptions
- type DatabaseEvent
- type DatabaseFirewallRule
- type DatabaseIndex
- type DatabaseLayout
- type DatabaseLogsink
- type DatabaseLogsinkConfig
- type DatabaseMaintenanceWindow
- type DatabaseMetricsCredentials
- type DatabaseMigrateRequest
- type DatabaseMySQLUserSettings
- type DatabaseOptions
- type DatabasePool
- type DatabaseReplica
- type DatabaseResetUserAuthRequest
- type DatabaseResizeRequest
- type DatabaseTopic
- type DatabaseUpdateFirewallRulesRequest
- type DatabaseUpdateLogsinkRequest
- type DatabaseUpdateMaintenanceRequest
- type DatabaseUpdateMetricsCredentialsRequest
- type DatabaseUpdatePoolRequest
- type DatabaseUpdateTopicRequest
- type DatabaseUpdateUserRequest
- type DatabaseUser
- type DatabaseUserSettings
- type DatabasesService
- type DatabasesServiceOp
- func (svc *DatabasesServiceOp) Create(ctx context.Context, create *DatabaseCreateRequest) (*Database, *Response, error)
- func (svc *DatabasesServiceOp) CreateDB(ctx context.Context, databaseID string, createDB *DatabaseCreateDBRequest) (*DatabaseDB, *Response, error)
- func (svc *DatabasesServiceOp) CreateLogsink(ctx context.Context, databaseID string, ...) (*DatabaseLogsink, *Response, error)
- func (svc *DatabasesServiceOp) CreatePool(ctx context.Context, databaseID string, createPool *DatabaseCreatePoolRequest) (*DatabasePool, *Response, error)
- func (svc *DatabasesServiceOp) CreateReplica(ctx context.Context, databaseID string, ...) (*DatabaseReplica, *Response, error)
- func (svc *DatabasesServiceOp) CreateTopic(ctx context.Context, databaseID string, ...) (*DatabaseTopic, *Response, error)
- func (svc *DatabasesServiceOp) CreateUser(ctx context.Context, databaseID string, createUser *DatabaseCreateUserRequest) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) Delete(ctx context.Context, databaseID string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteDB(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteIndex(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteLogsink(ctx context.Context, databaseID, logsinkID string) (*Response, error)
- func (svc *DatabasesServiceOp) DeletePool(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteReplica(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteTopic(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) DeleteUser(ctx context.Context, databaseID, userID string) (*Response, error)
- func (svc *DatabasesServiceOp) Get(ctx context.Context, databaseID string) (*Database, *Response, error)
- func (svc *DatabasesServiceOp) GetCA(ctx context.Context, databaseID string) (*DatabaseCA, *Response, error)
- func (svc *DatabasesServiceOp) GetDB(ctx context.Context, databaseID, name string) (*DatabaseDB, *Response, error)
- func (svc *DatabasesServiceOp) GetEvictionPolicy(ctx context.Context, databaseID string) (string, *Response, error)
- func (svc *DatabasesServiceOp) GetFirewallRules(ctx context.Context, databaseID string) ([]DatabaseFirewallRule, *Response, error)
- func (svc *DatabasesServiceOp) GetKafkaConfig(ctx context.Context, databaseID string) (*KafkaConfig, *Response, error)
- func (svc *DatabasesServiceOp) GetLogsink(ctx context.Context, databaseID string, logsinkID string) (*DatabaseLogsink, *Response, error)
- func (svc *DatabasesServiceOp) GetMetricsCredentials(ctx context.Context) (*DatabaseMetricsCredentials, *Response, error)
- func (svc *DatabasesServiceOp) GetMongoDBConfig(ctx context.Context, databaseID string) (*MongoDBConfig, *Response, error)
- func (svc *DatabasesServiceOp) GetMySQLConfig(ctx context.Context, databaseID string) (*MySQLConfig, *Response, error)
- func (svc *DatabasesServiceOp) GetOpensearchConfig(ctx context.Context, databaseID string) (*OpensearchConfig, *Response, error)
- func (svc *DatabasesServiceOp) GetPool(ctx context.Context, databaseID, name string) (*DatabasePool, *Response, error)
- func (svc *DatabasesServiceOp) GetPostgreSQLConfig(ctx context.Context, databaseID string) (*PostgreSQLConfig, *Response, error)
- func (svc *DatabasesServiceOp) GetRedisConfig(ctx context.Context, databaseID string) (*RedisConfig, *Response, error)
- func (svc *DatabasesServiceOp) GetReplica(ctx context.Context, databaseID, name string) (*DatabaseReplica, *Response, error)
- func (svc *DatabasesServiceOp) GetSQLMode(ctx context.Context, databaseID string) (string, *Response, error)
- func (svc *DatabasesServiceOp) GetTopic(ctx context.Context, databaseID, name string) (*DatabaseTopic, *Response, error)
- func (svc *DatabasesServiceOp) GetUser(ctx context.Context, databaseID, userID string) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) InstallUpdate(ctx context.Context, databaseID string) (*Response, error)
- func (svc *DatabasesServiceOp) List(ctx context.Context, opts *ListOptions) ([]Database, *Response, error)
- func (svc *DatabasesServiceOp) ListBackups(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseBackup, *Response, error)
- func (svc *DatabasesServiceOp) ListDBs(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseDB, *Response, error)
- func (svc *DatabasesServiceOp) ListDatabaseEvents(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseEvent, *Response, error)
- func (svc *DatabasesServiceOp) ListIndexes(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseIndex, *Response, error)
- func (svc *DatabasesServiceOp) ListLogsinks(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseLogsink, *Response, error)
- func (svc *DatabasesServiceOp) ListOptions(ctx context.Context) (*DatabaseOptions, *Response, error)
- func (svc *DatabasesServiceOp) ListPools(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabasePool, *Response, error)
- func (svc *DatabasesServiceOp) ListReplicas(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseReplica, *Response, error)
- func (svc *DatabasesServiceOp) ListTopics(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseTopic, *Response, error)
- func (svc *DatabasesServiceOp) ListUsers(ctx context.Context, databaseID string, opts *ListOptions) ([]DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) Migrate(ctx context.Context, databaseID string, migrate *DatabaseMigrateRequest) (*Response, error)
- func (svc *DatabasesServiceOp) PromoteReplicaToPrimary(ctx context.Context, databaseID, name string) (*Response, error)
- func (svc *DatabasesServiceOp) ResetUserAuth(ctx context.Context, databaseID, userID string, ...) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) Resize(ctx context.Context, databaseID string, resize *DatabaseResizeRequest) (*Response, error)
- func (svc *DatabasesServiceOp) SetEvictionPolicy(ctx context.Context, databaseID, policy string) (*Response, error)
- func (svc *DatabasesServiceOp) SetSQLMode(ctx context.Context, databaseID string, sqlModes ...string) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateFirewallRules(ctx context.Context, databaseID string, ...) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateKafkaConfig(ctx context.Context, databaseID string, config *KafkaConfig) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateLogsink(ctx context.Context, databaseID string, logsinkID string, ...) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateMaintenance(ctx context.Context, databaseID string, ...) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateMetricsCredentials(ctx context.Context, updateCreds *DatabaseUpdateMetricsCredentialsRequest) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateMongoDBConfig(ctx context.Context, databaseID string, config *MongoDBConfig) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateMySQLConfig(ctx context.Context, databaseID string, config *MySQLConfig) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateOpensearchConfig(ctx context.Context, databaseID string, config *OpensearchConfig) (*Response, error)
- func (svc *DatabasesServiceOp) UpdatePool(ctx context.Context, databaseID, name string, ...) (*Response, error)
- func (svc *DatabasesServiceOp) UpdatePostgreSQLConfig(ctx context.Context, databaseID string, config *PostgreSQLConfig) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateRedisConfig(ctx context.Context, databaseID string, config *RedisConfig) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateTopic(ctx context.Context, databaseID string, name string, ...) (*Response, error)
- func (svc *DatabasesServiceOp) UpdateUser(ctx context.Context, databaseID, userID string, ...) (*DatabaseUser, *Response, error)
- func (svc *DatabasesServiceOp) UpgradeMajorVersion(ctx context.Context, databaseID string, upgradeReq *UpgradeVersionRequest) (*Response, error)
- type DeployTemplate
- type Deployment
- func (d *Deployment) GetCause() string
- func (d *Deployment) GetCauseDetails() *DeploymentCauseDetails
- func (d *Deployment) GetClonedFrom() string
- func (d *Deployment) GetCreatedAt() time.Time
- func (d *Deployment) GetFunctions() []*DeploymentFunctions
- func (d *Deployment) GetID() string
- func (d *Deployment) GetJobs() []*DeploymentJob
- func (d *Deployment) GetLoadBalancerID() string
- func (d *Deployment) GetPhase() DeploymentPhase
- func (d *Deployment) GetPhaseLastUpdatedAt() time.Time
- func (d *Deployment) GetPreviousDeploymentID() string
- func (d *Deployment) GetProgress() *DeploymentProgress
- func (d *Deployment) GetServices() []*DeploymentService
- func (d *Deployment) GetSpec() *AppSpec
- func (d *Deployment) GetStaticSites() []*DeploymentStaticSite
- func (d *Deployment) GetTierSlug() string
- func (d *Deployment) GetTiming() *DeploymentTiming
- func (d *Deployment) GetUpdatedAt() time.Time
- func (d *Deployment) GetWorkers() []*DeploymentWorker
- type DeploymentCauseDetails
- func (d *DeploymentCauseDetails) GetAbrhaUserAction() *DeploymentCauseDetailsAbrhaUserAction
- func (d *DeploymentCauseDetails) GetAutoscaler() *DeploymentCauseDetailsAutoscalerAction
- func (d *DeploymentCauseDetails) GetDOCRPush() *DeploymentCauseDetailsDOCRPush
- func (d *DeploymentCauseDetails) GetGitPush() *DeploymentCauseDetailsGitPush
- func (d *DeploymentCauseDetails) GetInternal() bool
- func (d *DeploymentCauseDetails) GetType() DeploymentCauseDetailsType
- type DeploymentCauseDetailsAbrhaUser
- type DeploymentCauseDetailsAbrhaUserAction
- type DeploymentCauseDetailsAbrhaUserActionName
- type DeploymentCauseDetailsAutoscalerAction
- type DeploymentCauseDetailsDOCRPush
- type DeploymentCauseDetailsGitPush
- func (d *DeploymentCauseDetailsGitPush) GetBitbucket() *BitbucketSourceSpec
- func (d *DeploymentCauseDetailsGitPush) GetCommitAuthor() string
- func (d *DeploymentCauseDetailsGitPush) GetCommitMessage() string
- func (d *DeploymentCauseDetailsGitPush) GetCommitSHA() string
- func (d *DeploymentCauseDetailsGitPush) GetGitHub() *GitHubSourceSpec
- func (d *DeploymentCauseDetailsGitPush) GetGitLab() *GitLabSourceSpec
- func (d *DeploymentCauseDetailsGitPush) GetUsername() string
- type DeploymentCauseDetailsType
- type DeploymentCreateRequest
- type DeploymentFunctions
- type DeploymentJob
- type DeploymentPhase
- type DeploymentProgress
- func (d *DeploymentProgress) GetErrorSteps() int32
- func (d *DeploymentProgress) GetPendingSteps() int32
- func (d *DeploymentProgress) GetRunningSteps() int32
- func (d *DeploymentProgress) GetSteps() []*DeploymentProgressStep
- func (d *DeploymentProgress) GetSuccessSteps() int32
- func (d *DeploymentProgress) GetSummarySteps() []*DeploymentProgressStep
- func (d *DeploymentProgress) GetTotalSteps() int32
- type DeploymentProgressStep
- func (d *DeploymentProgressStep) GetComponentName() string
- func (d *DeploymentProgressStep) GetEndedAt() time.Time
- func (d *DeploymentProgressStep) GetMessageBase() string
- func (d *DeploymentProgressStep) GetName() string
- func (d *DeploymentProgressStep) GetReason() *DeploymentProgressStepReason
- func (d *DeploymentProgressStep) GetStartedAt() time.Time
- func (d *DeploymentProgressStep) GetStatus() DeploymentProgressStepStatus
- func (d *DeploymentProgressStep) GetSteps() []*DeploymentProgressStep
- type DeploymentProgressStepReason
- type DeploymentProgressStepStatus
- type DeploymentService
- type DeploymentStaticSite
- type DeploymentTiming
- func (d *DeploymentTiming) GetBuildBillable() string
- func (d *DeploymentTiming) GetBuildTotal() string
- func (d *DeploymentTiming) GetComponents() []*DeploymentTimingComponent
- func (d *DeploymentTiming) GetDatabaseProvision() string
- func (d *DeploymentTiming) GetDeploying() string
- func (d *DeploymentTiming) GetPending() string
- type DeploymentTimingComponent
- type DeploymentWorker
- type Destinations
- type DetectRequest
- func (d *DetectRequest) GetBitbucket() *BitbucketSourceSpec
- func (d *DetectRequest) GetCommitSHA() string
- func (d *DetectRequest) GetGit() *GitSourceSpec
- func (d *DetectRequest) GetGitHub() *GitHubSourceSpec
- func (d *DetectRequest) GetGitLab() *GitLabSourceSpec
- func (d *DetectRequest) GetSourceDir() string
- type DetectResponse
- func (d *DetectResponse) GetComponents() []*DetectResponseComponent
- func (d *DetectResponse) GetPending() bool
- func (d *DetectResponse) GetTemplate() *DeployTemplate
- func (d *DetectResponse) GetTemplateError() string
- func (d *DetectResponse) GetTemplateFound() bool
- func (d *DetectResponse) GetTemplateValid() bool
- type DetectResponseComponent
- func (d *DetectResponseComponent) GetBuildCommand() string
- func (d *DetectResponseComponent) GetBuildpacks() []*Buildpack
- func (d *DetectResponseComponent) GetDockerfiles() []string
- func (d *DetectResponseComponent) GetEnvVars() []*AppVariableDefinition
- func (d *DetectResponseComponent) GetEnvironmentSlug() string
- func (d *DetectResponseComponent) GetHTTPPorts() []int64
- func (d *DetectResponseComponent) GetRunCommand() string
- func (d *DetectResponseComponent) GetServerlessPackages() []*DetectResponseServerlessPackage
- func (d *DetectResponseComponent) GetSourceDir() string
- func (d *DetectResponseComponent) GetStrategy() DetectResponseType
- func (d *DetectResponseComponent) GetTypes() []string
- type DetectResponseServerlessFunction
- type DetectResponseServerlessFunctionLimits
- type DetectResponseServerlessPackage
- type DetectResponseType
- type DiskInfo
- type DiskSize
- type DockerCredentials
- type Domain
- type DomainCreateRequest
- type DomainRecord
- type DomainRecordEditRequest
- type DomainsService
- type DomainsServiceOp
- func (s *DomainsServiceOp) Create(ctx context.Context, createRequest *DomainCreateRequest) (*Domain, *Response, error)
- func (s *DomainsServiceOp) CreateRecord(ctx context.Context, domain string, createRequest *DomainRecordEditRequest) (*DomainRecord, *Response, error)
- func (s *DomainsServiceOp) Delete(ctx context.Context, name string) (*Response, error)
- func (s *DomainsServiceOp) DeleteRecord(ctx context.Context, domain string, id int) (*Response, error)
- func (s *DomainsServiceOp) EditRecord(ctx context.Context, domain string, id int, ...) (*DomainRecord, *Response, error)
- func (s *DomainsServiceOp) Get(ctx context.Context, name string) (*Domain, *Response, error)
- func (s DomainsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Domain, *Response, error)
- func (s *DomainsServiceOp) Record(ctx context.Context, domain string, id int) (*DomainRecord, *Response, error)
- func (s *DomainsServiceOp) Records(ctx context.Context, domain string, opt *ListOptions) ([]DomainRecord, *Response, error)
- func (s *DomainsServiceOp) RecordsByName(ctx context.Context, domain, name string, opt *ListOptions) ([]DomainRecord, *Response, error)
- func (s *DomainsServiceOp) RecordsByType(ctx context.Context, domain, ofType string, opt *ListOptions) ([]DomainRecord, *Response, error)
- func (s *DomainsServiceOp) RecordsByTypeAndName(ctx context.Context, domain, ofType, name string, opt *ListOptions) ([]DomainRecord, *Response, error)
- type ErrorResponse
- type Firewall
- type FirewallRequest
- type FirewallRulesRequest
- type FirewallsService
- type FirewallsServiceOp
- func (fw *FirewallsServiceOp) AddRules(ctx context.Context, fID string, rr *FirewallRulesRequest) (*Response, error)
- func (fw *FirewallsServiceOp) AddTags(ctx context.Context, fID string, tags ...string) (*Response, error)
- func (fw *FirewallsServiceOp) AddVms(ctx context.Context, fID string, vmIDs ...string) (*Response, error)
- func (fw *FirewallsServiceOp) Create(ctx context.Context, fr *FirewallRequest) (*Firewall, *Response, error)
- func (fw *FirewallsServiceOp) Delete(ctx context.Context, fID string) (*Response, error)
- func (fw *FirewallsServiceOp) Get(ctx context.Context, fID string) (*Firewall, *Response, error)
- func (fw *FirewallsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Firewall, *Response, error)
- func (fw *FirewallsServiceOp) ListByVm(ctx context.Context, dID int, opt *ListOptions) ([]Firewall, *Response, error)
- func (fw *FirewallsServiceOp) RemoveRules(ctx context.Context, fID string, rr *FirewallRulesRequest) (*Response, error)
- func (fw *FirewallsServiceOp) RemoveTags(ctx context.Context, fID string, tags ...string) (*Response, error)
- func (fw *FirewallsServiceOp) RemoveVms(ctx context.Context, fID string, vmIDs ...string) (*Response, error)
- func (fw *FirewallsServiceOp) Update(ctx context.Context, fID string, fr *FirewallRequest) (*Firewall, *Response, error)
- type FloatingIP
- type FloatingIPActionsService
- type FloatingIPActionsServiceOp
- func (s *FloatingIPActionsServiceOp) Assign(ctx context.Context, ip string, vmID string) (*Action, *Response, error)
- func (s *FloatingIPActionsServiceOp) Get(ctx context.Context, ip string, actionID int) (*Action, *Response, error)
- func (s *FloatingIPActionsServiceOp) List(ctx context.Context, ip string, opt *ListOptions) ([]Action, *Response, error)
- func (s *FloatingIPActionsServiceOp) Unassign(ctx context.Context, ip string) (*Action, *Response, error)
- type FloatingIPCreateRequest
- type FloatingIPsService
- type FloatingIPsServiceOp
- func (f *FloatingIPsServiceOp) Create(ctx context.Context, createRequest *FloatingIPCreateRequest) (*FloatingIP, *Response, error)
- func (f *FloatingIPsServiceOp) Delete(ctx context.Context, ip string) (*Response, error)
- func (f *FloatingIPsServiceOp) Get(ctx context.Context, ip string) (*FloatingIP, *Response, error)
- func (f *FloatingIPsServiceOp) List(ctx context.Context, opt *ListOptions) ([]FloatingIP, *Response, error)
- type ForwardingRule
- type FunctionsNamespace
- type FunctionsNamespaceCreateRequest
- type FunctionsService
- type FunctionsServiceOp
- func (s *FunctionsServiceOp) CreateNamespace(ctx context.Context, opts *FunctionsNamespaceCreateRequest) (*FunctionsNamespace, *Response, error)
- func (s *FunctionsServiceOp) CreateTrigger(ctx context.Context, namespace string, opts *FunctionsTriggerCreateRequest) (*FunctionsTrigger, *Response, error)
- func (s *FunctionsServiceOp) DeleteNamespace(ctx context.Context, namespace string) (*Response, error)
- func (s *FunctionsServiceOp) DeleteTrigger(ctx context.Context, namespace string, trigger string) (*Response, error)
- func (s *FunctionsServiceOp) GetNamespace(ctx context.Context, namespace string) (*FunctionsNamespace, *Response, error)
- func (s *FunctionsServiceOp) GetTrigger(ctx context.Context, namespace string, trigger string) (*FunctionsTrigger, *Response, error)
- func (s *FunctionsServiceOp) ListNamespaces(ctx context.Context) ([]FunctionsNamespace, *Response, error)
- func (s *FunctionsServiceOp) ListTriggers(ctx context.Context, namespace string) ([]FunctionsTrigger, *Response, error)
- func (s *FunctionsServiceOp) UpdateTrigger(ctx context.Context, namespace string, trigger string, ...) (*FunctionsTrigger, *Response, error)
- type FunctionsTrigger
- type FunctionsTriggerCreateRequest
- type FunctionsTriggerUpdateRequest
- type GLBSettings
- type GPUInfo
- type GarbageCollection
- type GarbageCollectionType
- type GetAppDatabaseConnectionDetailsResponse
- type GetDatabaseConnectionDetailsResponse
- func (g *GetDatabaseConnectionDetailsResponse) GetComponentName() string
- func (g *GetDatabaseConnectionDetailsResponse) GetDatabaseName() string
- func (g *GetDatabaseConnectionDetailsResponse) GetDatabaseURL() string
- func (g *GetDatabaseConnectionDetailsResponse) GetHost() string
- func (g *GetDatabaseConnectionDetailsResponse) GetPassword() string
- func (g *GetDatabaseConnectionDetailsResponse) GetPools() []*GetDatabaseConnectionDetailsResponsePool
- func (g *GetDatabaseConnectionDetailsResponse) GetPort() int64
- func (g *GetDatabaseConnectionDetailsResponse) GetSslMode() string
- func (g *GetDatabaseConnectionDetailsResponse) GetUsername() string
- type GetDatabaseConnectionDetailsResponsePool
- func (g *GetDatabaseConnectionDetailsResponsePool) GetDatabaseName() string
- func (g *GetDatabaseConnectionDetailsResponsePool) GetDatabaseURL() string
- func (g *GetDatabaseConnectionDetailsResponsePool) GetHost() string
- func (g *GetDatabaseConnectionDetailsResponsePool) GetPassword() string
- func (g *GetDatabaseConnectionDetailsResponsePool) GetPoolName() string
- func (g *GetDatabaseConnectionDetailsResponsePool) GetPort() int64
- func (g *GetDatabaseConnectionDetailsResponsePool) GetSslMode() string
- func (g *GetDatabaseConnectionDetailsResponsePool) GetUsername() string
- type GetDatabaseTrustedSourceResponse
- type GitHubSourceSpec
- type GitLabSourceSpec
- type GitSourceSpec
- type HealthCheck
- type Image
- type ImageActionsService
- type ImageActionsServiceOp
- func (i *ImageActionsServiceOp) Convert(ctx context.Context, imageID int) (*Action, *Response, error)
- func (i *ImageActionsServiceOp) Get(ctx context.Context, imageID, actionID int) (*Action, *Response, error)
- func (i *ImageActionsServiceOp) GetByURI(ctx context.Context, rawurl string) (*Action, *Response, error)
- func (i *ImageActionsServiceOp) Transfer(ctx context.Context, imageID int, transferRequest *ActionRequest) (*Action, *Response, error)
- type ImageSourceSpec
- func (i *ImageSourceSpec) GetDeployOnPush() *ImageSourceSpecDeployOnPush
- func (i *ImageSourceSpec) GetDigest() string
- func (i *ImageSourceSpec) GetRegistry() string
- func (i *ImageSourceSpec) GetRegistryCredentials() string
- func (i *ImageSourceSpec) GetRegistryType() ImageSourceSpecRegistryType
- func (i *ImageSourceSpec) GetRepository() string
- func (i *ImageSourceSpec) GetTag() string
- func (s *ImageSourceSpec) GetType() AppSourceType
- type ImageSourceSpecDeployOnPush
- type ImageSourceSpecRegistryType
- type ImageUpdateRequest
- type ImagesService
- type ImagesServiceOp
- func (s *ImagesServiceOp) Create(ctx context.Context, createRequest *CustomImageCreateRequest) (*Image, *Response, error)
- func (s *ImagesServiceOp) Delete(ctx context.Context, imageID int) (*Response, error)
- func (s *ImagesServiceOp) GetByID(ctx context.Context, imageID int) (*Image, *Response, error)
- func (s *ImagesServiceOp) GetBySlug(ctx context.Context, slug string) (*Image, *Response, error)
- func (s *ImagesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListApplication(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListDistribution(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) ListUser(ctx context.Context, opt *ListOptions) ([]Image, *Response, error)
- func (s *ImagesServiceOp) Update(ctx context.Context, imageID int, updateRequest *ImageUpdateRequest) (*Image, *Response, error)
- type InboundRule
- type IndexReplication
- type InstallKubernetesAppsRequest
- type InstallKubernetesAppsResponse
- type Invoice
- type InvoiceItem
- type InvoiceList
- type InvoiceListItem
- type InvoiceSummary
- type InvoiceSummaryBreakdown
- type InvoiceSummaryBreakdownItem
- type InvoicesService
- type InvoicesServiceOp
- func (s *InvoicesServiceOp) Get(ctx context.Context, invoiceUUID string, opt *ListOptions) (*Invoice, *Response, error)
- func (s *InvoicesServiceOp) GetCSV(ctx context.Context, invoiceUUID string) ([]byte, *Response, error)
- func (s *InvoicesServiceOp) GetPDF(ctx context.Context, invoiceUUID string) ([]byte, *Response, error)
- func (s *InvoicesServiceOp) GetSummary(ctx context.Context, invoiceUUID string) (*InvoiceSummary, *Response, error)
- func (s *InvoicesServiceOp) List(ctx context.Context, opt *ListOptions) (*InvoiceList, *Response, error)
- type KafkaACL
- type KafkaConfig
- type Kernel
- type Key
- type KeyCreateRequest
- type KeyUpdateRequest
- type KeysService
- type KeysServiceOp
- func (s *KeysServiceOp) Create(ctx context.Context, createRequest *KeyCreateRequest) (*Key, *Response, error)
- func (s *KeysServiceOp) DeleteByFingerprint(ctx context.Context, fingerprint string) (*Response, error)
- func (s *KeysServiceOp) DeleteByID(ctx context.Context, keyID int) (*Response, error)
- func (s *KeysServiceOp) GetByFingerprint(ctx context.Context, fingerprint string) (*Key, *Response, error)
- func (s *KeysServiceOp) GetByID(ctx context.Context, keyID int) (*Key, *Response, error)
- func (s *KeysServiceOp) List(ctx context.Context, opt *ListOptions) ([]Key, *Response, error)
- func (s *KeysServiceOp) UpdateByFingerprint(ctx context.Context, fingerprint string, updateRequest *KeyUpdateRequest) (*Key, *Response, error)
- func (s *KeysServiceOp) UpdateByID(ctx context.Context, keyID int, updateRequest *KeyUpdateRequest) (*Key, *Response, error)
- type KubernetesAssociatedResources
- type KubernetesCluster
- type KubernetesClusterConfig
- type KubernetesClusterCreateRequest
- type KubernetesClusterCredentials
- type KubernetesClusterCredentialsGetRequest
- type KubernetesClusterDeleteSelectiveRequest
- type KubernetesClusterRegistryRequest
- type KubernetesClusterStatus
- type KubernetesClusterStatusState
- type KubernetesClusterUpdateRequest
- type KubernetesClusterUpgradeRequest
- type KubernetesClusterUser
- type KubernetesControlPlaneFirewall
- type KubernetesGetClusterlintRequest
- type KubernetesMaintenancePolicy
- type KubernetesMaintenancePolicyDay
- type KubernetesNode
- type KubernetesNodeDeleteRequest
- type KubernetesNodePool
- type KubernetesNodePoolCreateRequest
- type KubernetesNodePoolRecycleNodesRequest
- type KubernetesNodePoolUpdateRequest
- type KubernetesNodeSize
- type KubernetesNodeStatus
- type KubernetesOptions
- type KubernetesRegion
- type KubernetesRunClusterlintRequest
- type KubernetesService
- type KubernetesServiceOp
- func (svc *KubernetesServiceOp) AddRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error)
- func (svc *KubernetesServiceOp) Create(ctx context.Context, create *KubernetesClusterCreateRequest) (*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) CreateNodePool(ctx context.Context, clusterID string, create *KubernetesNodePoolCreateRequest) (*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) Delete(ctx context.Context, clusterID string) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteDangerous(ctx context.Context, clusterID string) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteNode(ctx context.Context, clusterID, poolID, nodeID string, ...) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteNodePool(ctx context.Context, clusterID, poolID string) (*Response, error)
- func (svc *KubernetesServiceOp) DeleteSelective(ctx context.Context, clusterID string, ...) (*Response, error)
- func (svc *KubernetesServiceOp) Get(ctx context.Context, clusterID string) (*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) GetClusterlintResults(ctx context.Context, clusterID string, req *KubernetesGetClusterlintRequest) ([]*ClusterlintDiagnostic, *Response, error)
- func (svc *KubernetesServiceOp) GetCredentials(ctx context.Context, clusterID string, ...) (*KubernetesClusterCredentials, *Response, error)
- func (svc *KubernetesServiceOp) GetKubeConfig(ctx context.Context, clusterID string) (*KubernetesClusterConfig, *Response, error)
- func (svc *KubernetesServiceOp) GetKubeConfigWithExpiry(ctx context.Context, clusterID string, expirySeconds int64) (*KubernetesClusterConfig, *Response, error)
- func (svc *KubernetesServiceOp) GetNodePool(ctx context.Context, clusterID, poolID string) (*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) GetOptions(ctx context.Context) (*KubernetesOptions, *Response, error)
- func (svc *KubernetesServiceOp) GetUpgrades(ctx context.Context, clusterID string) ([]*KubernetesVersion, *Response, error)
- func (svc *KubernetesServiceOp) GetUser(ctx context.Context, clusterID string) (*KubernetesClusterUser, *Response, error)
- func (svc *KubernetesServiceOp) List(ctx context.Context, opts *ListOptions) ([]*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) ListAssociatedResourcesForDeletion(ctx context.Context, clusterID string) (*KubernetesAssociatedResources, *Response, error)
- func (svc *KubernetesServiceOp) ListNodePools(ctx context.Context, clusterID string, opts *ListOptions) ([]*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) RecycleNodePoolNodes(ctx context.Context, clusterID, poolID string, ...) (*Response, error)
- func (svc *KubernetesServiceOp) RemoveRegistry(ctx context.Context, req *KubernetesClusterRegistryRequest) (*Response, error)
- func (svc *KubernetesServiceOp) RunClusterlint(ctx context.Context, clusterID string, req *KubernetesRunClusterlintRequest) (string, *Response, error)
- func (svc *KubernetesServiceOp) Update(ctx context.Context, clusterID string, update *KubernetesClusterUpdateRequest) (*KubernetesCluster, *Response, error)
- func (svc *KubernetesServiceOp) UpdateNodePool(ctx context.Context, clusterID, poolID string, ...) (*KubernetesNodePool, *Response, error)
- func (svc *KubernetesServiceOp) Upgrade(ctx context.Context, clusterID string, ...) (*Response, error)
- type KubernetesVersion
- type LBDomain
- type LBFirewall
- type LinkAction
- type Links
- type ListBuildpacksResponse
- type ListDatabaseEvents
- type ListDatabaseEventsRoot
- type ListOptions
- type ListVolumeParams
- type LoadBalancer
- type LoadBalancerMetricsRequest
- type LoadBalancerRequest
- type LoadBalancersService
- type LoadBalancersServiceOp
- func (l *LoadBalancersServiceOp) AddForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error)
- func (l *LoadBalancersServiceOp) AddVms(ctx context.Context, lbID string, vmIDs ...string) (*Response, error)
- func (l *LoadBalancersServiceOp) Create(ctx context.Context, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error)
- func (l *LoadBalancersServiceOp) Delete(ctx context.Context, ldID string) (*Response, error)
- func (l *LoadBalancersServiceOp) Get(ctx context.Context, lbID string) (*LoadBalancer, *Response, error)
- func (l *LoadBalancersServiceOp) List(ctx context.Context, opt *ListOptions) ([]LoadBalancer, *Response, error)
- func (l *LoadBalancersServiceOp) PurgeCache(ctx context.Context, ldID string) (*Response, error)
- func (l *LoadBalancersServiceOp) RemoveForwardingRules(ctx context.Context, lbID string, rules ...ForwardingRule) (*Response, error)
- func (l *LoadBalancersServiceOp) RemoveVms(ctx context.Context, lbID string, vmIDs ...string) (*Response, error)
- func (l *LoadBalancersServiceOp) Update(ctx context.Context, lbID string, lbr *LoadBalancerRequest) (*LoadBalancer, *Response, error)
- type Meta
- type MetricsData
- type MetricsResponse
- type MongoDBConfig
- type MonitoringService
- type MonitoringServiceOp
- func (s *MonitoringServiceOp) CreateAlertPolicy(ctx context.Context, createRequest *AlertPolicyCreateRequest) (*AlertPolicy, *Response, error)
- func (s *MonitoringServiceOp) DeleteAlertPolicy(ctx context.Context, uuid string) (*Response, error)
- func (s *MonitoringServiceOp) GetAlertPolicy(ctx context.Context, uuid string) (*AlertPolicy, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendConnectionsCurrent(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendConnectionsLimit(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendCpuUtilization(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendFirewallDroppedBytes(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendFirewallDroppedPackets(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendHttpRequestsPerSecond(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendHttpResponses(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendNetworkThroughputHttp(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendNetworkThroughputTcp(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendNetworkThroughputUdp(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendNlbTcpNetworkThroughput(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendNlbUdpNetworkThroughput(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendTlsConnectionsCurrent(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendTlsConnectionsExceedingRateLimit(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerFrontendTlsConnectionsLimit(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsConnections(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsDowntime(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHealthChecks(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpResponseTime50P(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpResponseTime95P(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpResponseTime99P(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpResponseTimeAvg(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpResponses(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpSessionDuration50P(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpSessionDuration95P(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsHttpSessionDurationAvg(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetLoadBalancerVmsQueueSize(ctx context.Context, args *LoadBalancerMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmAvailableMemory(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmBandwidth(ctx context.Context, args *VmBandwidthMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmCPU(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmCachedMemory(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmFilesystemFree(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmFilesystemSize(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmFreeMemory(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmLoad1(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmLoad5(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmLoad15(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) GetVmTotalMemory(ctx context.Context, args *VmMetricsRequest) (*MetricsResponse, *Response, error)
- func (s *MonitoringServiceOp) ListAlertPolicies(ctx context.Context, opt *ListOptions) ([]AlertPolicy, *Response, error)
- func (s *MonitoringServiceOp) UpdateAlertPolicy(ctx context.Context, uuid string, updateRequest *AlertPolicyUpdateRequest) (*AlertPolicy, *Response, error)
- type MySQLConfig
- type NetworkV4
- type NetworkV6
- type Networks
- type Notifications
- type OneClick
- type OneClickService
- type OneClickServiceOp
- type OneClicksRoot
- type OpenSearchACL
- type OpenSearchBasicAuth
- type OpensearchConfig
- type OutboundRule
- type Pages
- type PendingChange
- type PostgreSQLBouncerConfig
- type PostgreSQLConfig
- type PostgreSQLTimeScaleDBConfig
- type Project
- type ProjectResource
- type ProjectResourceLinks
- type ProjectsService
- type ProjectsServiceOp
- func (p *ProjectsServiceOp) AssignResources(ctx context.Context, projectID string, resources ...interface{}) ([]ProjectResource, *Response, error)
- func (p *ProjectsServiceOp) Create(ctx context.Context, cr *CreateProjectRequest) (*Project, *Response, error)
- func (p *ProjectsServiceOp) Delete(ctx context.Context, projectID string) (*Response, error)
- func (p *ProjectsServiceOp) Get(ctx context.Context, projectID string) (*Project, *Response, error)
- func (p *ProjectsServiceOp) GetDefault(ctx context.Context) (*Project, *Response, error)
- func (p *ProjectsServiceOp) List(ctx context.Context, opts *ListOptions) ([]Project, *Response, error)
- func (p *ProjectsServiceOp) ListResources(ctx context.Context, projectID string, opts *ListOptions) ([]ProjectResource, *Response, error)
- func (p *ProjectsServiceOp) Update(ctx context.Context, projectID string, ur *UpdateProjectRequest) (*Project, *Response, error)
- type Rate
- type RedisConfig
- type Region
- type RegionsService
- type RegionsServiceOp
- type RegistriesCreateRequest
- type RegistriesService
- type RegistriesServiceOp
- func (svc *RegistriesServiceOp) Create(ctx context.Context, create *RegistriesCreateRequest) (*Registry, *Response, error)
- func (svc *RegistriesServiceOp) Delete(ctx context.Context, registry string) (*Response, error)
- func (svc *RegistriesServiceOp) DockerCredentials(ctx context.Context, registry string, ...) (*DockerCredentials, *Response, error)
- func (svc *RegistriesServiceOp) Get(ctx context.Context, registry string) (*Registry, *Response, error)
- func (svc *RegistriesServiceOp) List(ctx context.Context) ([]*Registry, *Response, error)
- type Registry
- type RegistryCreateRequest
- type RegistryDockerCredentialsRequest
- type RegistryOptions
- type RegistryService
- type RegistryServiceOp
- func (svc *RegistryServiceOp) Create(ctx context.Context, create *RegistryCreateRequest) (*Registry, *Response, error)
- func (svc *RegistryServiceOp) Delete(ctx context.Context) (*Response, error)
- func (svc *RegistryServiceOp) DeleteManifest(ctx context.Context, registry, repository, digest string) (*Response, error)
- func (svc *RegistryServiceOp) DeleteTag(ctx context.Context, registry, repository, tag string) (*Response, error)
- func (svc *RegistryServiceOp) DockerCredentials(ctx context.Context, request *RegistryDockerCredentialsRequest) (*DockerCredentials, *Response, error)
- func (svc *RegistryServiceOp) Get(ctx context.Context) (*Registry, *Response, error)
- func (svc *RegistryServiceOp) GetGarbageCollection(ctx context.Context, registry string) (*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) GetOptions(ctx context.Context) (*RegistryOptions, *Response, error)
- func (svc *RegistryServiceOp) GetSubscription(ctx context.Context) (*RegistrySubscription, *Response, error)
- func (svc *RegistryServiceOp) ListGarbageCollections(ctx context.Context, registry string, opts *ListOptions) ([]*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) ListRepositories(ctx context.Context, registry string, opts *ListOptions) ([]*Repository, *Response, error)
- func (svc *RegistryServiceOp) ListRepositoriesV2(ctx context.Context, registry string, opts *TokenListOptions) ([]*RepositoryV2, *Response, error)
- func (svc *RegistryServiceOp) ListRepositoryManifests(ctx context.Context, registry, repository string, opts *ListOptions) ([]*RepositoryManifest, *Response, error)
- func (svc *RegistryServiceOp) ListRepositoryTags(ctx context.Context, registry, repository string, opts *ListOptions) ([]*RepositoryTag, *Response, error)
- func (svc *RegistryServiceOp) StartGarbageCollection(ctx context.Context, registry string, ...) (*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) UpdateGarbageCollection(ctx context.Context, registry, gcUUID string, ...) (*GarbageCollection, *Response, error)
- func (svc *RegistryServiceOp) UpdateSubscription(ctx context.Context, request *RegistrySubscriptionUpdateRequest) (*RegistrySubscription, *Response, error)
- func (svc *RegistryServiceOp) ValidateName(ctx context.Context, request *RegistryValidateNameRequest) (*Response, error)
- type RegistrySubscription
- type RegistrySubscriptionTier
- type RegistrySubscriptionUpdateRequest
- type RegistryValidateNameRequest
- type Repository
- type RepositoryManifest
- type RepositoryTag
- type RepositoryV2
- type RequestCompletionCallback
- type ReservedIP
- type ReservedIPActionsService
- type ReservedIPActionsServiceOp
- func (s *ReservedIPActionsServiceOp) Assign(ctx context.Context, ip string, vmID string) (*Action, *Response, error)
- func (s *ReservedIPActionsServiceOp) Get(ctx context.Context, ip string, actionID int) (*Action, *Response, error)
- func (s *ReservedIPActionsServiceOp) List(ctx context.Context, ip string, opt *ListOptions) ([]Action, *Response, error)
- func (s *ReservedIPActionsServiceOp) Unassign(ctx context.Context, ip string) (*Action, *Response, error)
- type ReservedIPCreateRequest
- type ReservedIPV6
- type ReservedIPV6ActionsService
- type ReservedIPV6ActionsServiceOp
- type ReservedIPV6CreateRequest
- type ReservedIPV6sService
- type ReservedIPV6sServiceOp
- func (r *ReservedIPV6sServiceOp) Create(ctx context.Context, reserveRequest *ReservedIPV6CreateRequest) (*ReservedIPV6, *Response, error)
- func (r *ReservedIPV6sServiceOp) Delete(ctx context.Context, ip string) (*Response, error)
- func (r *ReservedIPV6sServiceOp) Get(ctx context.Context, ip string) (*ReservedIPV6, *Response, error)
- func (r *ReservedIPV6sServiceOp) List(ctx context.Context, opt *ListOptions) ([]ReservedIPV6, *Response, error)
- type ReservedIPsService
- type ReservedIPsServiceOp
- func (r *ReservedIPsServiceOp) Create(ctx context.Context, createRequest *ReservedIPCreateRequest) (*ReservedIP, *Response, error)
- func (r *ReservedIPsServiceOp) Delete(ctx context.Context, ip string) (*Response, error)
- func (r *ReservedIPsServiceOp) Get(ctx context.Context, ip string) (*ReservedIP, *Response, error)
- func (r *ReservedIPsServiceOp) List(ctx context.Context, opt *ListOptions) ([]ReservedIP, *Response, error)
- type ResetDatabasePasswordRequest
- type ResetDatabasePasswordResponse
- type Resource
- type ResourceType
- type ResourceWithURN
- type Response
- type RetryConfig
- type ServiceAddress
- type ServingProtocol
- type Size
- type SizesService
- type SizesServiceOp
- type SlackDetails
- type Snapshot
- type SnapshotCreateRequest
- type SnapshotsService
- type SnapshotsServiceOp
- func (s *SnapshotsServiceOp) Delete(ctx context.Context, snapshotID string) (*Response, error)
- func (s *SnapshotsServiceOp) Get(ctx context.Context, snapshotID string) (*Snapshot, *Response, error)
- func (s *SnapshotsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
- func (s *SnapshotsServiceOp) ListVm(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
- func (s *SnapshotsServiceOp) ListVolume(ctx context.Context, opt *ListOptions) ([]Snapshot, *Response, error)
- type SourceSpec
- type Sources
- type StartGarbageCollectionRequest
- type StickySessions
- type StorageActionsService
- type StorageActionsServiceOp
- func (s *StorageActionsServiceOp) Attach(ctx context.Context, volumeID string, vmID string) (*Action, *Response, error)
- func (s *StorageActionsServiceOp) DetachByVmID(ctx context.Context, volumeID string, vmID string) (*Action, *Response, error)
- func (s *StorageActionsServiceOp) Get(ctx context.Context, volumeID string, actionID int) (*Action, *Response, error)
- func (s *StorageActionsServiceOp) List(ctx context.Context, volumeID string, opt *ListOptions) ([]Action, *Response, error)
- func (s *StorageActionsServiceOp) Resize(ctx context.Context, volumeID string, sizeGigabytes int, regionSlug string) (*Action, *Response, error)
- type StorageAttachment
- type StorageService
- type StorageServiceOp
- func (svc *StorageServiceOp) CreateSnapshot(ctx context.Context, createRequest *SnapshotCreateRequest) (*Snapshot, *Response, error)
- func (svc *StorageServiceOp) CreateVolume(ctx context.Context, createRequest *VolumeCreateRequest) (*Volume, *Response, error)
- func (svc *StorageServiceOp) DeleteSnapshot(ctx context.Context, id string) (*Response, error)
- func (svc *StorageServiceOp) DeleteVolume(ctx context.Context, id string) (*Response, error)
- func (svc *StorageServiceOp) GetSnapshot(ctx context.Context, id string) (*Snapshot, *Response, error)
- func (svc *StorageServiceOp) GetVolume(ctx context.Context, id string) (*Volume, *Response, error)
- func (svc *StorageServiceOp) ListSnapshots(ctx context.Context, volumeID string, opt *ListOptions) ([]Snapshot, *Response, error)
- func (svc *StorageServiceOp) ListVolumes(ctx context.Context, params *ListVolumeParams) ([]Volume, *Response, error)
- type SupportedBackupPolicy
- type Tag
- type TagCreateRequest
- type TagResourcesRequest
- type TaggedDatabasesResources
- type TaggedImagesResources
- type TaggedResources
- type TaggedResourcesData
- type TaggedVolumeSnapshotsResources
- type TaggedVolumesResources
- type TaggedvmsResources
- type TagsService
- type TagsServiceOp
- func (s *TagsServiceOp) Create(ctx context.Context, createRequest *TagCreateRequest) (*Tag, *Response, error)
- func (s *TagsServiceOp) Delete(ctx context.Context, name string) (*Response, error)
- func (s *TagsServiceOp) Get(ctx context.Context, name string) (*Tag, *Response, error)
- func (s *TagsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Tag, *Response, error)
- func (s *TagsServiceOp) TagResources(ctx context.Context, name string, tagRequest *TagResourcesRequest) (*Response, error)
- func (s *TagsServiceOp) UntagResources(ctx context.Context, name string, untagRequest *UntagResourcesRequest) (*Response, error)
- type Taint
- type TeamInfo
- type Timestamp
- type ToggleDatabaseTrustedSourceOptions
- type ToggleDatabaseTrustedSourceRequest
- type ToggleDatabaseTrustedSourceResponse
- type TokenListOptions
- type TopicConfig
- type TopicConsumerGroup
- type TopicPartition
- type TriggerScheduledDetails
- type TriggerScheduledRuns
- type UntagResourcesRequest
- type UpdateGarbageCollectionRequest
- type UpdateProjectRequest
- type UpdateUptimeAlertRequest
- type UpdateUptimeCheckRequest
- type UpgradeBuildpackOptions
- type UpgradeBuildpackResponse
- type UpgradeVersionRequest
- type UptimeAlert
- type UptimeAlertComp
- type UptimeCheck
- type UptimeCheckState
- type UptimeChecksService
- type UptimeChecksServiceOp
- func (p *UptimeChecksServiceOp) Create(ctx context.Context, cr *CreateUptimeCheckRequest) (*UptimeCheck, *Response, error)
- func (p *UptimeChecksServiceOp) CreateAlert(ctx context.Context, uptimeCheckID string, cr *CreateUptimeAlertRequest) (*UptimeAlert, *Response, error)
- func (p *UptimeChecksServiceOp) Delete(ctx context.Context, uptimeCheckID string) (*Response, error)
- func (p *UptimeChecksServiceOp) DeleteAlert(ctx context.Context, uptimeCheckID string, alertID string) (*Response, error)
- func (p *UptimeChecksServiceOp) Get(ctx context.Context, uptimeCheckID string) (*UptimeCheck, *Response, error)
- func (p *UptimeChecksServiceOp) GetAlert(ctx context.Context, uptimeCheckID string, alertID string) (*UptimeAlert, *Response, error)
- func (p *UptimeChecksServiceOp) GetState(ctx context.Context, uptimeCheckID string) (*UptimeCheckState, *Response, error)
- func (p *UptimeChecksServiceOp) List(ctx context.Context, opts *ListOptions) ([]UptimeCheck, *Response, error)
- func (p *UptimeChecksServiceOp) ListAlerts(ctx context.Context, uptimeCheckID string, opts *ListOptions) ([]UptimeAlert, *Response, error)
- func (p *UptimeChecksServiceOp) Update(ctx context.Context, uptimeCheckID string, ur *UpdateUptimeCheckRequest) (*UptimeCheck, *Response, error)
- func (p *UptimeChecksServiceOp) UpdateAlert(ctx context.Context, uptimeCheckID string, alertID string, ...) (*UptimeAlert, *Response, error)
- type UptimePreviousOutage
- type UptimeRegion
- type VCSSourceSpec
- type VPC
- type VPCCreateRequest
- type VPCListMembersRequest
- type VPCMember
- type VPCPeering
- type VPCPeeringCreateRequest
- type VPCPeeringCreateRequestByVPCID
- type VPCPeeringUpdateRequest
- type VPCSetDescription
- type VPCSetField
- type VPCSetName
- type VPCUpdateRequest
- type VPCsService
- type VPCsServiceOp
- func (v *VPCsServiceOp) Create(ctx context.Context, create *VPCCreateRequest) (*VPC, *Response, error)
- func (v *VPCsServiceOp) CreateVPCPeering(ctx context.Context, create *VPCPeeringCreateRequest) (*VPCPeering, *Response, error)
- func (v *VPCsServiceOp) CreateVPCPeeringByVPCID(ctx context.Context, id string, create *VPCPeeringCreateRequestByVPCID) (*VPCPeering, *Response, error)
- func (v *VPCsServiceOp) Delete(ctx context.Context, id string) (*Response, error)
- func (v *VPCsServiceOp) DeleteVPCPeering(ctx context.Context, id string) (*Response, error)
- func (v *VPCsServiceOp) Get(ctx context.Context, id string) (*VPC, *Response, error)
- func (v *VPCsServiceOp) GetVPCPeering(ctx context.Context, id string) (*VPCPeering, *Response, error)
- func (v *VPCsServiceOp) List(ctx context.Context, opt *ListOptions) ([]*VPC, *Response, error)
- func (v *VPCsServiceOp) ListMembers(ctx context.Context, id string, request *VPCListMembersRequest, ...) ([]*VPCMember, *Response, error)
- func (v *VPCsServiceOp) ListVPCPeerings(ctx context.Context, opt *ListOptions) ([]*VPCPeering, *Response, error)
- func (v *VPCsServiceOp) ListVPCPeeringsByVPCID(ctx context.Context, id string, opt *ListOptions) ([]*VPCPeering, *Response, error)
- func (v *VPCsServiceOp) Set(ctx context.Context, id string, fields ...VPCSetField) (*VPC, *Response, error)
- func (v *VPCsServiceOp) Update(ctx context.Context, id string, update *VPCUpdateRequest) (*VPC, *Response, error)
- func (v *VPCsServiceOp) UpdateVPCPeering(ctx context.Context, id string, update *VPCPeeringUpdateRequest) (*VPCPeering, *Response, error)
- func (v *VPCsServiceOp) UpdateVPCPeeringByVPCID(ctx context.Context, vpcID, peerID string, update *VPCPeeringUpdateRequest) (*VPCPeering, *Response, error)
- type VRAM
- type Vm
- type VmActionsService
- type VmActionsServiceOp
- func (s *VmActionsServiceOp) ChangeBackupPolicy(ctx context.Context, id string, policy *VmBackupPolicyRequest) (*Action, *Response, error)
- func (s *VmActionsServiceOp) ChangeKernel(ctx context.Context, id string, kernelID int) (*Action, *Response, error)
- func (s *VmActionsServiceOp) DisableBackups(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) DisableBackupsByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) EnableBackups(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) EnableBackupsByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) EnableBackupsWithPolicy(ctx context.Context, id string, policy *VmBackupPolicyRequest) (*Action, *Response, error)
- func (s *VmActionsServiceOp) EnableIPv6(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) EnableIPv6ByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) EnablePrivateNetworking(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) EnablePrivateNetworkingByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) Get(ctx context.Context, vmID string, actionID int) (*Action, *Response, error)
- func (s *VmActionsServiceOp) GetByURI(ctx context.Context, rawurl string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) PasswordReset(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) PowerCycle(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) PowerCycleByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) PowerOff(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) PowerOffByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) PowerOn(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) PowerOnByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) Reboot(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) RebuildByImageID(ctx context.Context, id string, imageID int) (*Action, *Response, error)
- func (s *VmActionsServiceOp) RebuildByImageSlug(ctx context.Context, id string, slug string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) Rename(ctx context.Context, id string, name string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) Resize(ctx context.Context, id string, sizeSlug string, resizeDisk bool) (*Action, *Response, error)
- func (s *VmActionsServiceOp) Restore(ctx context.Context, id string, imageID int) (*Action, *Response, error)
- func (s *VmActionsServiceOp) Shutdown(ctx context.Context, id string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) ShutdownByTag(ctx context.Context, tag string) ([]Action, *Response, error)
- func (s *VmActionsServiceOp) Snapshot(ctx context.Context, id string, name string) (*Action, *Response, error)
- func (s *VmActionsServiceOp) SnapshotByTag(ctx context.Context, tag string, name string) ([]Action, *Response, error)
- type VmAutoscaleConfiguration
- type VmAutoscaleHistoryEvent
- type VmAutoscalePool
- type VmAutoscalePoolRequest
- type VmAutoscaleResource
- type VmAutoscaleResourceTemplate
- type VmAutoscaleResourceUtilization
- type VmAutoscaleService
- type VmAutoscaleServiceOp
- func (d *VmAutoscaleServiceOp) Create(ctx context.Context, createReq *VmAutoscalePoolRequest) (*VmAutoscalePool, *Response, error)
- func (d *VmAutoscaleServiceOp) Delete(ctx context.Context, id string) (*Response, error)
- func (d *VmAutoscaleServiceOp) DeleteDangerous(ctx context.Context, id string) (*Response, error)
- func (d *VmAutoscaleServiceOp) Get(ctx context.Context, id string) (*VmAutoscalePool, *Response, error)
- func (d *VmAutoscaleServiceOp) List(ctx context.Context, opts *ListOptions) ([]*VmAutoscalePool, *Response, error)
- func (d *VmAutoscaleServiceOp) ListHistory(ctx context.Context, id string, opts *ListOptions) ([]*VmAutoscaleHistoryEvent, *Response, error)
- func (d *VmAutoscaleServiceOp) ListMembers(ctx context.Context, id string, opts *ListOptions) ([]*VmAutoscaleResource, *Response, error)
- func (d *VmAutoscaleServiceOp) Update(ctx context.Context, id string, updateReq *VmAutoscalePoolRequest) (*VmAutoscalePool, *Response, error)
- type VmBackupPolicy
- type VmBackupPolicyConfig
- type VmBackupPolicyRequest
- type VmBandwidthMetricsRequest
- type VmCreateImage
- type VmCreateRequest
- type VmCreateSSHKey
- type VmCreateVolume
- type VmMetricsRequest
- type VmMultiCreateRequest
- type VmsService
- type VmsServiceOp
- func (s *VmsServiceOp) Actions(ctx context.Context, vmID string, opt *ListOptions) ([]Action, *Response, error)
- func (s *VmsServiceOp) Backups(ctx context.Context, vmID string, opt *ListOptions) ([]Image, *Response, error)
- func (s *VmsServiceOp) Create(ctx context.Context, createRequest *VmCreateRequest) (*vmRoot, *Response, error)
- func (s *VmsServiceOp) CreateMultiple(ctx context.Context, createRequest *VmMultiCreateRequest) ([]Vm, *Response, error)
- func (s *VmsServiceOp) Delete(ctx context.Context, vmID string) (*Response, error)
- func (s *VmsServiceOp) DeleteByTag(ctx context.Context, tag string) (*Response, error)
- func (s *VmsServiceOp) Get(ctx context.Context, vmID string) (*Vm, *Response, error)
- func (s *VmsServiceOp) GetBackupPolicy(ctx context.Context, vmID string) (*VmBackupPolicy, *Response, error)
- func (s *VmsServiceOp) Kernels(ctx context.Context, vmID string, opt *ListOptions) ([]Kernel, *Response, error)
- func (s *VmsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Vm, *Response, error)
- func (s *VmsServiceOp) ListBackupPolicies(ctx context.Context, opt *ListOptions) (map[int]*VmBackupPolicy, *Response, error)
- func (s *VmsServiceOp) ListByName(ctx context.Context, name string, opt *ListOptions) ([]Vm, *Response, error)
- func (s *VmsServiceOp) ListByTag(ctx context.Context, tag string, opt *ListOptions) ([]Vm, *Response, error)
- func (s *VmsServiceOp) ListSupportedBackupPolicies(ctx context.Context) ([]*SupportedBackupPolicy, *Response, error)
- func (s *VmsServiceOp) ListWithGPUs(ctx context.Context, opt *ListOptions) ([]Vm, *Response, error)
- func (s *VmsServiceOp) Neighbors(ctx context.Context, vmID string) ([]Vm, *Response, error)
- func (s *VmsServiceOp) Snapshots(ctx context.Context, vmID string, opt *ListOptions) ([]Image, *Response, error)
- type Volume
- type VolumeCreateRequest
Constants ¶
const ( // ActionInProgress is an in progress action status ActionInProgress = "in-progress" //ActionCompleted is a completed action status ActionCompleted = "completed" )
const ( SQLModeAllowInvalidDates = "ALLOW_INVALID_DATES" SQLModeANSIQuotes = "ANSI_QUOTES" SQLModeHighNotPrecedence = "HIGH_NOT_PRECEDENCE" SQLModeIgnoreSpace = "IGNORE_SPACE" SQLModeNoAuthCreateUser = "NO_AUTO_CREATE_USER" SQLModeNoAutoValueOnZero = "NO_AUTO_VALUE_ON_ZERO" SQLModeNoBackslashEscapes = "NO_BACKSLASH_ESCAPES" SQLModeNoDirInCreate = "NO_DIR_IN_CREATE" SQLModeNoEngineSubstitution = "NO_ENGINE_SUBSTITUTION" SQLModeNoFieldOptions = "NO_FIELD_OPTIONS" SQLModeNoKeyOptions = "NO_KEY_OPTIONS" SQLModeNoTableOptions = "NO_TABLE_OPTIONS" SQLModeNoUnsignedSubtraction = "NO_UNSIGNED_SUBTRACTION" SQLModeNoZeroDate = "NO_ZERO_DATE" SQLModeNoZeroInDate = "NO_ZERO_IN_DATE" SQLModeOnlyFullGroupBy = "ONLY_FULL_GROUP_BY" SQLModePadCharToFullLength = "PAD_CHAR_TO_FULL_LENGTH" SQLModePipesAsConcat = "PIPES_AS_CONCAT" SQLModeRealAsFloat = "REAL_AS_FLOAT" SQLModeStrictAllTables = "STRICT_ALL_TABLES" SQLModeStrictTransTables = "STRICT_TRANS_TABLES" SQLModeANSI = "ANSI" SQLModeDB2 = "DB2" SQLModeMaxDB = "MAXDB" SQLModeMSSQL = "MSSQL" SQLModeMYSQL323 = "MYSQL323" SQLModeMYSQL40 = "MYSQL40" SQLModeOracle = "ORACLE" SQLModePostgreSQL = "POSTGRESQL" SQLModeTraditional = "TRADITIONAL" )
SQL Mode constants allow for MySQL-specific SQL flavor configuration.
const ( SQLAuthPluginNative = "mysql_native_password" SQLAuthPluginCachingSHA2 = "caching_sha2_password" )
SQL Auth constants allow for MySQL-specific user auth plugins
const ( EvictionPolicyNoEviction = "noeviction" EvictionPolicyAllKeysLRU = "allkeys_lru" EvictionPolicyAllKeysRandom = "allkeys_random" EvictionPolicyVolatileLRU = "volatile_lru" EvictionPolicyVolatileRandom = "volatile_random" EvictionPolicyVolatileTTL = "volatile_ttl" )
Redis eviction policies supported by the managed Redis product.
const ( KubernetesClusterStatusProvisioning = KubernetesClusterStatusState("provisioning") KubernetesClusterStatusRunning = KubernetesClusterStatusState("running") KubernetesClusterStatusDegraded = KubernetesClusterStatusState("degraded") KubernetesClusterStatusError = KubernetesClusterStatusState("error") KubernetesClusterStatusDeleted = KubernetesClusterStatusState("deleted") KubernetesClusterStatusUpgrading = KubernetesClusterStatusState("upgrading") KubernetesClusterStatusInvalid = KubernetesClusterStatusState("invalid") )
Possible states for a cluster.
const ( // Load Balancer types LoadBalancerTypeGlobal = "GLOBAL" LoadBalancerTypeRegional = "REGIONAL" LoadBalancerTypeRegionalNetwork = "REGIONAL_NETWORK" // Load Balancer network types LoadBalancerNetworkTypeExternal = "EXTERNAL" LoadBalancerNetworkTypeInternal = "INTERNAL" )
const ( VmCPUUtilizationPercent = "v1/insights/vm/cpu" VmMemoryUtilizationPercent = "v1/insights/vm/memory_utilization_percent" VmDiskUtilizationPercent = "v1/insights/vm/disk_utilization_percent" VmPublicOutboundBandwidthRate = "v1/insights/vm/public_outbound_bandwidth" VmPublicInboundBandwidthRate = "v1/insights/vm/public_inbound_bandwidth" VmPrivateOutboundBandwidthRate = "v1/insights/vm/private_outbound_bandwidth" VmPrivateInboundBandwidthRate = "v1/insights/vm/private_inbound_bandwidth" VmDiskReadRate = "v1/insights/vm/disk_read" VmDiskWriteRate = "v1/insights/vm/disk_write" VmOneMinuteLoadAverage = "v1/insights/vm/load_1" VmFiveMinuteLoadAverage = "v1/insights/vm/load_5" VmFifteenMinuteLoadAverage = "v1/insights/vm/load_15" LoadBalancerCPUUtilizationPercent = "v1/insights/lbaas/avg_cpu_utilization_percent" LoadBalancerConnectionUtilizationPercent = "v1/insights/lbaas/connection_utilization_percent" LoadBalancerVmHealth = "v1/insights/lbaas/vm_health" LoadBalancerTLSUtilizationPercent = "v1/insights/lbaas/tls_connections_per_second_utilization_percent" LoadBalancerIncreaseInHTTPErrorRatePercentage5xx = "v1/insights/lbaas/increase_in_http_error_rate_percentage_5xx" LoadBalancerIncreaseInHTTPErrorRatePercentage4xx = "v1/insights/lbaas/increase_in_http_error_rate_percentage_4xx" LoadBalancerIncreaseInHTTPErrorRateCount5xx = "v1/insights/lbaas/increase_in_http_error_rate_count_5xx" LoadBalancerIncreaseInHTTPErrorRateCount4xx = "v1/insights/lbaas/increase_in_http_error_rate_count_4xx" LoadBalancerHighHttpResponseTime = "v1/insights/lbaas/high_http_request_response_time" LoadBalancerHighHttpResponseTime50P = "v1/insights/lbaas/high_http_request_response_time_50p" LoadBalancerHighHttpResponseTime95P = "v1/insights/lbaas/high_http_request_response_time_95p" LoadBalancerHighHttpResponseTime99P = "v1/insights/lbaas/high_http_request_response_time_99p" DbaasFifteenMinuteLoadAverage = "v1/dbaas/alerts/load_15_alerts" DbaasMemoryUtilizationPercent = "v1/dbaas/alerts/memory_utilization_alerts" DbaasDiskUtilizationPercent = "v1/dbaas/alerts/disk_utilization_alerts" DbaasCPUUtilizationPercent = "v1/dbaas/alerts/cpu_alerts" )
const ( // GCTypeUntaggedManifestsOnly indicates that a garbage collection should // only delete untagged manifests. GCTypeUntaggedManifestsOnly = GarbageCollectionType("untagged manifests only") // GCTypeUnreferencedBlobsOnly indicates that a garbage collection should // only delete unreferenced blobs. GCTypeUnreferencedBlobsOnly = GarbageCollectionType("unreferenced blobs only") // GCTypeUntaggedManifestsAndUnreferencedBlobs indicates that a garbage // collection should delete both untagged manifests and unreferenced blobs. GCTypeUntaggedManifestsAndUnreferencedBlobs = GarbageCollectionType("untagged manifests and unreferenced blobs") )
const ( // DefaultProject is the ID you should use if you are working with your // default project. DefaultProject = "default" )
const (
// RegistryServer is the hostname of the Abrha registry service
RegistryServer = "registry.abrha.com"
)
Variables ¶
This section is empty.
Functions ¶
func CIDRSourceFirewall ¶
CIDRSourceFirewall takes a CIDR notation IP address and prefix length string like "192.0.2.0/24" and returns a formatted cidr source firewall rule
func CheckResponse ¶
CheckResponse checks the API response for errors, and returns them if present. A response is considered an error if it has a status code outside the 200 range. API error responses are expected to have either no response body, or a JSON response body that maps to ErrorResponse. Any other response body will be silently ignored. If the API error response does not include the request ID in its body, the one from its header will be used.
func DoRequestWithClient ¶
func DoRequestWithClient( ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error)
DoRequestWithClient submits an HTTP request using the specified client.
func ForEachAppSpecComponent ¶
ForEachAppSpecComponent loops over each component spec that matches the provided interface type. The type constraint is intentionally set to `any` to allow use of arbitrary interfaces to match the desired component types.
Examples:
- interface constraint go_api_abrha.ForEachAppSpecComponent(spec, func(component go_api_abrha.AppBuildableComponentSpec) error { ... })
- struct type constraint go_api_abrha.ForEachAppSpecComponent(spec, func(component *goApiAbrha.AppStaticSiteSpec) error { ... })
func GetAppSpecComponent ¶
GetAppSpecComponent returns an app spec component by type and name.
Examples:
- interface constraint goApiAbrha.GetAppSpecComponent[goApiAbrha.AppBuildableComponentSpec](spec, "component-name")
- struct type constraint goApiAbrha.GetAppSpecComponent[*goApiAbrha.AppServiceSpec](spec, "component-name")
func IPSourceFirewall ¶
IPSourceFirewall takes an IP (string) and returns a formatted ip source firewall rule
func StreamToString ¶
StreamToString converts a reader to a string
Types ¶
type Account ¶
type Account struct {
VmLimit int `json:"vm_limit,omitempty"`
FloatingIPLimit int `json:"floating_ip_limit,omitempty"`
ReservedIPLimit int `json:"reserved_ip_limit,omitempty"`
VolumeLimit int `json:"volume_limit,omitempty"`
Email string `json:"email,omitempty"`
Name string `json:"name,omitempty"`
UUID string `json:"uuid,omitempty"`
EmailVerified bool `json:"email_verified,omitempty"`
Status string `json:"status,omitempty"`
StatusMessage string `json:"status_message,omitempty"`
Team *TeamInfo `json:"team,omitempty"`
}
Account represents a Abrha Account
type AccountService ¶
AccountService is an interface for interfacing with the Account endpoints of the Abrha API See: https://docs.parspack.com/reference/api/cloud-server/#tag/Account
type AccountServiceOp ¶
type AccountServiceOp struct {
// contains filtered or unexported fields
}
AccountServiceOp handles communication with the Account related methods of the Abrha API.
type Action ¶
type Action struct {
ID int `json:"id"`
Status string `json:"status"`
Type string `json:"type"`
StartedAt *Timestamp `json:"started_at"`
CompletedAt *Timestamp `json:"completed_at"`
ResourceID string `json:"resource_id"`
ResourceType string `json:"resource_type"`
Region *Region `json:"region,omitempty"`
RegionSlug string `json:"region_slug,omitempty"`
}
Action represents a Abrha Action
type ActionRequest ¶
type ActionRequest map[string]interface{}
ActionRequest represents Abrha Action Request
type ActionsService ¶
type ActionsService interface {
List(context.Context, *ListOptions) ([]Action, *Response, error)
Get(context.Context, int) (*Action, *Response, error)
}
ActionsService handles communication with action related methods of the See: https://docs.parspack.com/reference/api/cloud-server/#tag/Actions
type ActionsServiceOp ¶
type ActionsServiceOp struct {
// contains filtered or unexported fields
}
ActionsServiceOp handles communication with the image action related methods of the API.
func (*ActionsServiceOp) List ¶
func (s *ActionsServiceOp) List(ctx context.Context, opt *ListOptions) ([]Action, *Response, error)
List all actions
type Address ¶
type Address struct {
AddressLine1 string `json:"address_line1"`
AddressLine2 string `json:"address_line2"`
City string `json:"city"`
Region string `json:"region"`
PostalCode string `json:"postal_code"`
CountryISO2Code string `json:"country_iso2_code"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
}
Address represents the billing address of a customer
type AlertDestinationUpdateRequest ¶
type AlertDestinationUpdateRequest struct {
Emails []string `json:"emails"`
SlackWebhooks []*AppAlertSlackWebhook `json:"slack_webhooks"`
}
AlertDestinationUpdateRequest represents a request to update alert destinations.
type AlertPolicy ¶
type AlertPolicy struct {
UUID string `json:"uuid"`
Type string `json:"type"`
Description string `json:"description"`
Compare AlertPolicyComp `json:"compare"`
Value float32 `json:"value"`
Window string `json:"window"`
Entities []string `json:"entities"`
Tags []string `json:"tags"`
Alerts Alerts `json:"alerts"`
Enabled bool `json:"enabled"`
}
AlertPolicy represents a Abrha alert policy
type AlertPolicyComp ¶
type AlertPolicyComp string
AlertPolicyComp represents an alert policy comparison operation
const ( // GreaterThan is the comparison > GreaterThan AlertPolicyComp = "GreaterThan" // LessThan is the comparison < LessThan AlertPolicyComp = "LessThan" )
type AlertPolicyCreateRequest ¶
type AlertPolicyCreateRequest struct {
Type string `json:"type"`
Description string `json:"description"`
Compare AlertPolicyComp `json:"compare"`
Value float32 `json:"value"`
Window string `json:"window"`
Entities []string `json:"entities"`
Tags []string `json:"tags"`
Alerts Alerts `json:"alerts"`
Enabled *bool `json:"enabled"`
}
AlertPolicyCreateRequest holds the info for creating a new alert policy
type AlertPolicyUpdateRequest ¶
type AlertPolicyUpdateRequest struct {
Type string `json:"type"`
Description string `json:"description"`
Compare AlertPolicyComp `json:"compare"`
Value float32 `json:"value"`
Window string `json:"window"`
Entities []string `json:"entities"`
Tags []string `json:"tags"`
Alerts Alerts `json:"alerts"`
Enabled *bool `json:"enabled"`
}
AlertPolicyUpdateRequest holds the info for updating an existing alert policy
type Alerts ¶
type Alerts struct {
Slack []SlackDetails `json:"slack"`
Email []string `json:"email"`
}
Alerts represents the alerts section of an alert policy
type App ¶
type App struct {
ID string `json:"id,omitempty"`
OwnerUUID string `json:"owner_uuid,omitempty"`
Spec *AppSpec `json:"spec"`
LastDeploymentActiveAt time.Time `json:"last_deployment_active_at,omitempty"`
DefaultIngress string `json:"default_ingress,omitempty"`
CreatedAt time.Time `json:"created_at,omitempty"`
UpdatedAt time.Time `json:"updated_at,omitempty"`
ActiveDeployment *Deployment `json:"active_deployment,omitempty"`
InProgressDeployment *Deployment `json:"in_progress_deployment,omitempty"`
PendingDeployment *Deployment `json:"pending_deployment,omitempty"`
LastDeploymentCreatedAt time.Time `json:"last_deployment_created_at,omitempty"`
LiveURL string `json:"live_url,omitempty"`
Region *AppRegion `json:"region,omitempty"`
TierSlug string `json:"tier_slug,omitempty"`
LiveURLBase string `json:"live_url_base,omitempty"`
LiveDomain string `json:"live_domain,omitempty"`
Domains []*AppDomain `json:"domains,omitempty"`
PinnedDeployment *Deployment `json:"pinned_deployment,omitempty"`
BuildConfig *AppBuildConfig `json:"build_config,omitempty"`
// The id of the project for the app. This will be empty if there is a fleet (project) lookup failure.
ProjectID string `json:"project_id,omitempty"`
// The dedicated egress ip addresses associated with the app.
DedicatedIps []*AppDedicatedIp `json:"dedicated_ips,omitempty"`
}
App An application's configuration and status.
func (*App) GetActiveDeployment ¶
func (a *App) GetActiveDeployment() *Deployment
GetActiveDeployment returns the ActiveDeployment field.
func (*App) GetBuildConfig ¶
func (a *App) GetBuildConfig() *AppBuildConfig
GetBuildConfig returns the BuildConfig field.
func (*App) GetCreatedAt ¶
GetCreatedAt returns the CreatedAt field.
func (*App) GetDedicatedIps ¶
func (a *App) GetDedicatedIps() []*AppDedicatedIp
GetDedicatedIps returns the DedicatedIps field.
func (*App) GetDefaultIngress ¶
GetDefaultIngress returns the DefaultIngress field.
func (*App) GetDomains ¶
GetDomains returns the Domains field.
func (*App) GetInProgressDeployment ¶
func (a *App) GetInProgressDeployment() *Deployment
GetInProgressDeployment returns the InProgressDeployment field.
func (*App) GetLastDeploymentActiveAt ¶
GetLastDeploymentActiveAt returns the LastDeploymentActiveAt field.
func (*App) GetLastDeploymentCreatedAt ¶
GetLastDeploymentCreatedAt returns the LastDeploymentCreatedAt field.
func (*App) GetLiveDomain ¶
GetLiveDomain returns the LiveDomain field.
func (*App) GetLiveURLBase ¶
GetLiveURLBase returns the LiveURLBase field.
func (*App) GetOwnerUUID ¶
GetOwnerUUID returns the OwnerUUID field.
func (*App) GetPendingDeployment ¶
func (a *App) GetPendingDeployment() *Deployment
GetPendingDeployment returns the PendingDeployment field.
func (*App) GetPinnedDeployment ¶
func (a *App) GetPinnedDeployment() *Deployment
GetPinnedDeployment returns the PinnedDeployment field.
func (*App) GetProjectID ¶
GetProjectID returns the ProjectID field.
func (*App) GetTierSlug ¶
GetTierSlug returns the TierSlug field.
func (*App) GetUpdatedAt ¶
GetUpdatedAt returns the UpdatedAt field.
type AppAlert ¶
type AppAlert struct {
// The ID of the alert. This will be auto-generated by App Platform once the spec is submitted.
ID string `json:"id,omitempty"`
// Name of the component this alert applies to.
ComponentName string `json:"component_name,omitempty"`
Spec *AppAlertSpec `json:"spec,omitempty"`
// Email destinations for the alert when triggered.
Emails []string `json:"emails,omitempty"`
// Slack webhook destinations for the alert when triggered.
SlackWebhooks []*AppAlertSlackWebhook `json:"slack_webhooks,omitempty"`
Phase AppAlertPhase `json:"phase,omitempty"`
Progress *AppAlertProgress `json:"progress,omitempty"`
}
AppAlert Represents an alert configured for an app or component.
func (*AppAlert) GetComponentName ¶
GetComponentName returns the ComponentName field.
func (*AppAlert) GetPhase ¶
func (a *AppAlert) GetPhase() AppAlertPhase
GetPhase returns the Phase field.
func (*AppAlert) GetProgress ¶
func (a *AppAlert) GetProgress() *AppAlertProgress
GetProgress returns the Progress field.
func (*AppAlert) GetSlackWebhooks ¶
func (a *AppAlert) GetSlackWebhooks() []*AppAlertSlackWebhook
GetSlackWebhooks returns the SlackWebhooks field.
func (*AppAlert) GetSpec ¶
func (a *AppAlert) GetSpec() *AppAlertSpec
GetSpec returns the Spec field.
type AppAlertPhase ¶
type AppAlertPhase string
AppAlertPhase the model 'AppAlertPhase'
const ( AppAlertPhase_Unknown AppAlertPhase = "UNKNOWN" AppAlertPhase_Pending AppAlertPhase = "PENDING" AppAlertPhase_Configuring AppAlertPhase = "CONFIGURING" AppAlertPhase_Active AppAlertPhase = "ACTIVE" AppAlertPhase_Error AppAlertPhase = "ERROR" )
List of AppAlertPhase
type AppAlertProgress ¶
type AppAlertProgress struct {
Steps []*AppAlertProgressStep `json:"steps,omitempty"`
}
AppAlertProgress struct for AppAlertProgress
func (*AppAlertProgress) GetSteps ¶
func (a *AppAlertProgress) GetSteps() []*AppAlertProgressStep
GetSteps returns the Steps field.
type AppAlertProgressStep ¶
type AppAlertProgressStep struct {
Name string `json:"name,omitempty"`
Status AppAlertProgressStepStatus `json:"status,omitempty"`
Steps []*AppAlertProgressStep `json:"steps,omitempty"`
StartedAt time.Time `json:"started_at,omitempty"`
EndedAt time.Time `json:"ended_at,omitempty"`
Reason *AppAlertProgressStepReason `json:"reason,omitempty"`
}
AppAlertProgressStep struct for AppAlertProgressStep
func (*AppAlertProgressStep) GetEndedAt ¶
func (a *AppAlertProgressStep) GetEndedAt() time.Time
GetEndedAt returns the EndedAt field.
func (*AppAlertProgressStep) GetName ¶
func (a *AppAlertProgressStep) GetName() string
GetName returns the Name field.
func (*AppAlertProgressStep) GetReason ¶
func (a *AppAlertProgressStep) GetReason() *AppAlertProgressStepReason
GetReason returns the Reason field.
func (*AppAlertProgressStep) GetStartedAt ¶
func (a *AppAlertProgressStep) GetStartedAt() time.Time
GetStartedAt returns the StartedAt field.
func (*AppAlertProgressStep) GetStatus ¶
func (a *AppAlertProgressStep) GetStatus() AppAlertProgressStepStatus
GetStatus returns the Status field.
func (*AppAlertProgressStep) GetSteps ¶
func (a *AppAlertProgressStep) GetSteps() []*AppAlertProgressStep
GetSteps returns the Steps field.
type AppAlertProgressStepReason ¶
type AppAlertProgressStepReason struct {
Code string `json:"code,omitempty"`
Message string `json:"message,omitempty"`
}
AppAlertProgressStepReason struct for AppAlertProgressStepReason
func (*AppAlertProgressStepReason) GetCode ¶
func (a *AppAlertProgressStepReason) GetCode() string
GetCode returns the Code field.
func (*AppAlertProgressStepReason) GetMessage ¶
func (a *AppAlertProgressStepReason) GetMessage() string
GetMessage returns the Message field.
type AppAlertProgressStepStatus ¶
type AppAlertProgressStepStatus string
AppAlertProgressStepStatus the model 'AppAlertProgressStepStatus'
const ( AppAlertProgressStepStatus_Unknown AppAlertProgressStepStatus = "UNKNOWN" AppAlertProgressStepStatus_Pending AppAlertProgressStepStatus = "PENDING" AppAlertProgressStepStatus_Running AppAlertProgressStepStatus = "RUNNING" AppAlertProgressStepStatus_Error AppAlertProgressStepStatus = "ERROR" AppAlertProgressStepStatus_Success AppAlertProgressStepStatus = "SUCCESS" )
List of AppAlertProgressStepStatus
type AppAlertSlackWebhook ¶
type AppAlertSlackWebhook struct {
// URL for the Slack webhook.
URL string `json:"url,omitempty"`
// Name of the Slack channel.
Channel string `json:"channel,omitempty"`
}
AppAlertSlackWebhook Configuration of a Slack alerting destination.
func (*AppAlertSlackWebhook) GetChannel ¶
func (a *AppAlertSlackWebhook) GetChannel() string
GetChannel returns the Channel field.
func (*AppAlertSlackWebhook) GetURL ¶
func (a *AppAlertSlackWebhook) GetURL() string
GetURL returns the URL field.
type AppAlertSpec ¶
type AppAlertSpec struct {
Rule AppAlertSpecRule `json:"rule,omitempty"`
// Determines whether or not the alert is disabled.
Disabled bool `json:"disabled,omitempty"`
Operator AppAlertSpecOperator `json:"operator,omitempty"`
// The meaning is dependent upon the rule. It is used in conjunction with the operator and window to determine when an alert should trigger.
Value float32 `json:"value,omitempty"`
Window AppAlertSpecWindow `json:"window,omitempty"`
}
AppAlertSpec Configuration of an alert for the app or a individual component.
func (*AppAlertSpec) GetDisabled ¶
func (a *AppAlertSpec) GetDisabled() bool
GetDisabled returns the Disabled field.
func (*AppAlertSpec) GetOperator ¶
func (a *AppAlertSpec) GetOperator() AppAlertSpecOperator
GetOperator returns the Operator field.
func (*AppAlertSpec) GetRule ¶
func (a *AppAlertSpec) GetRule() AppAlertSpecRule
GetRule returns the Rule field.
func (*AppAlertSpec) GetValue ¶
func (a *AppAlertSpec) GetValue() float32
GetValue returns the Value field.
func (*AppAlertSpec) GetWindow ¶
func (a *AppAlertSpec) GetWindow() AppAlertSpecWindow
GetWindow returns the Window field.
type AppAlertSpecOperator ¶
type AppAlertSpecOperator string
AppAlertSpecOperator the model 'AppAlertSpecOperator'
const ( AppAlertSpecOperator_UnspecifiedOperator AppAlertSpecOperator = "UNSPECIFIED_OPERATOR" AppAlertSpecOperator_GreaterThan AppAlertSpecOperator = "GREATER_THAN" AppAlertSpecOperator_LessThan AppAlertSpecOperator = "LESS_THAN" )
List of AppAlertSpecOperator
type AppAlertSpecRule ¶
type AppAlertSpecRule string
AppAlertSpecRule - CPU_UTILIZATION: Represents CPU for a given container instance. Only applicable at the component level. - MEM_UTILIZATION: Represents RAM for a given container instance. Only applicable at the component level. - RESTART_COUNT: Represents restart count for a given container instance. Only applicable at the component level. - DEPLOYMENT_FAILED: Represents whether a deployment has failed. Only applicable at the app level. - DEPLOYMENT_LIVE: Represents whether a deployment has succeeded. Only applicable at the app level. - DEPLOYMENT_STARTED: Represents whether a deployment has started. Only applicable at the app level. - DEPLOYMENT_CANCELED: Represents whether a deployment has been canceled. Only applicable at the app level. - DOMAIN_FAILED: Represents whether a domain configuration has failed. Only applicable at the app level. - DOMAIN_LIVE: Represents whether a domain configuration has succeeded. Only applicable at the app level. - FUNCTIONS_ACTIVATION_COUNT: Represents an activation count for a given functions instance. Only applicable to functions components. - FUNCTIONS_AVERAGE_DURATION_MS: Represents the average duration for function runtimes. Only applicable to functions components. - FUNCTIONS_ERROR_RATE_PER_MINUTE: Represents an error rate per minute for a given functions instance. Only applicable to functions components. - FUNCTIONS_AVERAGE_WAIT_TIME_MS: Represents the average wait time for functions. Only applicable to functions components. - FUNCTIONS_ERROR_COUNT: Represents an error count for a given functions instance. Only applicable to functions components. - FUNCTIONS_GB_RATE_PER_SECOND: Represents the rate of memory consumption (GB x seconds) for functions. Only applicable to functions components.
const ( AppAlertSpecRule_UnspecifiedRule AppAlertSpecRule = "UNSPECIFIED_RULE" AppAlertSpecRule_CPUUtilization AppAlertSpecRule = "CPU_UTILIZATION" AppAlertSpecRule_MemUtilization AppAlertSpecRule = "MEM_UTILIZATION" AppAlertSpecRule_RestartCount AppAlertSpecRule = "RESTART_COUNT" AppAlertSpecRule_DeploymentFailed AppAlertSpecRule = "DEPLOYMENT_FAILED" AppAlertSpecRule_DeploymentLive AppAlertSpecRule = "DEPLOYMENT_LIVE" AppAlertSpecRule_DeploymentStarted AppAlertSpecRule = "DEPLOYMENT_STARTED" AppAlertSpecRule_DeploymentCanceled AppAlertSpecRule = "DEPLOYMENT_CANCELED" AppAlertSpecRule_DomainFailed AppAlertSpecRule = "DOMAIN_FAILED" AppAlertSpecRule_DomainLive AppAlertSpecRule = "DOMAIN_LIVE" AppAlertSpecRule_FunctionsActivationCount AppAlertSpecRule = "FUNCTIONS_ACTIVATION_COUNT" AppAlertSpecRule_FunctionsAverageDurationMS AppAlertSpecRule = "FUNCTIONS_AVERAGE_DURATION_MS" AppAlertSpecRule_FunctionsErrorRatePerMinute AppAlertSpecRule = "FUNCTIONS_ERROR_RATE_PER_MINUTE" AppAlertSpecRule_FunctionsAverageWaitTimeMs AppAlertSpecRule = "FUNCTIONS_AVERAGE_WAIT_TIME_MS" AppAlertSpecRule_FunctionsErrorCount AppAlertSpecRule = "FUNCTIONS_ERROR_COUNT" AppAlertSpecRule_FunctionsGBRatePerSecond AppAlertSpecRule = "FUNCTIONS_GB_RATE_PER_SECOND" )
List of AppAlertSpecRule
type AppAlertSpecWindow ¶
type AppAlertSpecWindow string
AppAlertSpecWindow the model 'AppAlertSpecWindow'
const ( AppAlertSpecWindow_UnspecifiedWindow AppAlertSpecWindow = "UNSPECIFIED_WINDOW" AppAlertSpecWindow_FiveMinutes AppAlertSpecWindow = "FIVE_MINUTES" AppAlertSpecWindow_TenMinutes AppAlertSpecWindow = "TEN_MINUTES" AppAlertSpecWindow_ThirtyMinutes AppAlertSpecWindow = "THIRTY_MINUTES" AppAlertSpecWindow_OneHour AppAlertSpecWindow = "ONE_HOUR" )
List of AppAlertSpecWindow
type AppAutoscalingSpec ¶
type AppAutoscalingSpec struct {
// The minimum amount of instances for this component.
MinInstanceCount int64 `json:"min_instance_count,omitempty"`
// The maximum amount of instances for this component.
MaxInstanceCount int64 `json:"max_instance_count,omitempty"`
Metrics *AppAutoscalingSpecMetrics `json:"metrics,omitempty"`
}
AppAutoscalingSpec struct for AppAutoscalingSpec
func (*AppAutoscalingSpec) GetMaxInstanceCount ¶
func (a *AppAutoscalingSpec) GetMaxInstanceCount() int64
GetMaxInstanceCount returns the MaxInstanceCount field.
func (*AppAutoscalingSpec) GetMetrics ¶
func (a *AppAutoscalingSpec) GetMetrics() *AppAutoscalingSpecMetrics
GetMetrics returns the Metrics field.
func (*AppAutoscalingSpec) GetMinInstanceCount ¶
func (a *AppAutoscalingSpec) GetMinInstanceCount() int64
GetMinInstanceCount returns the MinInstanceCount field.
type AppAutoscalingSpecMetricCPU ¶
type AppAutoscalingSpecMetricCPU struct {
// The average target CPU utilization for the component.
Percent int64 `json:"percent,omitempty"`
}
AppAutoscalingSpecMetricCPU struct for AppAutoscalingSpecMetricCPU
func (*AppAutoscalingSpecMetricCPU) GetPercent ¶
func (a *AppAutoscalingSpecMetricCPU) GetPercent() int64
GetPercent returns the Percent field.
type AppAutoscalingSpecMetrics ¶
type AppAutoscalingSpecMetrics struct {
CPU *AppAutoscalingSpecMetricCPU `json:"cpu,omitempty"`
}
AppAutoscalingSpecMetrics struct for AppAutoscalingSpecMetrics
func (*AppAutoscalingSpecMetrics) GetCPU ¶
func (a *AppAutoscalingSpecMetrics) GetCPU() *AppAutoscalingSpecMetricCPU
GetCPU returns the CPU field.
type AppBuildConfig ¶
type AppBuildConfig struct {
CNBVersioning *AppBuildConfigCNBVersioning `json:"cnb_versioning,omitempty"`
}
AppBuildConfig struct for AppBuildConfig
func (*AppBuildConfig) GetCNBVersioning ¶
func (a *AppBuildConfig) GetCNBVersioning() *AppBuildConfigCNBVersioning
GetCNBVersioning returns the CNBVersioning field.
type AppBuildConfigCNBVersioning ¶
type AppBuildConfigCNBVersioning struct {
// List of versioned buildpacks used for the application. Buildpacks are only versioned based on the major semver version, therefore exact versions will not be available at the app build config.
Buildpacks []*Buildpack `json:"buildpacks,omitempty"`
// A version id that represents the underlying CNB stack. The version of the stack indicates what buildpacks are supported.
StackID string `json:"stack_id,omitempty"`
}
AppBuildConfigCNBVersioning struct for AppBuildConfigCNBVersioning
func (*AppBuildConfigCNBVersioning) GetBuildpacks ¶
func (a *AppBuildConfigCNBVersioning) GetBuildpacks() []*Buildpack
GetBuildpacks returns the Buildpacks field.
func (*AppBuildConfigCNBVersioning) GetStackID ¶
func (a *AppBuildConfigCNBVersioning) GetStackID() string
GetStackID returns the StackID field.
type AppBuildableComponentSpec ¶
type AppBuildableComponentSpec interface {
AppComponentSpec
GetGit() *GitSourceSpec
GetGitHub() *GitHubSourceSpec
GetGitLab() *GitLabSourceSpec
GetBitbucket() *BitbucketSourceSpec
GetSourceDir() string
GetEnvs() []*AppVariableDefinition
}
AppBuildableComponentSpec is a component that is buildable from source.
type AppCNBBuildableComponentSpec ¶
type AppCNBBuildableComponentSpec interface {
AppBuildableComponentSpec
GetBuildCommand() string
}
AppCNBBuildableComponentSpec is a component that is buildable from source using cloud native buildpacks.
type AppCORSPolicy ¶
type AppCORSPolicy struct {
// The set of allowed CORS origins. This configures the Access-Control-Allow-Origin header.
AllowOrigins []*AppStringMatch `json:"allow_origins,omitempty"`
// The set of allowed HTTP methods. This configures the Access-Control-Allow-Methods header.
AllowMethods []string `json:"allow_methods,omitempty"`
// The set of allowed HTTP request headers. This configures the Access-Control-Allow-Headers header.
AllowHeaders []string `json:"allow_headers,omitempty"`
// The set of HTTP response headers that browsers are allowed to access. This configures the Access-Control-Expose-Headers header.
ExposeHeaders []string `json:"expose_headers,omitempty"`
// An optional duration specifying how long browsers can cache the results of a preflight request. This configures the Access-Control-Max-Age header. Example: `5h30m`.
MaxAge string `json:"max_age,omitempty"`
// Whether browsers should expose the response to the client-side JavaScript code when the request's credentials mode is `include`. This configures the Access-Control-Allow-Credentials header.
AllowCredentials bool `json:"allow_credentials,omitempty"`
}
AppCORSPolicy struct for AppCORSPolicy
func (*AppCORSPolicy) GetAllowCredentials ¶
func (a *AppCORSPolicy) GetAllowCredentials() bool
GetAllowCredentials returns the AllowCredentials field.
func (*AppCORSPolicy) GetAllowHeaders ¶
func (a *AppCORSPolicy) GetAllowHeaders() []string
GetAllowHeaders returns the AllowHeaders field.
func (*AppCORSPolicy) GetAllowMethods ¶
func (a *AppCORSPolicy) GetAllowMethods() []string
GetAllowMethods returns the AllowMethods field.
func (*AppCORSPolicy) GetAllowOrigins ¶
func (a *AppCORSPolicy) GetAllowOrigins() []*AppStringMatch
GetAllowOrigins returns the AllowOrigins field.
func (*AppCORSPolicy) GetExposeHeaders ¶
func (a *AppCORSPolicy) GetExposeHeaders() []string
GetExposeHeaders returns the ExposeHeaders field.
func (*AppCORSPolicy) GetMaxAge ¶
func (a *AppCORSPolicy) GetMaxAge() string
GetMaxAge returns the MaxAge field.
type AppComponentSpec ¶
type AppComponentSpec interface {
GetName() string
GetType() AppComponentType
}
AppComponentSpec represents a component's spec.
type AppComponentType ¶
type AppComponentType string
AppComponentType is an app component type.
const ( // AppComponentTypeService is the type for a service component. AppComponentTypeService AppComponentType = "service" // AppComponentTypeWorker is the type for a worker component. AppComponentTypeWorker AppComponentType = "worker" // AppComponentTypeJob is the type for a job component. AppComponentTypeJob AppComponentType = "job" // AppComponentTypeStaticSite is the type for a static site component. AppComponentTypeStaticSite AppComponentType = "static_site" // AppComponentTypeDatabase is the type for a database component. AppComponentTypeDatabase AppComponentType = "database" // AppComponentTypeFunctions is the type for a functions component. AppComponentTypeFunctions AppComponentType = "functions" )
type AppContainerComponentSpec ¶
type AppContainerComponentSpec interface {
AppBuildableComponentSpec
GetImage() *ImageSourceSpec
GetRunCommand() string
GetInstanceSizeSlug() string
GetInstanceCount() int64
}
AppContainerComponentSpec is a component that runs in a cluster.
type AppCreateRequest ¶
type AppCreateRequest struct {
Spec *AppSpec `json:"spec"`
// Optional. The UUID of the project the app should be assigned.
ProjectID string `json:"project_id,omitempty"`
}
AppCreateRequest struct for AppCreateRequest
func (*AppCreateRequest) GetProjectID ¶
func (a *AppCreateRequest) GetProjectID() string
GetProjectID returns the ProjectID field.
func (*AppCreateRequest) GetSpec ¶
func (a *AppCreateRequest) GetSpec() *AppSpec
GetSpec returns the Spec field.
type AppDatabaseSpec ¶
type AppDatabaseSpec struct {
// The database's name. The name must be unique across all components within the same app and cannot use capital letters.
Name string `json:"name"`
Engine AppDatabaseSpecEngine `json:"engine,omitempty"`
Version string `json:"version,omitempty"`
// Deprecated.
Size string `json:"size,omitempty"`
// Deprecated.
NumNodes int64 `json:"num_nodes,omitempty"`
// Whether this is a production or dev database.
Production bool `json:"production,omitempty"`
// The name of the underlying Abrha DBaaS cluster. This is required for production databases. For dev databases, if cluster_name is not set, a new cluster will be provisioned.
ClusterName string `json:"cluster_name,omitempty"`
// The name of the MySQL or PostgreSQL database to configure.
DBName string `json:"db_name,omitempty"`
// The name of the MySQL or PostgreSQL user to configure.
DBUser string `json:"db_user,omitempty"`
}
AppDatabaseSpec struct for AppDatabaseSpec
func (*AppDatabaseSpec) GetClusterName ¶
func (a *AppDatabaseSpec) GetClusterName() string
GetClusterName returns the ClusterName field.
func (*AppDatabaseSpec) GetDBName ¶
func (a *AppDatabaseSpec) GetDBName() string
GetDBName returns the DBName field.
func (*AppDatabaseSpec) GetDBUser ¶
func (a *AppDatabaseSpec) GetDBUser() string
GetDBUser returns the DBUser field.
func (*AppDatabaseSpec) GetEngine ¶
func (a *AppDatabaseSpec) GetEngine() AppDatabaseSpecEngine
GetEngine returns the Engine field.
func (*AppDatabaseSpec) GetName ¶
func (a *AppDatabaseSpec) GetName() string
GetName returns the Name field.
func (*AppDatabaseSpec) GetNumNodes ¶
func (a *AppDatabaseSpec) GetNumNodes() int64
GetNumNodes returns the NumNodes field.
func (*AppDatabaseSpec) GetProduction ¶
func (a *AppDatabaseSpec) GetProduction() bool
GetProduction returns the Production field.
func (*AppDatabaseSpec) GetSize ¶
func (a *AppDatabaseSpec) GetSize() string
GetSize returns the Size field.
func (*AppDatabaseSpec) GetType ¶
func (s *AppDatabaseSpec) GetType() AppComponentType
GetType returns the Database component type.
func (*AppDatabaseSpec) GetVersion ¶
func (a *AppDatabaseSpec) GetVersion() string
GetVersion returns the Version field.
type AppDatabaseSpecEngine ¶
type AppDatabaseSpecEngine string
AppDatabaseSpecEngine the model 'AppDatabaseSpecEngine'
const ( AppDatabaseSpecEngine_Unset AppDatabaseSpecEngine = "UNSET" AppDatabaseSpecEngine_MySQL AppDatabaseSpecEngine = "MYSQL" AppDatabaseSpecEngine_PG AppDatabaseSpecEngine = "PG" AppDatabaseSpecEngine_Redis AppDatabaseSpecEngine = "REDIS" AppDatabaseSpecEngine_MongoDB AppDatabaseSpecEngine = "MONGODB" AppDatabaseSpecEngine_Kafka AppDatabaseSpecEngine = "KAFKA" AppDatabaseSpecEngine_Opensearch AppDatabaseSpecEngine = "OPENSEARCH" )
List of AppDatabaseSpecEngine
type AppDedicatedIp ¶
type AppDedicatedIp struct {
// The ip address of the dedicated egress ip.
Ip string `json:"ip,omitempty"`
// The id of the dedictated egress ip.
ID string `json:"id,omitempty"`
Status AppDedicatedIpStatus `json:"status,omitempty"`
}
AppDedicatedIp Represents a dedicated egress ip.
func (*AppDedicatedIp) GetStatus ¶
func (a *AppDedicatedIp) GetStatus() AppDedicatedIpStatus
GetStatus returns the Status field.
type AppDedicatedIpStatus ¶
type AppDedicatedIpStatus string
AppDedicatedIpStatus the model 'AppDedicatedIpStatus'
const ( APPDEDICATEDIPSTATUS_Unknown AppDedicatedIpStatus = "UNKNOWN" APPDEDICATEDIPSTATUS_Assigning AppDedicatedIpStatus = "ASSIGNING" APPDEDICATEDIPSTATUS_Assigned AppDedicatedIpStatus = "ASSIGNED" APPDEDICATEDIPSTATUS_Removed AppDedicatedIpStatus = "REMOVED" )
List of AppDedicatedIPStatus
type AppDockerBuildableComponentSpec ¶
type AppDockerBuildableComponentSpec interface {
AppBuildableComponentSpec
GetDockerfilePath() string
}
AppDockerBuildableComponentSpec is a component that is buildable from source using Docker.
type AppDomain ¶
type AppDomain struct {
ID string `json:"id,omitempty"`
Spec *AppDomainSpec `json:"spec,omitempty"`
Phase AppDomainPhase `json:"phase,omitempty"`
Progress *AppDomainProgress `json:"progress,omitempty"`
Validation *AppDomainValidation `json:"validation,omitempty"`
Validations []*AppDomainValidation `json:"validations,omitempty"`
RotateValidationRecords bool `json:"rotate_validation_records,omitempty"`
CertificateExpiresAt time.Time `json:"certificate_expires_at,omitempty"`
}
AppDomain struct for AppDomain
func (*AppDomain) GetCertificateExpiresAt ¶
GetCertificateExpiresAt returns the CertificateExpiresAt field.
func (*AppDomain) GetPhase ¶
func (a *AppDomain) GetPhase() AppDomainPhase
GetPhase returns the Phase field.
func (*AppDomain) GetProgress ¶
func (a *AppDomain) GetProgress() *AppDomainProgress
GetProgress returns the Progress field.
func (*AppDomain) GetRotateValidationRecords ¶
GetRotateValidationRecords returns the RotateValidationRecords field.
func (*AppDomain) GetSpec ¶
func (a *AppDomain) GetSpec() *AppDomainSpec
GetSpec returns the Spec field.
func (*AppDomain) GetValidation ¶
func (a *AppDomain) GetValidation() *AppDomainValidation
GetValidation returns the Validation field.
func (*AppDomain) GetValidations ¶
func (a *AppDomain) GetValidations() []*AppDomainValidation
GetValidations returns the Validations field.
type AppDomainPhase ¶
type AppDomainPhase string
AppDomainPhase the model 'AppDomainPhase'
const ( AppJobSpecKindPHASE_Unknown AppDomainPhase = "UNKNOWN" AppJobSpecKindPHASE_Pending AppDomainPhase = "PENDING" AppJobSpecKindPHASE_Configuring AppDomainPhase = "CONFIGURING" AppJobSpecKindPHASE_Active AppDomainPhase = "ACTIVE" AppJobSpecKindPHASE_Error AppDomainPhase = "ERROR" )
List of AppDomainPhase
type AppDomainProgress ¶
type AppDomainProgress struct {
Steps []*AppDomainProgressStep `json:"steps,omitempty"`
}
AppDomainProgress struct for AppDomainProgress
func (*AppDomainProgress) GetSteps ¶
func (a *AppDomainProgress) GetSteps() []*AppDomainProgressStep
GetSteps returns the Steps field.
type AppDomainProgressStep ¶
type AppDomainProgressStep struct {
Name string `json:"name,omitempty"`
Status AppDomainProgressStepStatus `json:"status,omitempty"`
Steps []*AppDomainProgressStep `json:"steps,omitempty"`
StartedAt time.Time `json:"started_at,omitempty"`
EndedAt time.Time `json:"ended_at,omitempty"`
Reason *AppDomainProgressStepReason `json:"reason,omitempty"`
}
AppDomainProgressStep struct for AppDomainProgressStep
func (*AppDomainProgressStep) GetEndedAt ¶
func (a *AppDomainProgressStep) GetEndedAt() time.Time
GetEndedAt returns the EndedAt field.
func (*AppDomainProgressStep) GetName ¶
func (a *AppDomainProgressStep) GetName() string
GetName returns the Name field.
func (*AppDomainProgressStep) GetReason ¶
func (a *AppDomainProgressStep) GetReason() *AppDomainProgressStepReason
GetReason returns the Reason field.
func (*AppDomainProgressStep) GetStartedAt ¶
func (a *AppDomainProgressStep) GetStartedAt() time.Time
GetStartedAt returns the StartedAt field.
func (*AppDomainProgressStep) GetStatus ¶
func (a *AppDomainProgressStep) GetStatus() AppDomainProgressStepStatus
GetStatus returns the Status field.
func (*AppDomainProgressStep) GetSteps ¶
func (a *AppDomainProgressStep) GetSteps() []*AppDomainProgressStep
GetSteps returns the Steps field.
type AppDomainProgressStepReason ¶
type AppDomainProgressStepReason struct {
Code string `json:"code,omitempty"`
Message string `json:"message,omitempty"`
}
AppDomainProgressStepReason struct for AppDomainProgressStepReason
func (*AppDomainProgressStepReason) GetCode ¶
func (a *AppDomainProgressStepReason) GetCode() string
GetCode returns the Code field.
func (*AppDomainProgressStepReason) GetMessage ¶
func (a *AppDomainProgressStepReason) GetMessage() string
GetMessage returns the Message field.
type AppDomainProgressStepStatus ¶
type AppDomainProgressStepStatus string
AppDomainProgressStepStatus the model 'AppDomainProgressStepStatus'
const ( AppJobSpecKindProgressStepStatus_Unknown AppDomainProgressStepStatus = "UNKNOWN" AppJobSpecKindProgressStepStatus_Pending AppDomainProgressStepStatus = "PENDING" AppJobSpecKindProgressStepStatus_Running AppDomainProgressStepStatus = "RUNNING" AppJobSpecKindProgressStepStatus_Error AppDomainProgressStepStatus = "ERROR" AppJobSpecKindProgressStepStatus_Success AppDomainProgressStepStatus = "SUCCESS" )
List of AppDomainProgressStepStatus
type AppDomainSpec ¶
type AppDomainSpec struct {
Domain string `json:"domain"`
Type AppDomainSpecType `json:"type,omitempty"`
Wildcard bool `json:"wildcard,omitempty"`
// Optional. If the domain uses Abrha DNS and you would like App Platform to automatically manage it for you, set this to the name of the domain on your account. For example, If the domain you are adding is `app.domain.com`, the zone could be `domain.com`.
Zone string `json:"zone,omitempty"`
Certificate string `json:"certificate,omitempty"`
// Optional. The minimum version of TLS a client application can use to access resources for the domain. Must be one of the following values wrapped within quotations: `\"1.2\"` or `\"1.3\"`.
MinimumTLSVersion string `json:"minimum_tls_version,omitempty"`
}
AppDomainSpec struct for AppDomainSpec
func (*AppDomainSpec) GetCertificate ¶
func (a *AppDomainSpec) GetCertificate() string
GetCertificate returns the Certificate field.
func (*AppDomainSpec) GetDomain ¶
func (a *AppDomainSpec) GetDomain() string
GetDomain returns the Domain field.
func (*AppDomainSpec) GetMinimumTLSVersion ¶
func (a *AppDomainSpec) GetMinimumTLSVersion() string
GetMinimumTLSVersion returns the MinimumTLSVersion field.
func (*AppDomainSpec) GetType ¶
func (a *AppDomainSpec) GetType() AppDomainSpecType
GetType returns the Type field.
func (*AppDomainSpec) GetWildcard ¶
func (a *AppDomainSpec) GetWildcard() bool
GetWildcard returns the Wildcard field.
func (*AppDomainSpec) GetZone ¶
func (a *AppDomainSpec) GetZone() string
GetZone returns the Zone field.
type AppDomainSpecType ¶
type AppDomainSpecType string
AppDomainSpecType the model 'AppDomainSpecType'
const ( AppDomainSpecType_Unspecified AppDomainSpecType = "UNSPECIFIED" AppDomainSpecType_Default AppDomainSpecType = "DEFAULT" AppDomainSpecType_Primary AppDomainSpecType = "PRIMARY" AppDomainSpecType_Alias AppDomainSpecType = "ALIAS" )
List of AppDomainSpecType
type AppDomainValidation ¶
type AppDomainValidation struct {
TXTName string `json:"txt_name,omitempty"`
TXTValue string `json:"txt_value,omitempty"`
}
AppDomainValidation struct for AppDomainValidation
func (*AppDomainValidation) GetTXTName ¶
func (a *AppDomainValidation) GetTXTName() string
GetTXTName returns the TXTName field.
func (*AppDomainValidation) GetTXTValue ¶
func (a *AppDomainValidation) GetTXTValue() string
GetTXTValue returns the TXTValue field.
type AppEgressSpec ¶
type AppEgressSpec struct {
Type AppEgressSpecType `json:"type,omitempty"`
}
AppEgressSpec Specification for app egress configurations.
func (*AppEgressSpec) GetType ¶
func (a *AppEgressSpec) GetType() AppEgressSpecType
GetType returns the Type field.
type AppEgressSpecType ¶
type AppEgressSpecType string
AppEgressSpecType the model 'AppEgressSpecType'
const ( APPEGRESSSPECTYPE_Autoassign AppEgressSpecType = "AUTOASSIGN" APPEGRESSSPECTYPE_DedicatedIp AppEgressSpecType = "DEDICATED_IP" )
List of AppEgressSpecType
type AppExec ¶
type AppExec struct {
URL string `json:"url"`
}
AppExec represents the websocket URL used for sending/receiving console input and output.
type AppFunctionsSpec ¶
type AppFunctionsSpec struct {
// The name. Must be unique across all components within the same app.
Name string `json:"name"`
Git *GitSourceSpec `json:"git,omitempty"`
GitHub *GitHubSourceSpec `json:"github,omitempty"`
GitLab *GitLabSourceSpec `json:"gitlab,omitempty"`
Bitbucket *BitbucketSourceSpec `json:"bitbucket,omitempty"`
// An optional path to the working directory to use for the build. Must be relative to the root of the repo.
SourceDir string `json:"source_dir,omitempty"`
// A list of environment variables made available to the component.
Envs []*AppVariableDefinition `json:"envs,omitempty"`
// (Deprecated) A list of HTTP routes that should be routed to this component.
Routes []*AppRouteSpec `json:"routes,omitempty"`
// A list of configured alerts the user has enabled.
Alerts []*AppAlertSpec `json:"alerts,omitempty"`
// A list of configured log forwarding destinations.
LogDestinations []*AppLogDestinationSpec `json:"log_destinations,omitempty"`
CORS *AppCORSPolicy `json:"cors,omitempty"`
}
AppFunctionsSpec struct for AppFunctionsSpec
func (*AppFunctionsSpec) GetAlerts ¶
func (a *AppFunctionsSpec) GetAlerts() []*AppAlertSpec
GetAlerts returns the Alerts field.
func (*AppFunctionsSpec) GetBitbucket ¶
func (a *AppFunctionsSpec) GetBitbucket() *BitbucketSourceSpec
GetBitbucket returns the Bitbucket field.
func (*AppFunctionsSpec) GetCORS ¶
func (a *AppFunctionsSpec) GetCORS() *AppCORSPolicy
GetCORS returns the CORS field.
func (*AppFunctionsSpec) GetEnvs ¶
func (a *AppFunctionsSpec) GetEnvs() []*AppVariableDefinition
GetEnvs returns the Envs field.
func (*AppFunctionsSpec) GetGit ¶
func (a *AppFunctionsSpec) GetGit() *GitSourceSpec
GetGit returns the Git field.
func (*AppFunctionsSpec) GetGitHub ¶
func (a *AppFunctionsSpec) GetGitHub() *GitHubSourceSpec
GetGitHub returns the GitHub field.
func (*AppFunctionsSpec) GetGitLab ¶
func (a *AppFunctionsSpec) GetGitLab() *GitLabSourceSpec
GetGitLab returns the GitLab field.
func (*AppFunctionsSpec) GetLogDestinations ¶
func (a *AppFunctionsSpec) GetLogDestinations() []*AppLogDestinationSpec
GetLogDestinations returns the LogDestinations field.
func (*AppFunctionsSpec) GetName ¶
func (a *AppFunctionsSpec) GetName() string
GetName returns the Name field.
func (*AppFunctionsSpec) GetRoutes ¶
func (a *AppFunctionsSpec) GetRoutes() []*AppRouteSpec
GetRoutes returns the Routes field.
func (*AppFunctionsSpec) GetSourceDir ¶
func (a *AppFunctionsSpec) GetSourceDir() string
GetSourceDir returns the SourceDir field.
func (*AppFunctionsSpec) GetType ¶
func (s *AppFunctionsSpec) GetType() AppComponentType
GetType returns the Functions component type.
type AppIngressSpec ¶
type AppIngressSpec struct {
LoadBalancer AppIngressSpecLoadBalancer `json:"load_balancer,omitempty"`
LoadBalancerSize int64 `json:"load_balancer_size,omitempty"`
// Rules for configuring HTTP ingress for component routes, CORS, rewrites, and redirects.
Rules []*AppIngressSpecRule `json:"rules,omitempty"`
}
AppIngressSpec Specification for app ingress configurations.
func (*AppIngressSpec) GetLoadBalancer ¶
func (a *AppIngressSpec) GetLoadBalancer() AppIngressSpecLoadBalancer
GetLoadBalancer returns the LoadBalancer field.
func (*AppIngressSpec) GetLoadBalancerSize ¶
func (a *AppIngressSpec) GetLoadBalancerSize() int64
GetLoadBalancerSize returns the LoadBalancerSize field.
func (*AppIngressSpec) GetRules ¶
func (a *AppIngressSpec) GetRules() []*AppIngressSpecRule
GetRules returns the Rules field.
type AppIngressSpecLoadBalancer ¶
type AppIngressSpecLoadBalancer string
AppIngressSpecLoadBalancer the model 'AppIngressSpecLoadBalancer'
const ( AppIngressSpecLoadBalancer_Unknown AppIngressSpecLoadBalancer = "UNKNOWN" AppIngressSpecLoadBalancer_Abrha AppIngressSpecLoadBalancer = "PARSPACK" )
List of AppIngressSpecLoadBalancer
type AppIngressSpecRule ¶
type AppIngressSpecRule struct {
Match *AppIngressSpecRuleMatch `json:"match,omitempty"`
Component *AppIngressSpecRuleRoutingComponent `json:"component,omitempty"`
Redirect *AppIngressSpecRuleRoutingRedirect `json:"redirect,omitempty"`
CORS *AppCORSPolicy `json:"cors,omitempty"`
}
AppIngressSpecRule A rule that configures component routes, rewrites, redirects and cors.
func (*AppIngressSpecRule) GetCORS ¶
func (a *AppIngressSpecRule) GetCORS() *AppCORSPolicy
GetCORS returns the CORS field.
func (*AppIngressSpecRule) GetComponent ¶
func (a *AppIngressSpecRule) GetComponent() *AppIngressSpecRuleRoutingComponent
GetComponent returns the Component field.
func (*AppIngressSpecRule) GetMatch ¶
func (a *AppIngressSpecRule) GetMatch() *AppIngressSpecRuleMatch
GetMatch returns the Match field.
func (*AppIngressSpecRule) GetRedirect ¶
func (a *AppIngressSpecRule) GetRedirect() *AppIngressSpecRuleRoutingRedirect
GetRedirect returns the Redirect field.
type AppIngressSpecRuleMatch ¶
type AppIngressSpecRuleMatch struct {
Path *AppIngressSpecRuleStringMatch `json:"path,omitempty"`
}
AppIngressSpecRuleMatch The match configuration for a rule.
func (*AppIngressSpecRuleMatch) GetPath ¶
func (a *AppIngressSpecRuleMatch) GetPath() *AppIngressSpecRuleStringMatch
GetPath returns the Path field.
type AppIngressSpecRuleRoutingComponent ¶
type AppIngressSpecRuleRoutingComponent struct {
// The name of the component to route to.
Name string `json:"name,omitempty"`
// An optional flag to preserve the path that is forwarded to the backend service. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If this value is `true`, the path will remain `/api/list`. Note: this is not applicable for Functions Components and is mutually exclusive with `rewrite`.
PreservePathPrefix bool `json:"preserve_path_prefix,omitempty"`
// An optional field that will rewrite the path of the component to be what is specified here. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If you specified the rewrite to be `/v1/`, requests to `/api/list` would be rewritten to `/v1/list`. Note: this is mutually exclusive with `preserve_path_prefix`.
Rewrite string `json:"rewrite,omitempty"`
}
AppIngressSpecRuleRoutingComponent The component routing configuration.
func (*AppIngressSpecRuleRoutingComponent) GetName ¶
func (a *AppIngressSpecRuleRoutingComponent) GetName() string
GetName returns the Name field.
func (*AppIngressSpecRuleRoutingComponent) GetPreservePathPrefix ¶
func (a *AppIngressSpecRuleRoutingComponent) GetPreservePathPrefix() bool
GetPreservePathPrefix returns the PreservePathPrefix field.
func (*AppIngressSpecRuleRoutingComponent) GetRewrite ¶
func (a *AppIngressSpecRuleRoutingComponent) GetRewrite() string
GetRewrite returns the Rewrite field.
type AppIngressSpecRuleRoutingRedirect ¶
type AppIngressSpecRuleRoutingRedirect struct {
// An optional URI path to redirect to. Note: if this is specified the whole URI of the original request will be overwritten to this value, irrespective of the original request URI being matched.
Uri string `json:"uri,omitempty"`
// The authority/host to redirect to. This can be a hostname or IP address. Note: use `port` to set the port.
Authority string `json:"authority,omitempty"`
// The port to redirect to.
Port int64 `json:"port,omitempty"`
// The scheme to redirect to. Supported values are `http` or `https`. Default: `https`.
Scheme string `json:"scheme,omitempty"`
// The redirect code to use. Defaults to `302`. Supported values are 300, 301, 302, 303, 304, 307, 308.
RedirectCode int64 `json:"redirect_code,omitempty"`
}
AppIngressSpecRuleRoutingRedirect The redirect routing configuration.
func (*AppIngressSpecRuleRoutingRedirect) GetAuthority ¶
func (a *AppIngressSpecRuleRoutingRedirect) GetAuthority() string
GetAuthority returns the Authority field.
func (*AppIngressSpecRuleRoutingRedirect) GetPort ¶
func (a *AppIngressSpecRuleRoutingRedirect) GetPort() int64
GetPort returns the Port field.
func (*AppIngressSpecRuleRoutingRedirect) GetRedirectCode ¶
func (a *AppIngressSpecRuleRoutingRedirect) GetRedirectCode() int64
GetRedirectCode returns the RedirectCode field.
func (*AppIngressSpecRuleRoutingRedirect) GetScheme ¶
func (a *AppIngressSpecRuleRoutingRedirect) GetScheme() string
GetScheme returns the Scheme field.
func (*AppIngressSpecRuleRoutingRedirect) GetUri ¶
func (a *AppIngressSpecRuleRoutingRedirect) GetUri() string
GetUri returns the Uri field.
type AppIngressSpecRuleStringMatch ¶
type AppIngressSpecRuleStringMatch struct {
// Prefix-based match. For example, `/api` will match `/api`, `/api/`, and any nested paths such as `/api/v1/endpoint`.
Prefix string `json:"prefix,omitempty"`
}
AppIngressSpecRuleStringMatch The string match configuration.
func (*AppIngressSpecRuleStringMatch) GetPrefix ¶
func (a *AppIngressSpecRuleStringMatch) GetPrefix() string
GetPrefix returns the Prefix field.
type AppInstanceSize ¶
type AppInstanceSize struct {
Name string `json:"name,omitempty"`
Slug string `json:"slug,omitempty"`
CPUType AppInstanceSizeCPUType `json:"cpu_type,omitempty"`
CPUs string `json:"cpus,omitempty"`
MemoryBytes string `json:"memory_bytes,omitempty"`
USDPerMonth string `json:"usd_per_month,omitempty"`
USDPerSecond string `json:"usd_per_second,omitempty"`
TierSlug string `json:"tier_slug,omitempty"`
// (Deprecated) The slug of the corresponding upgradable instance size on the higher tier.
TierUpgradeTo string `json:"tier_upgrade_to,omitempty"`
// (Deprecated) The slug of the corresponding downgradable instance size on the lower tier.
TierDowngradeTo string `json:"tier_downgrade_to,omitempty"`
// Indicates if the tier instance size can enable autoscaling.
Scalable bool `json:"scalable,omitempty"`
// (Deprecated) Indicates if the tier instance size is in feature preview state.
FeaturePreview bool `json:"feature_preview,omitempty"`
// Indicates if the tier instance size allows more than one instance.
SingleInstanceOnly bool `json:"single_instance_only,omitempty"`
// Indicates if the tier instance size is intended for deprecation.
DeprecationIntent bool `json:"deprecation_intent,omitempty"`
// The bandwidth allowance in GiB for the tier instance size.
BandwidthAllowanceGib string `json:"bandwidth_allowance_gib,omitempty"`
}
AppInstanceSize struct for AppInstanceSize
func (*AppInstanceSize) GetBandwidthAllowanceGib ¶
func (a *AppInstanceSize) GetBandwidthAllowanceGib() string
GetBandwidthAllowanceGib returns the BandwidthAllowanceGib field.
func (*AppInstanceSize) GetCPUType ¶
func (a *AppInstanceSize) GetCPUType() AppInstanceSizeCPUType
GetCPUType returns the CPUType field.
func (*AppInstanceSize) GetCPUs ¶
func (a *AppInstanceSize) GetCPUs() string
GetCPUs returns the CPUs field.
func (*AppInstanceSize) GetDeprecationIntent ¶
func (a *AppInstanceSize) GetDeprecationIntent() bool
GetDeprecationIntent returns the DeprecationIntent field.
func (*AppInstanceSize) GetFeaturePreview ¶
func (a *AppInstanceSize) GetFeaturePreview() bool
GetFeaturePreview returns the FeaturePreview field.
func (*AppInstanceSize) GetMemoryBytes ¶
func (a *AppInstanceSize) GetMemoryBytes() string
GetMemoryBytes returns the MemoryBytes field.
func (*AppInstanceSize) GetName ¶
func (a *AppInstanceSize) GetName() string
GetName returns the Name field.
func (*AppInstanceSize) GetScalable ¶
func (a *AppInstanceSize) GetScalable() bool
GetScalable returns the Scalable field.
func (*AppInstanceSize) GetSingleInstanceOnly ¶
func (a *AppInstanceSize) GetSingleInstanceOnly() bool
GetSingleInstanceOnly returns the SingleInstanceOnly field.
func (*AppInstanceSize) GetSlug ¶
func (a *AppInstanceSize) GetSlug() string
GetSlug returns the Slug field.
func (*AppInstanceSize) GetTierDowngradeTo ¶
func (a *AppInstanceSize) GetTierDowngradeTo() string
GetTierDowngradeTo returns the TierDowngradeTo field.
func (*AppInstanceSize) GetTierSlug ¶
func (a *AppInstanceSize) GetTierSlug() string
GetTierSlug returns the TierSlug field.
func (*AppInstanceSize) GetTierUpgradeTo ¶
func (a *AppInstanceSize) GetTierUpgradeTo() string
GetTierUpgradeTo returns the TierUpgradeTo field.
func (*AppInstanceSize) GetUSDPerMonth ¶
func (a *AppInstanceSize) GetUSDPerMonth() string
GetUSDPerMonth returns the USDPerMonth field.
func (*AppInstanceSize) GetUSDPerSecond ¶
func (a *AppInstanceSize) GetUSDPerSecond() string
GetUSDPerSecond returns the USDPerSecond field.
type AppInstanceSizeCPUType ¶
type AppInstanceSizeCPUType string
AppInstanceSizeCPUType the model 'AppInstanceSizeCPUType'
const ( AppInstanceSizeCPUType_Unspecified AppInstanceSizeCPUType = "UNSPECIFIED" AppInstanceSizeCPUType_Dedicated AppInstanceSizeCPUType = "DEDICATED" )
List of AppInstanceSizeCPUType
type AppJobSpec ¶
type AppJobSpec struct {
// The name. Must be unique across all components within the same app.
Name string `json:"name"`
Git *GitSourceSpec `json:"git,omitempty"`
GitHub *GitHubSourceSpec `json:"github,omitempty"`
Image *ImageSourceSpec `json:"image,omitempty"`
GitLab *GitLabSourceSpec `json:"gitlab,omitempty"`
Bitbucket *BitbucketSourceSpec `json:"bitbucket,omitempty"`
// The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks.
DockerfilePath string `json:"dockerfile_path,omitempty"`
// An optional build command to run while building this component from source.
BuildCommand string `json:"build_command,omitempty"`
// An optional run command to override the component's default.
RunCommand string `json:"run_command,omitempty"`
// An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo.
SourceDir string `json:"source_dir,omitempty"`
// An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.parspack.com/docs/app-platform/).
EnvironmentSlug string `json:"environment_slug,omitempty"`
// A list of environment variables made available to the component.
Envs []*AppVariableDefinition `json:"envs,omitempty"`
// The instance size to use for this component.
InstanceSizeSlug string `json:"instance_size_slug,omitempty"`
InstanceCount int64 `json:"instance_count,omitempty"`
Kind AppJobSpecKind `json:"kind,omitempty"`
// A list of configured alerts which apply to the component.
Alerts []*AppAlertSpec `json:"alerts,omitempty"`
// A list of configured log forwarding destinations.
LogDestinations []*AppLogDestinationSpec `json:"log_destinations,omitempty"`
Termination *AppJobSpecTermination `json:"termination,omitempty"`
}
AppJobSpec struct for AppJobSpec
func (*AppJobSpec) GetAlerts ¶
func (a *AppJobSpec) GetAlerts() []*AppAlertSpec
GetAlerts returns the Alerts field.
func (*AppJobSpec) GetBitbucket ¶
func (a *AppJobSpec) GetBitbucket() *BitbucketSourceSpec
GetBitbucket returns the Bitbucket field.
func (*AppJobSpec) GetBuildCommand ¶
func (a *AppJobSpec) GetBuildCommand() string
GetBuildCommand returns the BuildCommand field.
func (*AppJobSpec) GetDockerfilePath ¶
func (a *AppJobSpec) GetDockerfilePath() string
GetDockerfilePath returns the DockerfilePath field.
func (*AppJobSpec) GetEnvironmentSlug ¶
func (a *AppJobSpec) GetEnvironmentSlug() string
GetEnvironmentSlug returns the EnvironmentSlug field.
func (*AppJobSpec) GetEnvs ¶
func (a *AppJobSpec) GetEnvs() []*AppVariableDefinition
GetEnvs returns the Envs field.
func (*AppJobSpec) GetGit ¶
func (a *AppJobSpec) GetGit() *GitSourceSpec
GetGit returns the Git field.
func (*AppJobSpec) GetGitHub ¶
func (a *AppJobSpec) GetGitHub() *GitHubSourceSpec
GetGitHub returns the GitHub field.
func (*AppJobSpec) GetGitLab ¶
func (a *AppJobSpec) GetGitLab() *GitLabSourceSpec
GetGitLab returns the GitLab field.
func (*AppJobSpec) GetImage ¶
func (a *AppJobSpec) GetImage() *ImageSourceSpec
GetImage returns the Image field.
func (*AppJobSpec) GetInstanceCount ¶
func (a *AppJobSpec) GetInstanceCount() int64
GetInstanceCount returns the InstanceCount field.
func (*AppJobSpec) GetInstanceSizeSlug ¶
func (a *AppJobSpec) GetInstanceSizeSlug() string
GetInstanceSizeSlug returns the InstanceSizeSlug field.
func (*AppJobSpec) GetKind ¶
func (a *AppJobSpec) GetKind() AppJobSpecKind
GetKind returns the Kind field.
func (*AppJobSpec) GetLogDestinations ¶
func (a *AppJobSpec) GetLogDestinations() []*AppLogDestinationSpec
GetLogDestinations returns the LogDestinations field.
func (*AppJobSpec) GetRunCommand ¶
func (a *AppJobSpec) GetRunCommand() string
GetRunCommand returns the RunCommand field.
func (*AppJobSpec) GetSourceDir ¶
func (a *AppJobSpec) GetSourceDir() string
GetSourceDir returns the SourceDir field.
func (*AppJobSpec) GetTermination ¶
func (a *AppJobSpec) GetTermination() *AppJobSpecTermination
GetTermination returns the Termination field.
func (*AppJobSpec) GetType ¶
func (s *AppJobSpec) GetType() AppComponentType
GetType returns the Job component type.
type AppJobSpecKind ¶
type AppJobSpecKind string
AppJobSpecKind - UNSPECIFIED: Default job type, will auto-complete to POST_DEPLOY kind. - PRE_DEPLOY: Indicates a job that runs before an app deployment. - POST_DEPLOY: Indicates a job that runs after an app deployment. - FAILED_DEPLOY: Indicates a job that runs after a component fails to deploy.
const ( AppJobSpecKind_Unspecified AppJobSpecKind = "UNSPECIFIED" AppJobSpecKind_PreDeploy AppJobSpecKind = "PRE_DEPLOY" AppJobSpecKind_PostDeploy AppJobSpecKind = "POST_DEPLOY" AppJobSpecKind_FailedDeploy AppJobSpecKind = "FAILED_DEPLOY" )
List of AppJobSpecKind
type AppJobSpecTermination ¶
type AppJobSpecTermination struct {
// The number of seconds to wait between sending a TERM signal to a container and issuing a KILL which causes immediate shutdown. Default: 120, Minimum 1, Maximum 600.
GracePeriodSeconds int32 `json:"grace_period_seconds,omitempty"`
}
AppJobSpecTermination struct for AppJobSpecTermination
func (*AppJobSpecTermination) GetGracePeriodSeconds ¶
func (a *AppJobSpecTermination) GetGracePeriodSeconds() int32
GetGracePeriodSeconds returns the GracePeriodSeconds field.
type AppLogDestinationSpec ¶
type AppLogDestinationSpec struct {
// Name of the log destination.
Name string `json:"name"`
Papertrail *AppLogDestinationSpecPapertrail `json:"papertrail,omitempty"`
Datadog *AppLogDestinationSpecDataDog `json:"datadog,omitempty"`
Logtail *AppLogDestinationSpecLogtail `json:"logtail,omitempty"`
OpenSearch *AppLogDestinationSpecOpenSearch `json:"open_search,omitempty"`
Endpoint string `json:"endpoint,omitempty"`
TLSInsecure bool `json:"tls_insecure,omitempty"`
Headers []*AppLogDestinationSpecHeader `json:"headers,omitempty"`
}
AppLogDestinationSpec struct for AppLogDestinationSpec
func (*AppLogDestinationSpec) GetDatadog ¶
func (a *AppLogDestinationSpec) GetDatadog() *AppLogDestinationSpecDataDog
GetDatadog returns the Datadog field.
func (*AppLogDestinationSpec) GetEndpoint ¶
func (a *AppLogDestinationSpec) GetEndpoint() string
GetEndpoint returns the Endpoint field.
func (*AppLogDestinationSpec) GetHeaders ¶
func (a *AppLogDestinationSpec) GetHeaders() []*AppLogDestinationSpecHeader
GetHeaders returns the Headers field.
func (*AppLogDestinationSpec) GetLogtail ¶
func (a *AppLogDestinationSpec) GetLogtail() *AppLogDestinationSpecLogtail
GetLogtail returns the Logtail field.
func (*AppLogDestinationSpec) GetName ¶
func (a *AppLogDestinationSpec) GetName() string
GetName returns the Name field.
func (*AppLogDestinationSpec) GetOpenSearch ¶
func (a *AppLogDestinationSpec) GetOpenSearch() *AppLogDestinationSpecOpenSearch
GetOpenSearch returns the OpenSearch field.
func (*AppLogDestinationSpec) GetPapertrail ¶
func (a *AppLogDestinationSpec) GetPapertrail() *AppLogDestinationSpecPapertrail
GetPapertrail returns the Papertrail field.
func (*AppLogDestinationSpec) GetTLSInsecure ¶
func (a *AppLogDestinationSpec) GetTLSInsecure() bool
GetTLSInsecure returns the TLSInsecure field.
type AppLogDestinationSpecDataDog ¶
type AppLogDestinationSpecDataDog struct {
// Datadog HTTP log intake endpoint.
Endpoint string `json:"endpoint,omitempty"`
// Datadog API key.
ApiKey string `json:"api_key"`
}
AppLogDestinationSpecDataDog DataDog configuration.
func (*AppLogDestinationSpecDataDog) GetApiKey ¶
func (a *AppLogDestinationSpecDataDog) GetApiKey() string
GetApiKey returns the ApiKey field.
func (*AppLogDestinationSpecDataDog) GetEndpoint ¶
func (a *AppLogDestinationSpecDataDog) GetEndpoint() string
GetEndpoint returns the Endpoint field.
type AppLogDestinationSpecHeader ¶
type AppLogDestinationSpecHeader struct {
// The name
Key string `json:"key"`
// The header value.
Value string `json:"value,omitempty"`
}
AppLogDestinationSpecHeader struct for AppLogDestinationSpecHeader
func (*AppLogDestinationSpecHeader) GetKey ¶
func (a *AppLogDestinationSpecHeader) GetKey() string
GetKey returns the Key field.
func (*AppLogDestinationSpecHeader) GetValue ¶
func (a *AppLogDestinationSpecHeader) GetValue() string
GetValue returns the Value field.
type AppLogDestinationSpecLogtail ¶
type AppLogDestinationSpecLogtail struct {
// Logtail token.
Token string `json:"token"`
}
AppLogDestinationSpecLogtail Logtail configuration.
func (*AppLogDestinationSpecLogtail) GetToken ¶
func (a *AppLogDestinationSpecLogtail) GetToken() string
GetToken returns the Token field.
type AppLogDestinationSpecOpenSearch ¶
type AppLogDestinationSpecOpenSearch struct {
// OpenSearch API Endpoint. Only HTTPS is supported. Format: https://<host>:<port>. Cannot be specified if `cluster_name` is also specified.
Endpoint string `json:"endpoint,omitempty"`
BasicAuth *OpenSearchBasicAuth `json:"basic_auth,omitempty"`
// The index name to use for the logs. If not set, the default index name is \"logs\".
IndexName string `json:"index_name,omitempty"`
// The name of a Abrha DBaaS OpenSearch cluster to use as a log forwarding destination. Cannot be specified if `endpoint` is also specified.
ClusterName string `json:"cluster_name,omitempty"`
}
AppLogDestinationSpecOpenSearch OpenSearch configuration.
func (*AppLogDestinationSpecOpenSearch) GetBasicAuth ¶
func (a *AppLogDestinationSpecOpenSearch) GetBasicAuth() *OpenSearchBasicAuth
GetBasicAuth returns the BasicAuth field.
func (*AppLogDestinationSpecOpenSearch) GetClusterName ¶
func (a *AppLogDestinationSpecOpenSearch) GetClusterName() string
GetClusterName returns the ClusterName field.
func (*AppLogDestinationSpecOpenSearch) GetEndpoint ¶
func (a *AppLogDestinationSpecOpenSearch) GetEndpoint() string
GetEndpoint returns the Endpoint field.
func (*AppLogDestinationSpecOpenSearch) GetIndexName ¶
func (a *AppLogDestinationSpecOpenSearch) GetIndexName() string
GetIndexName returns the IndexName field.
type AppLogDestinationSpecPapertrail ¶
type AppLogDestinationSpecPapertrail struct {
// Papertrail syslog endpoint.
Endpoint string `json:"endpoint"`
}
AppLogDestinationSpecPapertrail Papertrail configuration.
func (*AppLogDestinationSpecPapertrail) GetEndpoint ¶
func (a *AppLogDestinationSpecPapertrail) GetEndpoint() string
GetEndpoint returns the Endpoint field.
type AppLogType ¶
type AppLogType string
AppLogType is the type of app logs.
const ( // AppLogTypeBuild represents build logs. AppLogTypeBuild AppLogType = "BUILD" // AppLogTypeDeploy represents deploy logs. AppLogTypeDeploy AppLogType = "DEPLOY" // AppLogTypeRun represents run logs. AppLogTypeRun AppLogType = "RUN" // AppLogTypeRunRestarted represents logs of crashed/restarted instances during runtime. AppLogTypeRunRestarted AppLogType = "RUN_RESTARTED" )
type AppLogs ¶
type AppLogs struct {
LiveURL string `json:"live_url"`
HistoricURLs []string `json:"historic_urls"`
}
AppLogs represent app logs.
type AppMaintenanceSpec ¶
type AppMaintenanceSpec struct {
// Indicates whether maintenance mode should be enabled for the app.
Enabled bool `json:"enabled,omitempty"`
// Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. Note that this feature is currently in closed beta.
Archive bool `json:"archive,omitempty"`
}
AppMaintenanceSpec struct for AppMaintenanceSpec
func (*AppMaintenanceSpec) GetArchive ¶
func (a *AppMaintenanceSpec) GetArchive() bool
GetArchive returns the Archive field.
func (*AppMaintenanceSpec) GetEnabled ¶
func (a *AppMaintenanceSpec) GetEnabled() bool
GetEnabled returns the Enabled field.
type AppProposeRequest ¶
type AppProposeRequest struct {
Spec *AppSpec `json:"spec"`
// An optional ID of an existing app. If set, the spec will be treated as a proposed update to the specified app. The existing app is not modified using this method.
AppID string `json:"app_id,omitempty"`
}
AppProposeRequest struct for AppProposeRequest
func (*AppProposeRequest) GetAppID ¶
func (a *AppProposeRequest) GetAppID() string
GetAppID returns the AppID field.
func (*AppProposeRequest) GetSpec ¶
func (a *AppProposeRequest) GetSpec() *AppSpec
GetSpec returns the Spec field.
type AppProposeResponse ¶
type AppProposeResponse struct {
// Deprecated. Please use app_is_starter instead.
AppIsStatic bool `json:"app_is_static,omitempty"`
// Indicates whether the app name is available.
AppNameAvailable bool `json:"app_name_available,omitempty"`
// If the app name is unavailable, this will be set to a suggested available name.
AppNameSuggestion string `json:"app_name_suggestion,omitempty"`
// Deprecated. Please use existing_starter_apps instead.
ExistingStaticApps string `json:"existing_static_apps,omitempty"`
// Deprecated. Please use max_free_starter_apps instead.
MaxFreeStaticApps string `json:"max_free_static_apps,omitempty"`
Spec *AppSpec `json:"spec,omitempty"`
// The monthly cost of the proposed app in USD.
AppCost float32 `json:"app_cost,omitempty"`
// (Deprecated) The monthly cost of the proposed app in USD using the next pricing plan tier. For example, if you propose an app that uses the Basic tier, the `app_tier_upgrade_cost` field displays the monthly cost of the app if it were to use the Professional tier. If the proposed app already uses the most expensive tier, the field is empty.
AppTierUpgradeCost float32 `json:"app_tier_upgrade_cost,omitempty"`
// (Deprecated) The monthly cost of the proposed app in USD using the previous pricing plan tier. For example, if you propose an app that uses the Professional tier, the `app_tier_downgrade_cost` field displays the monthly cost of the app if it were to use the Basic tier. If the proposed app already uses the lest expensive tier, the field is empty.
AppTierDowngradeCost float32 `json:"app_tier_downgrade_cost,omitempty"`
// The number of existing starter tier apps the account has.
ExistingStarterApps string `json:"existing_starter_apps,omitempty"`
// The maximum number of free starter apps the account can have. Any additional starter apps will be charged for. These include apps with only static sites, functions, and databases.
MaxFreeStarterApps string `json:"max_free_starter_apps,omitempty"`
// Indicates whether the app is a starter tier app.
AppIsStarter bool `json:"app_is_starter,omitempty"`
}
AppProposeResponse struct for AppProposeResponse
func (*AppProposeResponse) GetAppCost ¶
func (a *AppProposeResponse) GetAppCost() float32
GetAppCost returns the AppCost field.
func (*AppProposeResponse) GetAppIsStarter ¶
func (a *AppProposeResponse) GetAppIsStarter() bool
GetAppIsStarter returns the AppIsStarter field.
func (*AppProposeResponse) GetAppIsStatic ¶
func (a *AppProposeResponse) GetAppIsStatic() bool
GetAppIsStatic returns the AppIsStatic field.
func (*AppProposeResponse) GetAppNameAvailable ¶
func (a *AppProposeResponse) GetAppNameAvailable() bool
GetAppNameAvailable returns the AppNameAvailable field.
func (*AppProposeResponse) GetAppNameSuggestion ¶
func (a *AppProposeResponse) GetAppNameSuggestion() string
GetAppNameSuggestion returns the AppNameSuggestion field.
func (*AppProposeResponse) GetAppTierDowngradeCost ¶
func (a *AppProposeResponse) GetAppTierDowngradeCost() float32
GetAppTierDowngradeCost returns the AppTierDowngradeCost field.
func (*AppProposeResponse) GetAppTierUpgradeCost ¶
func (a *AppProposeResponse) GetAppTierUpgradeCost() float32
GetAppTierUpgradeCost returns the AppTierUpgradeCost field.
func (*AppProposeResponse) GetExistingStarterApps ¶
func (a *AppProposeResponse) GetExistingStarterApps() string
GetExistingStarterApps returns the ExistingStarterApps field.
func (*AppProposeResponse) GetExistingStaticApps ¶
func (a *AppProposeResponse) GetExistingStaticApps() string
GetExistingStaticApps returns the ExistingStaticApps field.
func (*AppProposeResponse) GetMaxFreeStarterApps ¶
func (a *AppProposeResponse) GetMaxFreeStarterApps() string
GetMaxFreeStarterApps returns the MaxFreeStarterApps field.
func (*AppProposeResponse) GetMaxFreeStaticApps ¶
func (a *AppProposeResponse) GetMaxFreeStaticApps() string
GetMaxFreeStaticApps returns the MaxFreeStaticApps field.
func (*AppProposeResponse) GetSpec ¶
func (a *AppProposeResponse) GetSpec() *AppSpec
GetSpec returns the Spec field.
type AppRegion ¶
type AppRegion struct {
Slug string `json:"slug,omitempty"`
Label string `json:"label,omitempty"`
Flag string `json:"flag,omitempty"`
Continent string `json:"continent,omitempty"`
Disabled bool `json:"disabled,omitempty"`
DataCenters []string `json:"data_centers,omitempty"`
Reason string `json:"reason,omitempty"`
// Whether or not the region is presented as the default.
Default bool `json:"default,omitempty"`
}
AppRegion struct for AppRegion
func (*AppRegion) GetContinent ¶
GetContinent returns the Continent field.
func (*AppRegion) GetDataCenters ¶
GetDataCenters returns the DataCenters field.
func (*AppRegion) GetDefault ¶
GetDefault returns the Default field.
func (*AppRegion) GetDisabled ¶
GetDisabled returns the Disabled field.
type AppRestartRequest ¶
type AppRestartRequest struct {
Components []string `json:"components"`
}
AppRestartRequest represents a request to restart an app.
type AppRoutableComponentSpec ¶
type AppRoutableComponentSpec interface {
AppComponentSpec
GetRoutes() []*AppRouteSpec
GetCORS() *AppCORSPolicy
}
AppRoutableComponentSpec is a component that defines routes.
type AppRouteSpec ¶
type AppRouteSpec struct {
// (Deprecated) An HTTP path prefix. Paths must start with / and must be unique across all components within an app.
Path string `json:"path,omitempty"`
// (Deprecated) An optional flag to preserve the path that is forwarded to the backend service. By default, the HTTP request path will be trimmed from the left when forwarded to the component. For example, a component with `path=/api` will have requests to `/api/list` trimmed to `/list`. If this value is `true`, the path will remain `/api/list`. Note: this is not applicable for Functions Components.
PreservePathPrefix bool `json:"preserve_path_prefix,omitempty"`
}
AppRouteSpec struct for AppRouteSpec
func (*AppRouteSpec) GetPath ¶
func (a *AppRouteSpec) GetPath() string
GetPath returns the Path field.
func (*AppRouteSpec) GetPreservePathPrefix ¶
func (a *AppRouteSpec) GetPreservePathPrefix() bool
GetPreservePathPrefix returns the PreservePathPrefix field.
type AppServiceSpec ¶
type AppServiceSpec struct {
// The name. Must be unique across all components within the same app.
Name string `json:"name"`
Git *GitSourceSpec `json:"git,omitempty"`
GitHub *GitHubSourceSpec `json:"github,omitempty"`
Image *ImageSourceSpec `json:"image,omitempty"`
GitLab *GitLabSourceSpec `json:"gitlab,omitempty"`
Bitbucket *BitbucketSourceSpec `json:"bitbucket,omitempty"`
// The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks.
DockerfilePath string `json:"dockerfile_path,omitempty"`
// An optional build command to run while building this component from source.
BuildCommand string `json:"build_command,omitempty"`
// An optional run command to override the component's default.
RunCommand string `json:"run_command,omitempty"`
// An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo.
SourceDir string `json:"source_dir,omitempty"`
// An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.parspack.com/docs/app-platform/).
EnvironmentSlug string `json:"environment_slug,omitempty"`
// A list of environment variables made available to the component.
Envs []*AppVariableDefinition `json:"envs,omitempty"`
InstanceSizeSlug string `json:"instance_size_slug,omitempty"`
// The amount of instances that this component should be scaled to.
InstanceCount int64 `json:"instance_count,omitempty"`
Autoscaling *AppAutoscalingSpec `json:"autoscaling,omitempty"`
// The internal port on which this service's run command will listen. Default: 8080 If there is not an environment variable with the name `PORT`, one will be automatically added with its value set to the value of this field.
HTTPPort int64 `json:"http_port,omitempty"`
Protocol ServingProtocol `json:"protocol,omitempty"`
// (Deprecated) A list of HTTP routes that should be routed to this component.
Routes []*AppRouteSpec `json:"routes,omitempty"`
HealthCheck *AppServiceSpecHealthCheck `json:"health_check,omitempty"`
CORS *AppCORSPolicy `json:"cors,omitempty"`
// The ports on which this service will listen for internal traffic.
InternalPorts []int64 `json:"internal_ports,omitempty"`
// A list of configured alerts which apply to the component.
Alerts []*AppAlertSpec `json:"alerts,omitempty"`
// A list of configured log forwarding destinations.
LogDestinations []*AppLogDestinationSpec `json:"log_destinations,omitempty"`
Termination *AppServiceSpecTermination `json:"termination,omitempty"`
}
AppServiceSpec struct for AppServiceSpec
func (*AppServiceSpec) GetAlerts ¶
func (a *AppServiceSpec) GetAlerts() []*AppAlertSpec
GetAlerts returns the Alerts field.
func (*AppServiceSpec) GetAutoscaling ¶
func (a *AppServiceSpec) GetAutoscaling() *AppAutoscalingSpec
GetAutoscaling returns the Autoscaling field.
func (*AppServiceSpec) GetBitbucket ¶
func (a *AppServiceSpec) GetBitbucket() *BitbucketSourceSpec
GetBitbucket returns the Bitbucket field.
func (*AppServiceSpec) GetBuildCommand ¶
func (a *AppServiceSpec) GetBuildCommand() string
GetBuildCommand returns the BuildCommand field.
func (*AppServiceSpec) GetCORS ¶
func (a *AppServiceSpec) GetCORS() *AppCORSPolicy
GetCORS returns the CORS field.
func (*AppServiceSpec) GetDockerfilePath ¶
func (a *AppServiceSpec) GetDockerfilePath() string
GetDockerfilePath returns the DockerfilePath field.
func (*AppServiceSpec) GetEnvironmentSlug ¶
func (a *AppServiceSpec) GetEnvironmentSlug() string
GetEnvironmentSlug returns the EnvironmentSlug field.
func (*AppServiceSpec) GetEnvs ¶
func (a *AppServiceSpec) GetEnvs() []*AppVariableDefinition
GetEnvs returns the Envs field.
func (*AppServiceSpec) GetGit ¶
func (a *AppServiceSpec) GetGit() *GitSourceSpec
GetGit returns the Git field.
func (*AppServiceSpec) GetGitHub ¶
func (a *AppServiceSpec) GetGitHub() *GitHubSourceSpec
GetGitHub returns the GitHub field.
func (*AppServiceSpec) GetGitLab ¶
func (a *AppServiceSpec) GetGitLab() *GitLabSourceSpec
GetGitLab returns the GitLab field.
func (*AppServiceSpec) GetHTTPPort ¶
func (a *AppServiceSpec) GetHTTPPort() int64
GetHTTPPort returns the HTTPPort field.
func (*AppServiceSpec) GetHealthCheck ¶
func (a *AppServiceSpec) GetHealthCheck() *AppServiceSpecHealthCheck
GetHealthCheck returns the HealthCheck field.
func (*AppServiceSpec) GetImage ¶
func (a *AppServiceSpec) GetImage() *ImageSourceSpec
GetImage returns the Image field.
func (*AppServiceSpec) GetInstanceCount ¶
func (a *AppServiceSpec) GetInstanceCount() int64
GetInstanceCount returns the InstanceCount field.
func (*AppServiceSpec) GetInstanceSizeSlug ¶
func (a *AppServiceSpec) GetInstanceSizeSlug() string
GetInstanceSizeSlug returns the InstanceSizeSlug field.
func (*AppServiceSpec) GetInternalPorts ¶
func (a *AppServiceSpec) GetInternalPorts() []int64
GetInternalPorts returns the InternalPorts field.
func (*AppServiceSpec) GetLogDestinations ¶
func (a *AppServiceSpec) GetLogDestinations() []*AppLogDestinationSpec
GetLogDestinations returns the LogDestinations field.
func (*AppServiceSpec) GetName ¶
func (a *AppServiceSpec) GetName() string
GetName returns the Name field.
func (*AppServiceSpec) GetProtocol ¶
func (a *AppServiceSpec) GetProtocol() ServingProtocol
GetProtocol returns the Protocol field.
func (*AppServiceSpec) GetRoutes ¶
func (a *AppServiceSpec) GetRoutes() []*AppRouteSpec
GetRoutes returns the Routes field.
func (*AppServiceSpec) GetRunCommand ¶
func (a *AppServiceSpec) GetRunCommand() string
GetRunCommand returns the RunCommand field.
func (*AppServiceSpec) GetSourceDir ¶
func (a *AppServiceSpec) GetSourceDir() string
GetSourceDir returns the SourceDir field.
func (*AppServiceSpec) GetTermination ¶
func (a *AppServiceSpec) GetTermination() *AppServiceSpecTermination
GetTermination returns the Termination field.
func (*AppServiceSpec) GetType ¶
func (s *AppServiceSpec) GetType() AppComponentType
GetType returns the Service component type.
type AppServiceSpecHealthCheck ¶
type AppServiceSpecHealthCheck struct {
// Deprecated. Use http_path instead.
Path string `json:"path,omitempty"`
// The number of seconds to wait before beginning health checks. Default: 0 seconds, Minimum 0, Maximum 3600.
InitialDelaySeconds int32 `json:"initial_delay_seconds,omitempty"`
// The number of seconds to wait between health checks. Default: 10 seconds, Minimum 1, Maximum 300.
PeriodSeconds int32 `json:"period_seconds,omitempty"`
// The number of seconds after which the check times out. Default: 1 second, Minimum 1, Maximum 120.
TimeoutSeconds int32 `json:"timeout_seconds,omitempty"`
// The number of successful health checks before considered healthy. Default: 1, Minimum 1, Maximum 50.
SuccessThreshold int32 `json:"success_threshold,omitempty"`
// The number of failed health checks before considered unhealthy. Default: 9, Minimum 1, Maximum 50.
FailureThreshold int32 `json:"failure_threshold,omitempty"`
// The route path used for the HTTP health check ping. If not set, the HTTP health check will be disabled and a TCP health check used instead.
HTTPPath string `json:"http_path,omitempty"`
// The port on which the health check will be performed. If not set, the health check will be performed on the component's http_port.
Port int64 `json:"port,omitempty"`
}
AppServiceSpecHealthCheck struct for AppServiceSpecHealthCheck
func (*AppServiceSpecHealthCheck) GetFailureThreshold ¶
func (a *AppServiceSpecHealthCheck) GetFailureThreshold() int32
GetFailureThreshold returns the FailureThreshold field.
func (*AppServiceSpecHealthCheck) GetHTTPPath ¶
func (a *AppServiceSpecHealthCheck) GetHTTPPath() string
GetHTTPPath returns the HTTPPath field.
func (*AppServiceSpecHealthCheck) GetInitialDelaySeconds ¶
func (a *AppServiceSpecHealthCheck) GetInitialDelaySeconds() int32
GetInitialDelaySeconds returns the InitialDelaySeconds field.
func (*AppServiceSpecHealthCheck) GetPath ¶
func (a *AppServiceSpecHealthCheck) GetPath() string
GetPath returns the Path field.
func (*AppServiceSpecHealthCheck) GetPeriodSeconds ¶
func (a *AppServiceSpecHealthCheck) GetPeriodSeconds() int32
GetPeriodSeconds returns the PeriodSeconds field.
func (*AppServiceSpecHealthCheck) GetPort ¶
func (a *AppServiceSpecHealthCheck) GetPort() int64
GetPort returns the Port field.
func (*AppServiceSpecHealthCheck) GetSuccessThreshold ¶
func (a *AppServiceSpecHealthCheck) GetSuccessThreshold() int32
GetSuccessThreshold returns the SuccessThreshold field.
func (*AppServiceSpecHealthCheck) GetTimeoutSeconds ¶
func (a *AppServiceSpecHealthCheck) GetTimeoutSeconds() int32
GetTimeoutSeconds returns the TimeoutSeconds field.
type AppServiceSpecTermination ¶
type AppServiceSpecTermination struct {
// The number of seconds to wait between selecting a container instance for termination and issuing the TERM signal. Selecting a container instance for termination begins an asynchronous drain of new requests on upstream load-balancers. Default: 15 seconds, Minimum 1, Maximum 110.
DrainSeconds int32 `json:"drain_seconds,omitempty"`
// The number of seconds to wait between sending a TERM signal to a container and issuing a KILL which causes immediate shutdown. Default: 120, Minimum 1, Maximum 600.
GracePeriodSeconds int32 `json:"grace_period_seconds,omitempty"`
}
AppServiceSpecTermination struct for AppServiceSpecTermination
func (*AppServiceSpecTermination) GetDrainSeconds ¶
func (a *AppServiceSpecTermination) GetDrainSeconds() int32
GetDrainSeconds returns the DrainSeconds field.
func (*AppServiceSpecTermination) GetGracePeriodSeconds ¶
func (a *AppServiceSpecTermination) GetGracePeriodSeconds() int32
GetGracePeriodSeconds returns the GracePeriodSeconds field.
type AppSourceType ¶
type AppSourceType string
AppSourceType is an app source type.
const ( AppSourceTypeBitbucket AppSourceType = "bitbucket" AppSourceTypeGitHub AppSourceType = "github" AppSourceTypeGitLab AppSourceType = "gitlab" AppSourceTypeGit AppSourceType = "git" AppSourceTypeImage AppSourceType = "image" )
type AppSpec ¶
type AppSpec struct {
// The name of the app. Must be unique across all apps in the same account.
Name string `json:"name"`
// Workloads which expose publicly-accessible HTTP services.
Services []*AppServiceSpec `json:"services,omitempty"`
// Content which can be rendered to static web assets.
StaticSites []*AppStaticSiteSpec `json:"static_sites,omitempty"`
// Workloads which do not expose publicly-accessible HTTP services.
Workers []*AppWorkerSpec `json:"workers,omitempty"`
// Pre and post deployment workloads which do not expose publicly-accessible HTTP routes.
Jobs []*AppJobSpec `json:"jobs,omitempty"`
// Workloads which expose publicly-accessible HTTP services via Functions Components.
Functions []*AppFunctionsSpec `json:"functions,omitempty"`
// Database instances which can provide persistence to workloads within the application.
Databases []*AppDatabaseSpec `json:"databases,omitempty"`
// A set of hostnames where the application will be available.
Domains []*AppDomainSpec `json:"domains,omitempty"`
Region string `json:"region,omitempty"`
// A list of environment variables made available to all components in the app.
Envs []*AppVariableDefinition `json:"envs,omitempty"`
// A list of alerts which apply to the app.
Alerts []*AppAlertSpec `json:"alerts,omitempty"`
Ingress *AppIngressSpec `json:"ingress,omitempty"`
Egress *AppEgressSpec `json:"egress,omitempty"`
Features []string `json:"features,omitempty"`
Maintenance *AppMaintenanceSpec `json:"maintenance,omitempty"`
}
AppSpec The desired configuration of an application.
func (*AppSpec) ForEachAppComponentSpec ¶
func (s *AppSpec) ForEachAppComponentSpec(fn func(component AppComponentSpec) error) error
ForEachAppComponentSpec iterates over each component spec in an app.
func (*AppSpec) GetAlerts ¶
func (a *AppSpec) GetAlerts() []*AppAlertSpec
GetAlerts returns the Alerts field.
func (*AppSpec) GetDatabases ¶
func (a *AppSpec) GetDatabases() []*AppDatabaseSpec
GetDatabases returns the Databases field.
func (*AppSpec) GetDomains ¶
func (a *AppSpec) GetDomains() []*AppDomainSpec
GetDomains returns the Domains field.
func (*AppSpec) GetEgress ¶
func (a *AppSpec) GetEgress() *AppEgressSpec
GetEgress returns the Egress field.
func (*AppSpec) GetEnvs ¶
func (a *AppSpec) GetEnvs() []*AppVariableDefinition
GetEnvs returns the Envs field.
func (*AppSpec) GetFeatures ¶
GetFeatures returns the Features field.
func (*AppSpec) GetFunctions ¶
func (a *AppSpec) GetFunctions() []*AppFunctionsSpec
GetFunctions returns the Functions field.
func (*AppSpec) GetIngress ¶
func (a *AppSpec) GetIngress() *AppIngressSpec
GetIngress returns the Ingress field.
func (*AppSpec) GetMaintenance ¶
func (a *AppSpec) GetMaintenance() *AppMaintenanceSpec
GetMaintenance returns the Maintenance field.
func (*AppSpec) GetServices ¶
func (a *AppSpec) GetServices() []*AppServiceSpec
GetServices returns the Services field.
func (*AppSpec) GetStaticSites ¶
func (a *AppSpec) GetStaticSites() []*AppStaticSiteSpec
GetStaticSites returns the StaticSites field.
func (*AppSpec) GetWorkers ¶
func (a *AppSpec) GetWorkers() []*AppWorkerSpec
GetWorkers returns the Workers field.
type AppStaticSiteSpec ¶
type AppStaticSiteSpec struct {
// The name. Must be unique across all components within the same app.
Name string `json:"name"`
Git *GitSourceSpec `json:"git,omitempty"`
GitHub *GitHubSourceSpec `json:"github,omitempty"`
GitLab *GitLabSourceSpec `json:"gitlab,omitempty"`
Bitbucket *BitbucketSourceSpec `json:"bitbucket,omitempty"`
// The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks.
DockerfilePath string `json:"dockerfile_path,omitempty"`
// An optional build command to run while building this component from source.
BuildCommand string `json:"build_command,omitempty"`
// An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo.
SourceDir string `json:"source_dir,omitempty"`
// An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.parspack.com/docs/app-platform/).
EnvironmentSlug string `json:"environment_slug,omitempty"`
// An optional path to where the built assets will be located, relative to the build context. If not set, App Platform will automatically scan for these directory names: `_static`, `dist`, `public`, `build`.
OutputDir string `json:"output_dir,omitempty"`
IndexDocument string `json:"index_document,omitempty"`
// The name of the error document to use when serving this static site. Default: 404.html. If no such file exists within the built assets, App Platform will supply one.
ErrorDocument string `json:"error_document,omitempty"`
// A list of environment variables made available to the component.
Envs []*AppVariableDefinition `json:"envs,omitempty"`
// (Deprecated) A list of HTTP routes that should be routed to this component.
Routes []*AppRouteSpec `json:"routes,omitempty"`
CORS *AppCORSPolicy `json:"cors,omitempty"`
// The name of the document to use as the fallback for any requests to documents that are not found when serving this static site. Only 1 of `catchall_document` or `error_document` can be set.
CatchallDocument string `json:"catchall_document,omitempty"`
}
AppStaticSiteSpec struct for AppStaticSiteSpec
func (*AppStaticSiteSpec) GetBitbucket ¶
func (a *AppStaticSiteSpec) GetBitbucket() *BitbucketSourceSpec
GetBitbucket returns the Bitbucket field.
func (*AppStaticSiteSpec) GetBuildCommand ¶
func (a *AppStaticSiteSpec) GetBuildCommand() string
GetBuildCommand returns the BuildCommand field.
func (*AppStaticSiteSpec) GetCORS ¶
func (a *AppStaticSiteSpec) GetCORS() *AppCORSPolicy
GetCORS returns the CORS field.
func (*AppStaticSiteSpec) GetCatchallDocument ¶
func (a *AppStaticSiteSpec) GetCatchallDocument() string
GetCatchallDocument returns the CatchallDocument field.
func (*AppStaticSiteSpec) GetDockerfilePath ¶
func (a *AppStaticSiteSpec) GetDockerfilePath() string
GetDockerfilePath returns the DockerfilePath field.
func (*AppStaticSiteSpec) GetEnvironmentSlug ¶
func (a *AppStaticSiteSpec) GetEnvironmentSlug() string
GetEnvironmentSlug returns the EnvironmentSlug field.
func (*AppStaticSiteSpec) GetEnvs ¶
func (a *AppStaticSiteSpec) GetEnvs() []*AppVariableDefinition
GetEnvs returns the Envs field.
func (*AppStaticSiteSpec) GetErrorDocument ¶
func (a *AppStaticSiteSpec) GetErrorDocument() string
GetErrorDocument returns the ErrorDocument field.
func (*AppStaticSiteSpec) GetGit ¶
func (a *AppStaticSiteSpec) GetGit() *GitSourceSpec
GetGit returns the Git field.
func (*AppStaticSiteSpec) GetGitHub ¶
func (a *AppStaticSiteSpec) GetGitHub() *GitHubSourceSpec
GetGitHub returns the GitHub field.
func (*AppStaticSiteSpec) GetGitLab ¶
func (a *AppStaticSiteSpec) GetGitLab() *GitLabSourceSpec
GetGitLab returns the GitLab field.
func (*AppStaticSiteSpec) GetIndexDocument ¶
func (a *AppStaticSiteSpec) GetIndexDocument() string
GetIndexDocument returns the IndexDocument field.
func (*AppStaticSiteSpec) GetName ¶
func (a *AppStaticSiteSpec) GetName() string
GetName returns the Name field.
func (*AppStaticSiteSpec) GetOutputDir ¶
func (a *AppStaticSiteSpec) GetOutputDir() string
GetOutputDir returns the OutputDir field.
func (*AppStaticSiteSpec) GetRoutes ¶
func (a *AppStaticSiteSpec) GetRoutes() []*AppRouteSpec
GetRoutes returns the Routes field.
func (*AppStaticSiteSpec) GetSourceDir ¶
func (a *AppStaticSiteSpec) GetSourceDir() string
GetSourceDir returns the SourceDir field.
func (*AppStaticSiteSpec) GetType ¶
func (s *AppStaticSiteSpec) GetType() AppComponentType
GetType returns the StaticSite component type.
type AppStringMatch ¶
type AppStringMatch struct {
// Exact string match. Only 1 of `exact`, `prefix`, or `regex` must be set.
Exact string `json:"exact,omitempty"`
// Prefix-based match. Only 1 of `exact`, `prefix`, or `regex` must be set.
Prefix string `json:"prefix,omitempty"`
Regex string `json:"regex,omitempty"`
}
AppStringMatch struct for AppStringMatch
func (*AppStringMatch) GetExact ¶
func (a *AppStringMatch) GetExact() string
GetExact returns the Exact field.
func (*AppStringMatch) GetPrefix ¶
func (a *AppStringMatch) GetPrefix() string
GetPrefix returns the Prefix field.
func (*AppStringMatch) GetRegex ¶
func (a *AppStringMatch) GetRegex() string
GetRegex returns the Regex field.
type AppTier ¶
type AppTier struct {
Name string `json:"name,omitempty"`
Slug string `json:"slug,omitempty"`
EgressBandwidthBytes string `json:"egress_bandwidth_bytes,omitempty"`
BuildSeconds string `json:"build_seconds,omitempty"`
}
AppTier struct for AppTier
func (*AppTier) GetBuildSeconds ¶
GetBuildSeconds returns the BuildSeconds field.
func (*AppTier) GetEgressBandwidthBytes ¶
GetEgressBandwidthBytes returns the EgressBandwidthBytes field.
type AppUpdateRequest ¶
type AppUpdateRequest struct {
Spec *AppSpec `json:"spec"`
// Whether or not to update the source versions (for example fetching a new commit or image digest) of all components. By default (when this is false) only newly added sources will be updated to avoid changes like updating the scale of a component from also updating the respective code.
UpdateAllSourceVersions bool `json:"update_all_source_versions"`
}
AppUpdateRequest represents a request to update an app.
type AppVariableDefinition ¶
type AppVariableDefinition struct {
// The name
Key string `json:"key"`
// The value. If the type is `SECRET`, the value will be encrypted on first submission. On following submissions, the encrypted value should be used.
Value string `json:"value,omitempty"`
Scope AppVariableScope `json:"scope,omitempty"`
Type AppVariableType `json:"type,omitempty"`
}
AppVariableDefinition struct for AppVariableDefinition
func (*AppVariableDefinition) GetKey ¶
func (a *AppVariableDefinition) GetKey() string
GetKey returns the Key field.
func (*AppVariableDefinition) GetScope ¶
func (a *AppVariableDefinition) GetScope() AppVariableScope
GetScope returns the Scope field.
func (*AppVariableDefinition) GetType ¶
func (a *AppVariableDefinition) GetType() AppVariableType
GetType returns the Type field.
func (*AppVariableDefinition) GetValue ¶
func (a *AppVariableDefinition) GetValue() string
GetValue returns the Value field.
type AppVariableScope ¶
type AppVariableScope string
AppVariableScope the model 'AppVariableScope'
const ( AppVariableScope_Unset AppVariableScope = "UNSET" AppVariableScope_RunTime AppVariableScope = "RUN_TIME" AppVariableScope_BuildTime AppVariableScope = "BUILD_TIME" AppVariableScope_RunAndBuildTime AppVariableScope = "RUN_AND_BUILD_TIME" )
List of AppVariableScope
type AppVariableType ¶
type AppVariableType string
AppVariableType the model 'AppVariableType'
const ( AppVariableType_General AppVariableType = "GENERAL" AppVariableType_Secret AppVariableType = "SECRET" )
List of AppVariableType
type AppWorkerSpec ¶
type AppWorkerSpec struct {
// The name. Must be unique across all components within the same app.
Name string `json:"name"`
Git *GitSourceSpec `json:"git,omitempty"`
GitHub *GitHubSourceSpec `json:"github,omitempty"`
Image *ImageSourceSpec `json:"image,omitempty"`
GitLab *GitLabSourceSpec `json:"gitlab,omitempty"`
Bitbucket *BitbucketSourceSpec `json:"bitbucket,omitempty"`
// The path to the Dockerfile relative to the root of the repo. If set, it will be used to build this component. Otherwise, App Platform will attempt to build it using buildpacks.
DockerfilePath string `json:"dockerfile_path,omitempty"`
// An optional build command to run while building this component from source.
BuildCommand string `json:"build_command,omitempty"`
// An optional run command to override the component's default.
RunCommand string `json:"run_command,omitempty"`
// An optional path to the working directory to use for the build. For Dockerfile builds, this will be used as the build context. Must be relative to the root of the repo.
SourceDir string `json:"source_dir,omitempty"`
// An environment slug describing the type of this app. For a full list, please refer to [the product documentation](https://www.parspack.com/docs/app-platform/).
EnvironmentSlug string `json:"environment_slug,omitempty"`
// A list of environment variables made available to the component.
Envs []*AppVariableDefinition `json:"envs,omitempty"`
// The instance size to use for this component.
InstanceSizeSlug string `json:"instance_size_slug,omitempty"`
InstanceCount int64 `json:"instance_count,omitempty"`
Autoscaling *AppAutoscalingSpec `json:"autoscaling,omitempty"`
// A list of configured alerts which apply to the component.
Alerts []*AppAlertSpec `json:"alerts,omitempty"`
// A list of configured log forwarding destinations.
LogDestinations []*AppLogDestinationSpec `json:"log_destinations,omitempty"`
Termination *AppWorkerSpecTermination `json:"termination,omitempty"`
}
AppWorkerSpec struct for AppWorkerSpec
func (*AppWorkerSpec) GetAlerts ¶
func (a *AppWorkerSpec) GetAlerts() []*AppAlertSpec
GetAlerts returns the Alerts field.
func (*AppWorkerSpec) GetAutoscaling ¶
func (a *AppWorkerSpec) GetAutoscaling() *AppAutoscalingSpec
GetAutoscaling returns the Autoscaling field.
func (*AppWorkerSpec) GetBitbucket ¶
func (a *AppWorkerSpec) GetBitbucket() *BitbucketSourceSpec
GetBitbucket returns the Bitbucket field.
func (*AppWorkerSpec) GetBuildCommand ¶
func (a *AppWorkerSpec) GetBuildCommand() string
GetBuildCommand returns the BuildCommand field.
func (*AppWorkerSpec) GetDockerfilePath ¶
func (a *AppWorkerSpec) GetDockerfilePath() string
GetDockerfilePath returns the DockerfilePath field.
func (*AppWorkerSpec) GetEnvironmentSlug ¶
func (a *AppWorkerSpec) GetEnvironmentSlug() string
GetEnvironmentSlug returns the EnvironmentSlug field.
func (*AppWorkerSpec) GetEnvs ¶
func (a *AppWorkerSpec) GetEnvs() []*AppVariableDefinition
GetEnvs returns the Envs field.
func (*AppWorkerSpec) GetGit ¶
func (a *AppWorkerSpec) GetGit() *GitSourceSpec
GetGit returns the Git field.
func (*AppWorkerSpec) GetGitHub ¶
func (a *AppWorkerSpec) GetGitHub() *GitHubSourceSpec
GetGitHub returns the GitHub field.
func (*AppWorkerSpec) GetGitLab ¶
func (a *AppWorkerSpec) GetGitLab() *GitLabSourceSpec
GetGitLab returns the GitLab field.
func (*AppWorkerSpec) GetImage ¶
func (a *AppWorkerSpec) GetImage() *ImageSourceSpec
GetImage returns the Image field.
func (*AppWorkerSpec) GetInstanceCount ¶
func (a *AppWorkerSpec) GetInstanceCount() int64
GetInstanceCount returns the InstanceCount field.
func (*AppWorkerSpec) GetInstanceSizeSlug ¶
func (a *AppWorkerSpec) GetInstanceSizeSlug() string
GetInstanceSizeSlug returns the InstanceSizeSlug field.
func (*AppWorkerSpec) GetLogDestinations ¶
func (a *AppWorkerSpec) GetLogDestinations() []*AppLogDestinationSpec
GetLogDestinations returns the LogDestinations field.
func (*AppWorkerSpec) GetName ¶
func (a *AppWorkerSpec) GetName() string
GetName returns the Name field.
func (*AppWorkerSpec) GetRunCommand ¶
func (a *AppWorkerSpec) GetRunCommand() string
GetRunCommand returns the RunCommand field.
func (*AppWorkerSpec) GetSourceDir ¶
func (a *AppWorkerSpec) GetSourceDir() string
GetSourceDir returns the SourceDir field.
func (*AppWorkerSpec) GetTermination ¶
func (a *AppWorkerSpec) GetTermination() *AppWorkerSpecTermination
GetTermination returns the Termination field.
func (*AppWorkerSpec) GetType ¶
func (s *AppWorkerSpec) GetType() AppComponentType
GetType returns the Worker component type.
type AppWorkerSpecTermination ¶
type AppWorkerSpecTermination struct {
// The number of seconds to wait between sending a TERM signal to a container and issuing a KILL which causes immediate shutdown. Default: 120, Minimum 1, Maximum 600.
GracePeriodSeconds int32 `json:"grace_period_seconds,omitempty"`
}
AppWorkerSpecTermination struct for AppWorkerSpecTermination
func (*AppWorkerSpecTermination) GetGracePeriodSeconds ¶
func (a *AppWorkerSpecTermination) GetGracePeriodSeconds() int32
GetGracePeriodSeconds returns the GracePeriodSeconds field.
type AppsService ¶
type AppsService interface {
Create(ctx context.Context, create *AppCreateRequest) (*App, *Response, error)
Get(ctx context.Context, appID string) (*App, *Response, error)
List(ctx context.Context, opts *ListOptions) ([]*App, *Response, error)
Update(ctx context.Context, appID string, update *AppUpdateRequest) (*App, *Response, error)
Delete(ctx context.Context, appID string) (*Response, error)
Propose(ctx context.Context, propose *AppProposeRequest) (*AppProposeResponse, *Response, error)
Restart(ctx context.Context, appID string, opts *AppRestartRequest) (*Deployment, *Response, error)
GetDeployment(ctx context.Context, appID, deploymentID string) (*Deployment, *Response, error)
ListDeployments(ctx context.Context, appID string, opts *ListOptions) ([]*Deployment, *Response, error)
CreateDeployment(ctx context.Context, appID string, create ...*DeploymentCreateRequest) (*Deployment, *Response, error)
GetLogs(ctx context.Context, appID, deploymentID, component string, logType AppLogType, follow bool, tailLines int) (*AppLogs, *Response, error)
GetExec(ctx context.Context, appID, deploymentID, component string) (*AppExec, *Response, error)
ListRegions(ctx context.Context) ([]*AppRegion, *Response, error)
ListTiers(ctx context.Context) ([]*AppTier, *Response, error)
GetTier(ctx context.Context, slug string) (*AppTier, *Response, error)
ListInstanceSizes(ctx context.Context) ([]*AppInstanceSize, *Response, error)
GetInstanceSize(ctx context.Context, slug string) (*AppInstanceSize, *Response, error)
ListAlerts(ctx context.Context, appID string) ([]*AppAlert, *Response, error)
UpdateAlertDestinations(ctx context.Context, appID, alertID string, update *AlertDestinationUpdateRequest) (*AppAlert, *Response, error)
Detect(ctx context.Context, detect *DetectRequest) (*DetectResponse, *Response, error)
ListBuildpacks(ctx context.Context) ([]*Buildpack, *Response, error)
UpgradeBuildpack(ctx context.Context, appID string, opts UpgradeBuildpackOptions) (*UpgradeBuildpackResponse, *Response, error)
GetAppDatabaseConnectionDetails(ctx context.Context, appID string) ([]*GetDatabaseConnectionDetailsResponse, *Response, error)
ResetDatabasePassword(ctx context.Context, appID string, component string) (*Deployment, *Response, error)
ToggleDatabaseTrustedSource(
ctx context.Context,
appID string,
component string,
opts ToggleDatabaseTrustedSourceOptions,
) (
*ToggleDatabaseTrustedSourceResponse,
*Response,
error,
)
}
AppsService is an interface for interfacing with the App Platform endpoints of the Abrha API.
type AppsServiceOp ¶
type AppsServiceOp struct {
// contains filtered or unexported fields
}
AppsServiceOp handles communication with Apps methods of the Abrha API.
func (*AppsServiceOp) Create ¶
func (s *AppsServiceOp) Create(ctx context.Context, create *AppCreateRequest) (*App, *Response, error)
Create an app.
func (*AppsServiceOp) CreateDeployment ¶
func (s *AppsServiceOp) CreateDeployment(ctx context.Context, appID string, create ...*DeploymentCreateRequest) (*Deployment, *Response, error)
CreateDeployment creates an app deployment.
func (*AppsServiceOp) Detect ¶
func (s *AppsServiceOp) Detect(ctx context.Context, detect *DetectRequest) (*DetectResponse, *Response, error)
Detect an app.
func (*AppsServiceOp) GetAppDatabaseConnectionDetails ¶
func (s *AppsServiceOp) GetAppDatabaseConnectionDetails(ctx context.Context, appID string) ([]*GetDatabaseConnectionDetailsResponse, *Response, error)
GetAppDatabaseConnectionDetails retrieves credentials for databases associated with the app.
func (*AppsServiceOp) GetDeployment ¶
func (s *AppsServiceOp) GetDeployment(ctx context.Context, appID, deploymentID string) (*Deployment, *Response, error)
GetDeployment gets an app deployment.
func (*AppsServiceOp) GetExec ¶
func (s *AppsServiceOp) GetExec(ctx context.Context, appID, deploymentID, component string) (*AppExec, *Response, error)
GetExec retrieves the websocket URL used for sending/receiving console input and output.
func (*AppsServiceOp) GetInstanceSize ¶
func (s *AppsServiceOp) GetInstanceSize(ctx context.Context, slug string) (*AppInstanceSize, *Response, error)
GetInstanceSize retrieves information about a specific instance size for service, worker, and job components.
func (*AppsServiceOp) GetLogs ¶
func (s *AppsServiceOp) GetLogs(ctx context.Context, appID, deploymentID, component string, logType AppLogType, follow bool, tailLines int) (*AppLogs, *Response, error)
GetLogs retrieves app logs.
func (*AppsServiceOp) GetTier
deprecated
GetTier retrieves information about a specific app tier.
Deprecated: The '/v2/apps/tiers/{slug}' endpoints have been deprecated as app tiers are no longer tied to instance sizes. The concept of tiers is being retired.
func (*AppsServiceOp) List ¶
func (s *AppsServiceOp) List(ctx context.Context, opts *ListOptions) ([]*App, *Response, error)
List apps.
func (*AppsServiceOp) ListAlerts ¶
func (s *AppsServiceOp) ListAlerts(ctx context.Context, appID string) ([]*AppAlert, *Response, error)
ListAlerts retrieves a list of alerts on an app
func (*AppsServiceOp) ListBuildpacks ¶
ListBuildpacks lists the available buildpacks on App Platform.
func (*AppsServiceOp) ListDeployments ¶
func (s *AppsServiceOp) ListDeployments(ctx context.Context, appID string, opts *ListOptions) ([]*Deployment, *Response, error)
ListDeployments lists an app deployments.
func (*AppsServiceOp) ListInstanceSizes ¶
func (s *AppsServiceOp) ListInstanceSizes(ctx context.Context) ([]*AppInstanceSize, *Response, error)
ListInstanceSizes lists available instance sizes for service, worker, and job components.
func (*AppsServiceOp) ListRegions ¶
ListRegions lists all regions supported by App Platform.
func (*AppsServiceOp) ListTiers
deprecated
func (*AppsServiceOp) Propose ¶
func (s *AppsServiceOp) Propose(ctx context.Context, propose *AppProposeRequest) (*AppProposeResponse, *Response, error)
Propose an app.
func (*AppsServiceOp) ResetDatabasePassword ¶
func (s *AppsServiceOp) ResetDatabasePassword(ctx context.Context, appID string, component string) (*Deployment, *Response, error)
ResetDatabasePassword resets credentials for a database component associated with the app.
func (*AppsServiceOp) Restart ¶
func (s *AppsServiceOp) Restart(ctx context.Context, appID string, opts *AppRestartRequest) (*Deployment, *Response, error)
Restart restarts an app.
func (*AppsServiceOp) ToggleDatabaseTrustedSource ¶
func (s *AppsServiceOp) ToggleDatabaseTrustedSource( ctx context.Context, appID string, component string, opts ToggleDatabaseTrustedSourceOptions, ) ( *ToggleDatabaseTrustedSourceResponse, *Response, error, )
ToggleDatabaseTrustedSource enables/disables trusted sources on the specified dev database component.
func (*AppsServiceOp) Update ¶
func (s *AppsServiceOp) Update(ctx context.Context, appID string, update *AppUpdateRequest) (*App, *Response, error)
Update an app.
func (*AppsServiceOp) UpdateAlertDestinations ¶
func (s *AppsServiceOp) UpdateAlertDestinations(ctx context.Context, appID, alertID string, update *AlertDestinationUpdateRequest) (*AppAlert, *Response, error)
UpdateAlertDestinations updates the alert destinations of an app's alert
func (*AppsServiceOp) UpgradeBuildpack ¶
func (s *AppsServiceOp) UpgradeBuildpack(ctx context.Context, appID string, opts UpgradeBuildpackOptions) (*UpgradeBuildpackResponse, *Response, error)
UpgradeBuildpack upgrades a buildpack for an app.
type ArgError ¶
type ArgError struct {
// contains filtered or unexported fields
}
ArgError is an error that represents an error with an input to goApiAbrha. It identifies the argument and the cause (if possible).
func NewArgError ¶
NewArgError creates an InputError.
type AssociatedResource ¶
AssociatedResource is the object to represent a Kubernetes cluster associated resource's ID and Name.
type BackupWindow ¶
type BackupWindow struct {
Start *Timestamp `json:"start,omitempty"`
End *Timestamp `json:"end,omitempty"`
}
BackupWindow object
type Balance ¶
type Balance struct {
MonthToDateBalance string `json:"month_to_date_balance"`
AccountBalance string `json:"account_balance"`
MonthToDateUsage string `json:"month_to_date_usage"`
GeneratedAt time.Time `json:"generated_at"`
}
Balance represents a Abrha Balance
type BalanceService ¶
BalanceService is an interface for interfacing with the Balance endpoints of the Abrha API See: https://docs.parspack.com/reference/api/cloud-server/#operation/balance_get
type BalanceServiceOp ¶
type BalanceServiceOp struct {
// contains filtered or unexported fields
}
BalanceServiceOp handles communication with the Balance related methods of the Abrha API.
type BillingHistory ¶
type BillingHistory struct {
BillingHistory []BillingHistoryEntry `json:"billing_history"`
Links *Links `json:"links"`
Meta *Meta `json:"meta"`
}
BillingHistory represents a Abrha Billing History
func (BillingHistory) String ¶
func (b BillingHistory) String() string
type BillingHistoryEntry ¶
type BillingHistoryEntry struct {
Description string `json:"description"`
Amount string `json:"amount"`
InvoiceID *string `json:"invoice_id"`
InvoiceUUID *string `json:"invoice_uuid"`
Date time.Time `json:"date"`
Type string `json:"type"`
}
BillingHistoryEntry represents an entry in a customer's Billing History
type BillingHistoryService ¶
type BillingHistoryService interface {
List(context.Context, *ListOptions) (*BillingHistory, *Response, error)
}
BillingHistoryService is an interface for interfacing with the BillingHistory endpoints of the Abrha API See: https://docs.parspack.com/reference/api/cloud-server/#operation/billingHistory_list
type BillingHistoryServiceOp ¶
type BillingHistoryServiceOp struct {
// contains filtered or unexported fields
}
BillingHistoryServiceOp handles communication with the BillingHistory related methods of the Abrha API.
func (*BillingHistoryServiceOp) List ¶
func (s *BillingHistoryServiceOp) List(ctx context.Context, opt *ListOptions) (*BillingHistory, *Response, error)
List the Billing History for a customer
type BitbucketSourceSpec ¶
type BitbucketSourceSpec struct {
Repo string `json:"repo,omitempty"`
Branch string `json:"branch,omitempty"`
DeployOnPush bool `json:"deploy_on_push,omitempty"`
}
BitbucketSourceSpec struct for BitbucketSourceSpec
func (*BitbucketSourceSpec) GetBranch ¶
func (b *BitbucketSourceSpec) GetBranch() string
GetBranch returns the Branch field.
func (*BitbucketSourceSpec) GetDeployOnPush ¶
func (b *BitbucketSourceSpec) GetDeployOnPush() bool
GetDeployOnPush returns the DeployOnPush field.
func (*BitbucketSourceSpec) GetRepo ¶
func (b *BitbucketSourceSpec) GetRepo() string
GetRepo returns the Repo field.
func (*BitbucketSourceSpec) GetType ¶
func (s *BitbucketSourceSpec) GetType() AppSourceType
GetType returns the Bitbucket source type.
type Blob ¶
type Blob struct {
Digest string `json:"digest,omitempty"`
CompressedSizeBytes uint64 `json:"compressed_size_bytes,omitempty"`
}
Blob represents a registry blob
type Buildpack ¶
type Buildpack struct {
// The ID of the buildpack.
ID string `json:"id,omitempty"`
// Full semver version string.
Version string `json:"version,omitempty"`
// The major version line that the buildpack is pinned to. Example: a value of `1` indicates that the buildpack is pinned to versions `>=1.0.0 and <2.0.0`.
MajorVersion int32 `json:"major_version,omitempty"`
// Indicates whether the buildpack is on the latest major version line available.
Latest bool `json:"latest,omitempty"`
// A human friendly name.
Name string `json:"name,omitempty"`
// A description of the buildpack's purpose and steps performed at build time.
Description []string `json:"description,omitempty"`
// A link to the buildpack's documentation.
DocsLink string `json:"docs_link,omitempty"`
}
Buildpack struct for Buildpack
func (*Buildpack) GetDescription ¶
GetDescription returns the Description field.
func (*Buildpack) GetDocsLink ¶
GetDocsLink returns the DocsLink field.
func (*Buildpack) GetMajorVersion ¶
GetMajorVersion returns the MajorVersion field.
func (*Buildpack) GetVersion ¶
GetVersion returns the Version field.
type CDN ¶
type CDN struct {
ID string `json:"id"`
Origin string `json:"origin"`
Endpoint string `json:"endpoint"`
CreatedAt time.Time `json:"created_at"`
TTL uint32 `json:"ttl"`
CertificateID string `json:"certificate_id,omitempty"`
CustomDomain string `json:"custom_domain,omitempty"`
}
CDN represents a Abrha CDN
type CDNCreateRequest ¶
type CDNCreateRequest struct {
Origin string `json:"origin"`
TTL uint32 `json:"ttl"`
CustomDomain string `json:"custom_domain,omitempty"`
CertificateID string `json:"certificate_id,omitempty"`
}
CDNCreateRequest represents a request to create a CDN.
type CDNFlushCacheRequest ¶
type CDNFlushCacheRequest struct {
Files []string `json:"files"`
}
CDNFlushCacheRequest represents a request to flush cache of a CDN.
type CDNService ¶
type CDNService interface {
List(context.Context, *ListOptions) ([]CDN, *Response, error)
Get(context.Context, string) (*CDN, *Response, error)
Create(context.Context, *CDNCreateRequest) (*CDN, *Response, error)
UpdateTTL(context.Context, string, *CDNUpdateTTLRequest) (*CDN, *Response, error)
UpdateCustomDomain(context.Context, string, *CDNUpdateCustomDomainRequest) (*CDN, *Response, error)
FlushCache(context.Context, string, *CDNFlushCacheRequest) (*Response, error)
Delete(context.Context, string) (*Response, error)
}
CDNService is an interface for managing Spaces CDN with the Abrha API.
type CDNServiceOp ¶
type CDNServiceOp struct {
// contains filtered or unexported fields
}
CDNServiceOp handles communication with the CDN related methods of the Abrha API.
func (CDNServiceOp) Create ¶
func (c CDNServiceOp) Create(ctx context.Context, createRequest *CDNCreateRequest) (*CDN, *Response, error)
Create a new CDN
func (CDNServiceOp) FlushCache ¶
func (c CDNServiceOp) FlushCache(ctx context.Context, id string, flushCacheRequest *CDNFlushCacheRequest) (*Response, error)
FlushCache flushes the cache of an individual CDN. Requires a non-empty slice of file paths and/or wildcards
func (CDNServiceOp) List ¶
func (c CDNServiceOp) List(ctx context.Context, opt *ListOptions) ([]CDN, *Response, error)
List all CDN endpoints
func (CDNServiceOp) UpdateCustomDomain ¶
func (c CDNServiceOp) UpdateCustomDomain(ctx context.Context, id string, updateRequest *CDNUpdateCustomDomainRequest) (*CDN, *Response, error)
UpdateCustomDomain sets or removes the custom domain of an individual CDN
func (CDNServiceOp) UpdateTTL ¶
func (c CDNServiceOp) UpdateTTL(ctx context.Context, id string, updateRequest *CDNUpdateTTLRequest) (*CDN, *Response, error)
UpdateTTL updates the ttl of an individual CDN
type CDNSettings ¶
type CDNSettings struct {
// IsEnabled is the caching enabled flag
IsEnabled bool `json:"is_enabled"`
}
CDNSettings define CDN settings for a Global LB
func (CDNSettings) String ¶
func (c CDNSettings) String() string
String creates a human-readable description of a CDNSettings
type CDNUpdateCustomDomainRequest ¶
type CDNUpdateCustomDomainRequest struct {
CustomDomain string `json:"custom_domain"`
CertificateID string `json:"certificate_id"`
}
CDNUpdateCustomDomainRequest represents a request to update the custom domain of a CDN.
type CDNUpdateTTLRequest ¶
type CDNUpdateTTLRequest struct {
TTL uint32 `json:"ttl"`
}
CDNUpdateTTLRequest represents a request to update the ttl of a CDN.
type Certificate ¶
type Certificate struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
DNSNames []string `json:"dns_names,omitempty"`
NotAfter string `json:"not_after,omitempty"`
SHA1Fingerprint string `json:"sha1_fingerprint,omitempty"`
Created string `json:"created_at,omitempty"`
State string `json:"state,omitempty"`
Type string `json:"type,omitempty"`
}
Certificate represents a Abrha certificate configuration.
type CertificateRequest ¶
type CertificateRequest struct {
Name string `json:"name,omitempty"`
DNSNames []string `json:"dns_names,omitempty"`
PrivateKey string `json:"private_key,omitempty"`
LeafCertificate string `json:"leaf_certificate,omitempty"`
CertificateChain string `json:"certificate_chain,omitempty"`
Type string `json:"type,omitempty"`
}
CertificateRequest represents configuration for a new certificate.
type CertificatesService ¶
type CertificatesService interface {
Get(context.Context, string) (*Certificate, *Response, error)
List(context.Context, *ListOptions) ([]Certificate, *Response, error)
ListByName(context.Context, string, *ListOptions) ([]Certificate, *Response, error)
Create(context.Context, *CertificateRequest) (*Certificate, *Response, error)
Delete(context.Context, string) (*Response, error)
}
CertificatesService is an interface for managing certificates with the Abrha API. See: https://docs.parspack.com/reference/api/cloud-server/#tag/Certificates
type CertificatesServiceOp ¶
type CertificatesServiceOp struct {
// contains filtered or unexported fields
}
CertificatesServiceOp handles communication with certificates methods of the Abrha API.
func (*CertificatesServiceOp) Create ¶
func (c *CertificatesServiceOp) Create(ctx context.Context, cr *CertificateRequest) (*Certificate, *Response, error)
Create a new certificate with provided configuration.
func (*CertificatesServiceOp) Get ¶
func (c *CertificatesServiceOp) Get(ctx context.Context, cID string) (*Certificate, *Response, error)
Get an existing certificate by its identifier.
func (*CertificatesServiceOp) List ¶
func (c *CertificatesServiceOp) List(ctx context.Context, opt *ListOptions) ([]Certificate, *Response, error)
List all certificates.
func (*CertificatesServiceOp) ListByName ¶
func (c *CertificatesServiceOp) ListByName(ctx context.Context, name string, opt *ListOptions) ([]Certificate, *Response, error)
type Client ¶
type Client struct {
// HTTP client used to communicate with the DO API.
HTTPClient *http.Client
// Base URL for API requests.
BaseURL *url.URL
// User agent for client
UserAgent string
// Rate contains the current rate limit for the client as determined by the most recent
// API call. It is not thread-safe. Please consider using GetRate() instead.
Rate Rate
// Services used for communicating with the API
Account AccountService
Actions ActionsService
Apps AppsService
Balance BalanceService
BillingHistory BillingHistoryService
CDNs CDNService
Certificates CertificatesService
Databases DatabasesService
Domains DomainsService
Vms VmsService
VmActions VmActionsService
VmAutoscale VmAutoscaleService
Firewalls FirewallsService
FloatingIPs FloatingIPsService
FloatingIPActions FloatingIPActionsService
Functions FunctionsService
Images ImagesService
ImageActions ImageActionsService
Invoices InvoicesService
Keys KeysService
Kubernetes KubernetesService
LoadBalancers LoadBalancersService
Monitoring MonitoringService
OneClick OneClickService
Projects ProjectsService
Regions RegionsService
Registry RegistryService
Registries RegistriesService
ReservedIPs ReservedIPsService
ReservedIPV6s ReservedIPV6sService
ReservedIPActions ReservedIPActionsService
ReservedIPV6Actions ReservedIPV6ActionsService
Sizes SizesService
Snapshots SnapshotsService
Storage StorageService
StorageActions StorageActionsService
Tags TagsService
UptimeChecks UptimeChecksService
VPCs VPCsService
// Optional retry values. Setting the RetryConfig.RetryMax value enables automatically retrying requests
// that fail with 429 or 500-level response codes using the go-retryablehttp client
RetryConfig RetryConfig
// contains filtered or unexported fields
}
Client manages communication with Abrha V2 API.
func NewClient ¶
NewClient returns a new Abrha API client, using the given http.Client to perform all requests.
Users who wish to pass their own http.Client should use this method. If you're in need of further customization, the go-api-abrha.New method allows more options, such as setting a custom URL or a custom user agent string.
func NewFromToken ¶
NewFromToken returns a new Abrha API client with the given API token.
func (*Client) Do ¶
Do sends an API request and returns the API response. The API response is JSON decoded and stored in the value pointed to by v, or returned as an error if an API error has occurred. If v implements the io.Writer interface, the raw response will be written to v, without attempting to decode it.
func (*Client) GetRate ¶
GetRate returns the current rate limit for the client as determined by the most recent API call. It is thread-safe.
func (*Client) NewRequest ¶
func (c *Client) NewRequest(ctx context.Context, method, urlStr string, body interface{}) (*http.Request, error)
NewRequest creates an API request. A relative URL can be provided in urlStr, which will be resolved to the BaseURL of the Client. Relative URLS should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included in as the request body.
func (*Client) OnRequestCompleted ¶
func (c *Client) OnRequestCompleted(rc RequestCompletionCallback)
OnRequestCompleted sets the DO API request completion callback
type ClientOpt ¶
ClientOpt are options for New.
func SetBaseURL ¶
SetBaseURL is a client option for setting the base URL.
func SetRequestHeaders ¶
SetRequestHeaders sets optional HTTP headers on the client that are sent on each HTTP request.
func SetStaticRateLimit ¶
SetStaticRateLimit sets an optional client-side rate limiter that restricts the number of queries per second that the client can send to enforce QoS.
func SetUserAgent ¶
SetUserAgent is a client option for setting the user agent.
func WithRetryAndBackoffs ¶
func WithRetryAndBackoffs(retryConfig RetryConfig) ClientOpt
WithRetryAndBackoffs sets retry values. Setting the RetryConfig.RetryMax value enables automatically retrying requests that fail with 429 or 500-level response codes using the go-retryablehttp client
type ClusterlintDiagnostic ¶
type ClusterlintDiagnostic struct {
CheckName string `json:"check_name"`
Severity string `json:"severity"`
Message string `json:"message"`
Object *ClusterlintObject `json:"object"`
}
ClusterlintDiagnostic is a diagnostic returned from clusterlint.
type ClusterlintObject ¶
type ClusterlintObject struct {
Kind string `json:"kind"`
Name string `json:"name"`
Namespace string `json:"namespace"`
Owners []*ClusterlintOwner `json:"owners,omitempty"`
}
ClusterlintObject is the object a clusterlint diagnostic refers to.
type ClusterlintOwner ¶
ClusterlintOwner indicates the resource that owns the offending object.
type CreateProjectRequest ¶
type CreateProjectRequest struct {
Name string `json:"name"`
Description string `json:"description"`
Purpose string `json:"purpose"`
Environment string `json:"environment"`
}
CreateProjectRequest represents the request to create a new project.
type CreateUptimeAlertRequest ¶
type CreateUptimeAlertRequest struct {
Name string `json:"name"`
Type string `json:"type"`
Threshold int `json:"threshold"`
Comparison UptimeAlertComp `json:"comparison"`
Notifications *Notifications `json:"notifications"`
Period string `json:"period"`
}
CreateUptimeUptimeAlertRequest represents the request to create a new Uptime Alert.
type CreateUptimeCheckRequest ¶
type CreateUptimeCheckRequest struct {
Name string `json:"name"`
Type string `json:"type"`
Target string `json:"target"`
Regions []string `json:"regions"`
Enabled bool `json:"enabled"`
}
CreateUptimeCheckRequest represents the request to create a new uptime check.
type CustomImageCreateRequest ¶
type CustomImageCreateRequest struct {
Name string `json:"name"`
Url string `json:"url"`
Region string `json:"region"`
Distribution string `json:"distribution,omitempty"`
Description string `json:"description,omitempty"`
Tags []string `json:"tags,omitempty"`
}
CustomImageCreateRequest represents a request to create a custom image.
type Database ¶
type Database struct {
ID string `json:"id,omitempty"`
Name string `json:"name,omitempty"`
EngineSlug string `json:"engine,omitempty"`
VersionSlug string `json:"version,omitempty"`
Connection *DatabaseConnection `json:"connection,omitempty"`
UIConnection *DatabaseConnection `json:"ui_connection,omitempty"`
PrivateConnection *DatabaseConnection `json:"private_connection,omitempty"`
StandbyConnection *DatabaseConnection `json:"standby_connection,omitempty"`
StandbyPrivateConnection *DatabaseConnection `json:"standby_private_connection,omitempty"`
Users []DatabaseUser `json:"users,omitempty"`
NumNodes int `json:"num_nodes,omitempty"`
SizeSlug string `json:"size,omitempty"`
DBNames []string `json:"db_names,omitempty"`
RegionSlug string `json:"region,omitempty"`
Status string `json:"status,omitempty"`
MaintenanceWindow *DatabaseMaintenanceWindow `json:"maintenance_window,omitempty"`
CreatedAt time.Time `json:"created_at,omitempty"`
PrivateNetworkUUID string `json:"private_network_uuid,omitempty"`
Tags []string `json:"tags,omitempty"`
ProjectID string `json:"project_id,omitempty"`
StorageSizeMib uint64 `json:"storage_size_mib,omitempty"`
MetricsEndpoints []*ServiceAddress `json:"metrics_endpoints,omitempty"`
}
Database represents a Abrha managed database product. These managed databases are usually comprised of a cluster of database nodes, a primary and 0 or more replicas. The EngineSlug is a string which indicates the type of database service. Some examples are "pg", "mysql" or "redis". A Database also includes connection information and other properties of the service like region, size and current status.
type DatabaseBackup ¶
type DatabaseBackup struct {
CreatedAt time.Time `json:"created_at,omitempty"`
SizeGigabytes float64 `json:"size_gigabytes,omitempty"`
}
DatabaseBackup represents a database backup.
type DatabaseBackupRestore ¶
type DatabaseBackupRestore struct {
DatabaseName string `json:"database_name,omitempty"`
BackupCreatedAt string `json:"backup_created_at,omitempty"`
}
DatabaseBackupRestore contains information needed to restore a backup.
type DatabaseCA ¶
type DatabaseCA struct {
Certificate []byte `json:"certificate"`
}
DatabaseCA represents a database ca.
type DatabaseConnection ¶
type DatabaseConnection struct {
Protocol string `json:"protocol"`
URI string `json:"uri,omitempty"`
Database string `json:"database,omitempty"`
Host string `json:"host,omitempty"`
Port int `json:"port,omitempty"`
User string `json:"user,omitempty"`
Password string `json:"password,omitempty"`
SSL bool `json:"ssl,omitempty"`
ApplicationPorts map[string]uint32 `json:"application_ports,omitempty"`
}
DatabaseConnection represents a database connection
type DatabaseCreateDBRequest ¶
type DatabaseCreateDBRequest struct {
Name string `json:"name"`
}
DatabaseCreateDBRequest is used to create a new engine-specific database within the cluster
type DatabaseCreateFirewallRule ¶
type DatabaseCreateFirewallRule struct {
UUID string `json:"uuid"`
Type string `json:"type"`
Value string `json:"value"`
}
DatabaseCreateFirewallRule is a rule describing an inbound source to a database
type DatabaseCreateLogsinkRequest ¶
type DatabaseCreateLogsinkRequest struct {
Name string `json:"sink_name"`
Type string `json:"sink_type"`
Config *DatabaseLogsinkConfig `json:"config"`
}
DatabaseCreateLogsinkRequest is used to create logsink for a database cluster
type DatabaseCreatePoolRequest ¶
type DatabaseCreatePoolRequest struct {
User string `json:"user"`
Name string `json:"name"`
Size int `json:"size"`
Database string `json:"db"`
Mode string `json:"mode"`
}
DatabaseCreatePoolRequest is used to create a new database connection pool
type DatabaseCreateReplicaRequest ¶
type DatabaseCreateReplicaRequest struct {
Name string `json:"name"`
Region string `json:"region"`
Size string `json:"size"`
PrivateNetworkUUID string `json:"private_network_uuid"`
Tags []string `json:"tags,omitempty"`
StorageSizeMib uint64 `json:"storage_size_mib,omitempty"`
}
DatabaseCreateReplicaRequest is used to create a new read-only replica
type DatabaseCreateRequest ¶
type DatabaseCreateRequest struct {
Name string `json:"name,omitempty"`
EngineSlug string `json:"engine,omitempty"`
Version string `json:"version,omitempty"`
SizeSlug string `json:"size,omitempty"`
Region string `json:"region,omitempty"`
NumNodes int `json:"num_nodes,omitempty"`
PrivateNetworkUUID string `json:"private_network_uuid"`
Tags []string `json:"tags,omitempty"`
BackupRestore *DatabaseBackupRestore `json:"backup_restore,omitempty"`
ProjectID string `json:"project_id"`
StorageSizeMib uint64 `json:"storage_size_mib,omitempty"`
Rules []*DatabaseCreateFirewallRule `json:"rules"`
}
DatabaseCreateRequest represents a request to create a database cluster
type DatabaseCreateTopicRequest ¶
type DatabaseCreateTopicRequest struct {
Name string `json:"name"`
PartitionCount *uint32 `json:"partition_count,omitempty"`
ReplicationFactor *uint32 `json:"replication_factor,omitempty"`
Config *TopicConfig `json:"config,omitempty"`
}
DatabaseCreateTopicRequest is used to create a new topic within a kafka cluster
type DatabaseCreateUserRequest ¶
type DatabaseCreateUserRequest struct {
Name string `json:"name"`
MySQLSettings *DatabaseMySQLUserSettings `json:"mysql_settings,omitempty"`
Settings *DatabaseUserSettings `json:"settings,omitempty"`
}
DatabaseCreateUserRequest is used to create a new database user
type DatabaseDB ¶
type DatabaseDB struct {
Name string `json:"name"`
}
DatabaseDB represents an engine-specific database created within a database cluster. For SQL databases like PostgreSQL or MySQL, a "DB" refers to a database created on the RDBMS. For instance, a PostgreSQL database server can contain many database schemas, each with its own settings, access permissions and data. ListDBs will return all databases present on the server.
type DatabaseEngineOptions ¶
type DatabaseEngineOptions struct {
Regions []string `json:"regions"`
Versions []string `json:"versions"`
Layouts []DatabaseLayout `json:"layouts"`
}
DatabaseEngineOptions represents the configuration options that are available for a given database engine
type DatabaseEvent ¶
type DatabaseEvent struct {
ID string `json:"id"`
ServiceName string `json:"cluster_name"`
EventType string `json:"event_type"`
CreateTime string `json:"create_time"`
}
DatbaseEvent contains the information about a Datbase event.
type DatabaseFirewallRule ¶
type DatabaseFirewallRule struct {
UUID string `json:"uuid"`
ClusterUUID string `json:"cluster_uuid"`
Type string `json:"type"`
Value string `json:"value"`
CreatedAt time.Time `json:"created_at"`
}
DatabaseFirewallRule is a rule describing an inbound source to a database
type DatabaseIndex ¶
type DatabaseIndex struct {
IndexName string `json:"index_name"`
NumberofShards uint64 `json:"number_of_shards"`
NumberofReplicas uint64 `json:"number_of_replicas"`
Size int64 `json:"size,omitempty"`
Health string `json:"health,omitempty"`
Status string `json:"status,omitempty"`
Docs int64 `json:"docs,omitempty"`
CreateTime string `json:"create_time"`
Replication *IndexReplication `json:"replication,omitempty"`
}
type DatabaseLayout ¶
DatabaseLayout represents the slugs available for a given database engine at various node counts
type DatabaseLogsink ¶
type DatabaseLogsink struct {
ID string `json:"sink_id"`
Name string `json:"sink_name,omitempty"`
Type string `json:"sink_type,omitempty"`
Config *DatabaseLogsinkConfig `json:"config,omitempty"`
}
DatabaseLogsink represents a logsink
type DatabaseLogsinkConfig ¶
type DatabaseLogsinkConfig struct {
URL string `json:"url,omitempty"`
IndexPrefix string `json:"index_prefix,omitempty"`
IndexDaysMax int `json:"index_days_max,omitempty"`
Timeout float32 `json:"timeout,omitempty"`
Server string `json:"server,omitempty"`
Port int `json:"port,omitempty"`
TLS bool `json:"tls,omitempty"`
Format string `json:"format,omitempty"`
Logline string `json:"logline,omitempty"`
SD string `json:"sd,omitempty"`
CA string `json:"ca,omitempty"`
Key string `json:"key,omitempty"`
Cert string `json:"cert,omitempty"`
}
DatabaseLogsinkConfig represents one of the configurable options (rsyslog_logsink, elasticsearch_logsink, or opensearch_logsink) for a logsink.
type DatabaseMaintenanceWindow ¶
type DatabaseMaintenanceWindow struct {
Day string `json:"day,omitempty"`
Hour string `json:"hour,omitempty"`
Pending bool `json:"pending,omitempty"`
Description []string `json:"description,omitempty"`
}
DatabaseMaintenanceWindow represents the maintenance_window of a database cluster
type DatabaseMigrateRequest ¶
type DatabaseMigrateRequest struct {
Region string `json:"region,omitempty"`
PrivateNetworkUUID string `json:"private_network_uuid"`
}
DatabaseMigrateRequest can be used to initiate a database migrate operation.
type DatabaseMySQLUserSettings ¶
type DatabaseMySQLUserSettings struct {
AuthPlugin string `json:"auth_plugin"`
}
DatabaseMySQLUserSettings contains MySQL-specific user settings
type DatabaseOptions ¶
type DatabaseOptions struct {
MongoDBOptions DatabaseEngineOptions `json:"mongodb"`
MySQLOptions DatabaseEngineOptions `json:"mysql"`
PostgresSQLOptions DatabaseEngineOptions `json:"pg"`
RedisOptions DatabaseEngineOptions `json:"redis"`
KafkaOptions DatabaseEngineOptions `json:"kafka"`
OpensearchOptions DatabaseEngineOptions `json:"opensearch"`
}
DatabaseOptions represents the available database engines
type DatabasePool ¶
type DatabasePool struct {
User string `json:"user"`
Name string `json:"name"`
Size int `json:"size"`
Database string `json:"db"`
Mode string `json:"mode"`
Connection *DatabaseConnection `json:"connection"`
PrivateConnection *DatabaseConnection `json:"private_connection,omitempty"`
StandbyConnection *DatabaseConnection `json:"standby_connection,omitempty"`
StandbyPrivateConnection *DatabaseConnection `json:"standby_private_connection,omitempty"`
}
DatabasePool represents a database connection pool
type DatabaseReplica ¶
type DatabaseReplica struct {
ID string `json:"id"`
Name string `json:"name"`
Connection *DatabaseConnection `json:"connection"`
PrivateConnection *DatabaseConnection `json:"private_connection,omitempty"`
Region string `json:"region"`
Status string `json:"status"`
CreatedAt time.Time `json:"created_at"`
PrivateNetworkUUID string `json:"private_network_uuid,omitempty"`
Tags []string `json:"tags,omitempty"`
StorageSizeMib uint64 `json:"storage_size_mib,omitempty"`
Size string `json:"size"`
}
DatabaseReplica represents a read-only replica of a particular database
type DatabaseResetUserAuthRequest ¶
type DatabaseResetUserAuthRequest struct {
MySQLSettings *DatabaseMySQLUserSettings `json:"mysql_settings,omitempty"`
Settings *DatabaseUserSettings `json:"settings,omitempty"`
}
DatabaseResetUserAuthRequest is used to reset a users DB auth
type DatabaseResizeRequest ¶
type DatabaseResizeRequest struct {
SizeSlug string `json:"size,omitempty"`
NumNodes int `json:"num_nodes,omitempty"`
StorageSizeMib uint64 `json:"storage_size_mib,omitempty"`
}
DatabaseResizeRequest can be used to initiate a database resize operation.
type DatabaseTopic ¶
type DatabaseTopic struct {
Name string `json:"name"`
Partitions []*TopicPartition `json:"partitions,omitempty"`
ReplicationFactor *uint32 `json:"replication_factor,omitempty"`
State string `json:"state,omitempty"`
Config *TopicConfig `json:"config,omitempty"`
}
DatabaseTopic represents a Kafka topic
type DatabaseUpdateFirewallRulesRequest ¶
type DatabaseUpdateFirewallRulesRequest struct {
Rules []*DatabaseFirewallRule `json:"rules"`
}
DatabaseUpdateFirewallRulesRequest is used to set the firewall rules for a database
type DatabaseUpdateLogsinkRequest ¶
type DatabaseUpdateLogsinkRequest struct {
Config *DatabaseLogsinkConfig `json:"config"`
}
DatabaseUpdateLogsinkRequest is used to update logsink for a database cluster
type DatabaseUpdateMaintenanceRequest ¶
type DatabaseUpdateMaintenanceRequest struct {
Day string `json:"day,omitempty"`
Hour string `json:"hour,omitempty"`
}
DatabaseUpdateMaintenanceRequest can be used to update the database's maintenance window.
type DatabaseUpdateMetricsCredentialsRequest ¶
type DatabaseUpdateMetricsCredentialsRequest struct {
Credentials *DatabaseMetricsCredentials `json:"credentials"`
}
type DatabaseUpdatePoolRequest ¶
type DatabaseUpdatePoolRequest struct {
User string `json:"user,omitempty"`
Size int `json:"size"`
Database string `json:"db"`
Mode string `json:"mode"`
}
DatabaseUpdatePoolRequest is used to update a database connection pool
type DatabaseUpdateTopicRequest ¶
type DatabaseUpdateTopicRequest struct {
PartitionCount *uint32 `json:"partition_count,omitempty"`
ReplicationFactor *uint32 `json:"replication_factor,omitempty"`
Config *TopicConfig `json:"config,omitempty"`
}
DatabaseUpdateTopicRequest ...
type DatabaseUpdateUserRequest ¶
type DatabaseUpdateUserRequest struct {
Settings *DatabaseUserSettings `json:"settings,omitempty"`
}
DatabaseUpdateUserRequest is used to update an existing database user
type DatabaseUser ¶
type DatabaseUser struct {
Name string `json:"name,omitempty"`
Role string `json:"role,omitempty"`
Password string `json:"password,omitempty"`
AccessCert string `json:"access_cert,omitempty"`
AccessKey string `json:"access_key,omitempty"`
MySQLSettings *DatabaseMySQLUserSettings `json:"mysql_settings,omitempty"`
Settings *DatabaseUserSettings `json:"settings,omitempty"`
}
DatabaseUser represents a user in the database
type DatabaseUserSettings ¶
type DatabaseUserSettings struct {
ACL []*KafkaACL `json:"acl,omitempty"`
OpenSearchACL []*OpenSearchACL `json:"opensearch_acl,omitempty"`
}
DatabaseUserSettings contains user settings
type DatabasesService ¶
type DatabasesService interface {
List(context.Context, *ListOptions) ([]Database, *Response, error)
Get(context.Context, string) (*Database, *Response, error)
GetCA(context.Context, string) (*DatabaseCA, *Response, error)
Create(context.Context, *DatabaseCreateRequest) (*Database, *Response, error)
Delete(context.Context, string) (*Response, error)
Resize(context.Context, string, *DatabaseResizeRequest) (*Response, error)
Migrate(context.Context, string, *DatabaseMigrateRequest) (*Response, error)
UpdateMaintenance(context.Context, string, *DatabaseUpdateMaintenanceRequest) (*Response, error)
InstallUpdate(context.Context, string) (*Response, error)
ListBackups(context.Context, string, *ListOptions) ([]DatabaseBackup, *Response, error)
GetUser(context.Context, string, string) (*DatabaseUser, *Response, error)
ListUsers(context.Context, string, *ListOptions) ([]DatabaseUser, *Response, error)
CreateUser(context.Context, string, *DatabaseCreateUserRequest) (*DatabaseUser, *Response, error)
UpdateUser(context.Context, string, string, *DatabaseUpdateUserRequest) (*DatabaseUser, *Response, error)
DeleteUser(context.Context, string, string) (*Response, error)
ResetUserAuth(context.Context, string, string, *DatabaseResetUserAuthRequest) (*DatabaseUser, *Response, error)
ListDBs(context.Context, string, *ListOptions) ([]DatabaseDB, *Response, error)
CreateDB(context.Context, string, *DatabaseCreateDBRequest) (*DatabaseDB, *Response, error)
GetDB(context.Context, string, string) (*DatabaseDB, *Response, error)
DeleteDB(context.Context, string, string) (*Response, error)
ListPools(context.Context, string, *ListOptions) ([]DatabasePool, *Response, error)
CreatePool(context.Context, string, *DatabaseCreatePoolRequest) (*DatabasePool, *Response, error)
GetPool(context.Context, string, string) (*DatabasePool, *Response, error)
DeletePool(context.Context, string, string) (*Response, error)
UpdatePool(context.Context, string, string, *DatabaseUpdatePoolRequest) (*Response, error)
GetReplica(context.Context, string, string) (*DatabaseReplica, *Response, error)
ListReplicas(context.Context, string, *ListOptions) ([]DatabaseReplica, *Response, error)
CreateReplica(context.Context, string, *DatabaseCreateReplicaRequest) (*DatabaseReplica, *Response, error)
DeleteReplica(context.Context, string, string) (*Response, error)
PromoteReplicaToPrimary(context.Context, string, string) (*Response, error)
GetEvictionPolicy(context.Context, string) (string, *Response, error)
SetEvictionPolicy(context.Context, string, string) (*Response, error)
GetSQLMode(context.Context, string) (string, *Response, error)
SetSQLMode(context.Context, string, ...string) (*Response, error)
GetFirewallRules(context.Context, string) ([]DatabaseFirewallRule, *Response, error)
UpdateFirewallRules(context.Context, string, *DatabaseUpdateFirewallRulesRequest) (*Response, error)
GetPostgreSQLConfig(context.Context, string) (*PostgreSQLConfig, *Response, error)
GetRedisConfig(context.Context, string) (*RedisConfig, *Response, error)
GetMySQLConfig(context.Context, string) (*MySQLConfig, *Response, error)
GetMongoDBConfig(context.Context, string) (*MongoDBConfig, *Response, error)
GetOpensearchConfig(context.Context, string) (*OpensearchConfig, *Response, error)
GetKafkaConfig(context.Context, string) (*KafkaConfig, *Response, error)
UpdatePostgreSQLConfig(context.Context, string, *PostgreSQLConfig) (*Response, error)
UpdateRedisConfig(context.Context, string, *RedisConfig) (*Response, error)
UpdateMySQLConfig(context.Context, string, *MySQLConfig) (*Response, error)
UpdateMongoDBConfig(context.Context, string, *MongoDBConfig) (*Response, error)
UpdateOpensearchConfig(context.Context, string, *OpensearchConfig) (*Response, error)
UpdateKafkaConfig(context.Context, string, *KafkaConfig) (*Response, error)
ListOptions(todo context.Context) (*DatabaseOptions, *Response, error)
UpgradeMajorVersion(context.Context, string, *UpgradeVersionRequest) (*Response, error)
ListTopics(context.Context, string, *ListOptions) ([]DatabaseTopic, *Response, error)
CreateTopic(context.Context, string, *DatabaseCreateTopicRequest) (*DatabaseTopic, *Response, error)
GetTopic(context.Context, string, string) (*DatabaseTopic, *Response, error)
DeleteTopic(context.Context, string, string) (*Response, error)
UpdateTopic(context.Context, string,