Documentation
¶
Index ¶
- type GetCertificateOption
- type GetCertificateOptions
- type GetFailedJobsOption
- type GetFailedJobsOptions
- type GetQueueBuildsOption
- type GetQueueBuildsOptions
- type GetQueueCertificatesOption
- type GetQueueCertificatesOptions
- type GetQueueDatabasesOption
- type GetQueueDatabasesOptions
- type GetQueueDeletesOption
- type GetQueueDeletesOptions
- type GetQueueFunctionsOption
- type GetQueueFunctionsOptions
- type GetQueueLogsOption
- type GetQueueLogsOptions
- type GetQueueMailsOption
- type GetQueueMailsOptions
- type GetQueueMessagingOption
- type GetQueueMessagingOptions
- type GetQueueMigrationsOption
- type GetQueueMigrationsOptions
- type GetQueueUsageDumpOption
- type GetQueueUsageDumpOptions
- type GetQueueUsageOption
- type GetQueueUsageOptions
- type GetQueueWebhooksOption
- type GetQueueWebhooksOptions
- type Health
- func (srv *Health) Get() (*models.HealthStatus, error)
- func (srv *Health) GetAntivirus() (*models.HealthAntivirus, error)
- func (srv *Health) GetCache() (*models.HealthStatus, error)
- func (srv *Health) GetCertificate(optionalSetters ...GetCertificateOption) (*models.HealthCertificate, error)
- func (srv *Health) GetDB() (*models.HealthStatus, error)
- func (srv *Health) GetFailedJobs(Name string, optionalSetters ...GetFailedJobsOption) (*models.HealthQueue, error)
- func (srv *Health) GetPubSub() (*models.HealthStatus, error)
- func (srv *Health) GetQueue() (*models.HealthStatus, error)
- func (srv *Health) GetQueueBuilds(optionalSetters ...GetQueueBuildsOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueCertificates(optionalSetters ...GetQueueCertificatesOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueDatabases(optionalSetters ...GetQueueDatabasesOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueDeletes(optionalSetters ...GetQueueDeletesOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueFunctions(optionalSetters ...GetQueueFunctionsOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueLogs(optionalSetters ...GetQueueLogsOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueMails(optionalSetters ...GetQueueMailsOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueMessaging(optionalSetters ...GetQueueMessagingOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueMigrations(optionalSetters ...GetQueueMigrationsOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueUsage(optionalSetters ...GetQueueUsageOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueUsageDump(optionalSetters ...GetQueueUsageDumpOption) (*models.HealthQueue, error)
- func (srv *Health) GetQueueWebhooks(optionalSetters ...GetQueueWebhooksOption) (*models.HealthQueue, error)
- func (srv *Health) GetStorage() (*models.HealthStatus, error)
- func (srv *Health) GetStorageLocal() (*models.HealthStatus, error)
- func (srv *Health) GetTime() (*models.HealthTime, error)
- func (srv *Health) WithGetCertificateDomain(v string) GetCertificateOption
- func (srv *Health) WithGetFailedJobsThreshold(v int) GetFailedJobsOption
- func (srv *Health) WithGetQueueBuildsThreshold(v int) GetQueueBuildsOption
- func (srv *Health) WithGetQueueCertificatesThreshold(v int) GetQueueCertificatesOption
- func (srv *Health) WithGetQueueDatabasesName(v string) GetQueueDatabasesOption
- func (srv *Health) WithGetQueueDatabasesThreshold(v int) GetQueueDatabasesOption
- func (srv *Health) WithGetQueueDeletesThreshold(v int) GetQueueDeletesOption
- func (srv *Health) WithGetQueueFunctionsThreshold(v int) GetQueueFunctionsOption
- func (srv *Health) WithGetQueueLogsThreshold(v int) GetQueueLogsOption
- func (srv *Health) WithGetQueueMailsThreshold(v int) GetQueueMailsOption
- func (srv *Health) WithGetQueueMessagingThreshold(v int) GetQueueMessagingOption
- func (srv *Health) WithGetQueueMigrationsThreshold(v int) GetQueueMigrationsOption
- func (srv *Health) WithGetQueueUsageDumpThreshold(v int) GetQueueUsageDumpOption
- func (srv *Health) WithGetQueueUsageThreshold(v int) GetQueueUsageOption
- func (srv *Health) WithGetQueueWebhooksThreshold(v int) GetQueueWebhooksOption
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetCertificateOption ¶
type GetCertificateOption func(*GetCertificateOptions)
type GetCertificateOptions ¶
type GetCertificateOptions struct {
Domain string
// contains filtered or unexported fields
}
func (GetCertificateOptions) New ¶
func (options GetCertificateOptions) New() *GetCertificateOptions
type GetFailedJobsOption ¶
type GetFailedJobsOption func(*GetFailedJobsOptions)
type GetFailedJobsOptions ¶
type GetFailedJobsOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetFailedJobsOptions) New ¶
func (options GetFailedJobsOptions) New() *GetFailedJobsOptions
type GetQueueBuildsOption ¶
type GetQueueBuildsOption func(*GetQueueBuildsOptions)
type GetQueueBuildsOptions ¶
type GetQueueBuildsOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueBuildsOptions) New ¶
func (options GetQueueBuildsOptions) New() *GetQueueBuildsOptions
type GetQueueCertificatesOption ¶
type GetQueueCertificatesOption func(*GetQueueCertificatesOptions)
type GetQueueCertificatesOptions ¶
type GetQueueCertificatesOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueCertificatesOptions) New ¶
func (options GetQueueCertificatesOptions) New() *GetQueueCertificatesOptions
type GetQueueDatabasesOption ¶
type GetQueueDatabasesOption func(*GetQueueDatabasesOptions)
type GetQueueDatabasesOptions ¶
type GetQueueDatabasesOptions struct {
Name string
Threshold int
// contains filtered or unexported fields
}
func (GetQueueDatabasesOptions) New ¶
func (options GetQueueDatabasesOptions) New() *GetQueueDatabasesOptions
type GetQueueDeletesOption ¶
type GetQueueDeletesOption func(*GetQueueDeletesOptions)
type GetQueueDeletesOptions ¶
type GetQueueDeletesOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueDeletesOptions) New ¶
func (options GetQueueDeletesOptions) New() *GetQueueDeletesOptions
type GetQueueFunctionsOption ¶
type GetQueueFunctionsOption func(*GetQueueFunctionsOptions)
type GetQueueFunctionsOptions ¶
type GetQueueFunctionsOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueFunctionsOptions) New ¶
func (options GetQueueFunctionsOptions) New() *GetQueueFunctionsOptions
type GetQueueLogsOption ¶
type GetQueueLogsOption func(*GetQueueLogsOptions)
type GetQueueLogsOptions ¶
type GetQueueLogsOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueLogsOptions) New ¶
func (options GetQueueLogsOptions) New() *GetQueueLogsOptions
type GetQueueMailsOption ¶
type GetQueueMailsOption func(*GetQueueMailsOptions)
type GetQueueMailsOptions ¶
type GetQueueMailsOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueMailsOptions) New ¶
func (options GetQueueMailsOptions) New() *GetQueueMailsOptions
type GetQueueMessagingOption ¶
type GetQueueMessagingOption func(*GetQueueMessagingOptions)
type GetQueueMessagingOptions ¶
type GetQueueMessagingOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueMessagingOptions) New ¶
func (options GetQueueMessagingOptions) New() *GetQueueMessagingOptions
type GetQueueMigrationsOption ¶
type GetQueueMigrationsOption func(*GetQueueMigrationsOptions)
type GetQueueMigrationsOptions ¶
type GetQueueMigrationsOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueMigrationsOptions) New ¶
func (options GetQueueMigrationsOptions) New() *GetQueueMigrationsOptions
type GetQueueUsageDumpOption ¶
type GetQueueUsageDumpOption func(*GetQueueUsageDumpOptions)
type GetQueueUsageDumpOptions ¶
type GetQueueUsageDumpOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueUsageDumpOptions) New ¶
func (options GetQueueUsageDumpOptions) New() *GetQueueUsageDumpOptions
type GetQueueUsageOption ¶
type GetQueueUsageOption func(*GetQueueUsageOptions)
type GetQueueUsageOptions ¶
type GetQueueUsageOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueUsageOptions) New ¶
func (options GetQueueUsageOptions) New() *GetQueueUsageOptions
type GetQueueWebhooksOption ¶
type GetQueueWebhooksOption func(*GetQueueWebhooksOptions)
type GetQueueWebhooksOptions ¶
type GetQueueWebhooksOptions struct {
Threshold int
// contains filtered or unexported fields
}
func (GetQueueWebhooksOptions) New ¶
func (options GetQueueWebhooksOptions) New() *GetQueueWebhooksOptions
type Health ¶
type Health struct {
// contains filtered or unexported fields
}
Health service
func (*Health) Get ¶
func (srv *Health) Get() (*models.HealthStatus, error)
Get check the Appwrite HTTP server is up and responsive.
func (*Health) GetAntivirus ¶
func (srv *Health) GetAntivirus() (*models.HealthAntivirus, error)
GetAntivirus check the Appwrite Antivirus server is up and connection is successful.
func (*Health) GetCache ¶
func (srv *Health) GetCache() (*models.HealthStatus, error)
GetCache check the Appwrite in-memory cache servers are up and connection is successful.
func (*Health) GetCertificate ¶
func (srv *Health) GetCertificate(optionalSetters ...GetCertificateOption) (*models.HealthCertificate, error)
GetCertificate get the SSL certificate for a domain
func (*Health) GetDB ¶
func (srv *Health) GetDB() (*models.HealthStatus, error)
GetDB check the Appwrite database servers are up and connection is successful.
func (*Health) GetFailedJobs ¶
func (srv *Health) GetFailedJobs(Name string, optionalSetters ...GetFailedJobsOption) (*models.HealthQueue, error)
GetFailedJobs returns the amount of failed jobs in a given queue.
func (*Health) GetPubSub ¶
func (srv *Health) GetPubSub() (*models.HealthStatus, error)
GetPubSub check the Appwrite pub-sub servers are up and connection is successful.
func (*Health) GetQueue ¶
func (srv *Health) GetQueue() (*models.HealthStatus, error)
GetQueue check the Appwrite queue messaging servers are up and connection is successful.
func (*Health) GetQueueBuilds ¶
func (srv *Health) GetQueueBuilds(optionalSetters ...GetQueueBuildsOption) (*models.HealthQueue, error)
GetQueueBuilds get the number of builds that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueCertificates ¶
func (srv *Health) GetQueueCertificates(optionalSetters ...GetQueueCertificatesOption) (*models.HealthQueue, error)
GetQueueCertificates get the number of certificates that are waiting to be issued against [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue server.
func (*Health) GetQueueDatabases ¶
func (srv *Health) GetQueueDatabases(optionalSetters ...GetQueueDatabasesOption) (*models.HealthQueue, error)
GetQueueDatabases get the number of database changes that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueDeletes ¶
func (srv *Health) GetQueueDeletes(optionalSetters ...GetQueueDeletesOption) (*models.HealthQueue, error)
GetQueueDeletes get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueFunctions ¶
func (srv *Health) GetQueueFunctions(optionalSetters ...GetQueueFunctionsOption) (*models.HealthQueue, error)
GetQueueFunctions get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueLogs ¶
func (srv *Health) GetQueueLogs(optionalSetters ...GetQueueLogsOption) (*models.HealthQueue, error)
GetQueueLogs get the number of logs that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueMails ¶
func (srv *Health) GetQueueMails(optionalSetters ...GetQueueMailsOption) (*models.HealthQueue, error)
GetQueueMails get the number of mails that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueMessaging ¶
func (srv *Health) GetQueueMessaging(optionalSetters ...GetQueueMessagingOption) (*models.HealthQueue, error)
GetQueueMessaging get the number of messages that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueMigrations ¶
func (srv *Health) GetQueueMigrations(optionalSetters ...GetQueueMigrationsOption) (*models.HealthQueue, error)
GetQueueMigrations get the number of migrations that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueUsage ¶
func (srv *Health) GetQueueUsage(optionalSetters ...GetQueueUsageOption) (*models.HealthQueue, error)
GetQueueUsage get the number of metrics that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueUsageDump ¶
func (srv *Health) GetQueueUsageDump(optionalSetters ...GetQueueUsageDumpOption) (*models.HealthQueue, error)
GetQueueUsageDump get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetQueueWebhooks ¶
func (srv *Health) GetQueueWebhooks(optionalSetters ...GetQueueWebhooksOption) (*models.HealthQueue, error)
GetQueueWebhooks get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
func (*Health) GetStorage ¶
func (srv *Health) GetStorage() (*models.HealthStatus, error)
GetStorage check the Appwrite storage device is up and connection is successful.
func (*Health) GetStorageLocal ¶
func (srv *Health) GetStorageLocal() (*models.HealthStatus, error)
GetStorageLocal check the Appwrite local storage device is up and connection is successful.
func (*Health) GetTime ¶
func (srv *Health) GetTime() (*models.HealthTime, error)
GetTime check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.
func (*Health) WithGetCertificateDomain ¶
func (srv *Health) WithGetCertificateDomain(v string) GetCertificateOption
func (*Health) WithGetFailedJobsThreshold ¶
func (srv *Health) WithGetFailedJobsThreshold(v int) GetFailedJobsOption
func (*Health) WithGetQueueBuildsThreshold ¶
func (srv *Health) WithGetQueueBuildsThreshold(v int) GetQueueBuildsOption
func (*Health) WithGetQueueCertificatesThreshold ¶
func (srv *Health) WithGetQueueCertificatesThreshold(v int) GetQueueCertificatesOption
func (*Health) WithGetQueueDatabasesName ¶
func (srv *Health) WithGetQueueDatabasesName(v string) GetQueueDatabasesOption
func (*Health) WithGetQueueDatabasesThreshold ¶
func (srv *Health) WithGetQueueDatabasesThreshold(v int) GetQueueDatabasesOption
func (*Health) WithGetQueueDeletesThreshold ¶
func (srv *Health) WithGetQueueDeletesThreshold(v int) GetQueueDeletesOption
func (*Health) WithGetQueueFunctionsThreshold ¶
func (srv *Health) WithGetQueueFunctionsThreshold(v int) GetQueueFunctionsOption
func (*Health) WithGetQueueLogsThreshold ¶
func (srv *Health) WithGetQueueLogsThreshold(v int) GetQueueLogsOption
func (*Health) WithGetQueueMailsThreshold ¶
func (srv *Health) WithGetQueueMailsThreshold(v int) GetQueueMailsOption
func (*Health) WithGetQueueMessagingThreshold ¶
func (srv *Health) WithGetQueueMessagingThreshold(v int) GetQueueMessagingOption
func (*Health) WithGetQueueMigrationsThreshold ¶
func (srv *Health) WithGetQueueMigrationsThreshold(v int) GetQueueMigrationsOption
func (*Health) WithGetQueueUsageDumpThreshold ¶
func (srv *Health) WithGetQueueUsageDumpThreshold(v int) GetQueueUsageDumpOption
func (*Health) WithGetQueueUsageThreshold ¶
func (srv *Health) WithGetQueueUsageThreshold(v int) GetQueueUsageOption
func (*Health) WithGetQueueWebhooksThreshold ¶
func (srv *Health) WithGetQueueWebhooksThreshold(v int) GetQueueWebhooksOption