dockhand

package
v0.2.0 Latest Latest
Warning

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

Go to latest
Published: Oct 14, 2026 License: GPL-3.0 Imports: 14 Imported by: 0

Documentation ¶

Overview ¶

Package dockhand is a typed client for Dockhand API 1.0.51, generated by pandorest from the definitions in api-defs/dockhand-1.0.51, which were imported from api-defs/dockhand-openapi-1.0.51.json.

Layout ¶

Every operation of the API is a method on Client, in a file of its own named <tag>_method_<operation>.go. Each model is in <tag>_model_<model>.go and each tag's enums in <tag>_constants.go; a model or enum more than one tag uses is under common_. The requests go through the hand-written base client, github.com/katbyte/pandorest/client.

Calls ¶

A method takes a context, then the path parameters in path order, then the request body (input: the model for a JSON body, or an io.Reader and its content type for raw bytes), then, when the operation has query or header parameters, a <Name>Options, which may be left out when every one of them is optional. Unset options are not sent: a boolean or a number is a pointer, sent when set (so 0 and false can be asked for), an empty string or list is skipped, and a list is sent comma-joined or as one parameter for each element, as the document says.

It returns a <Name>Response holding HttpResponse and, when the operation answers JSON, Answer: a pointer for a struct, enum or primitive, nil when the server answered with no body, and the value for a list, map or raw JSON. Answered() says whether a body came and was decoded. A struct answer is also embedded, so res.Answer.Name may be read as res.Name, a zero record when nothing was answered, and Record() hands it back by value with an error when none came. HttpResponse is set whenever the server answered, including alongside an error. An operation that answers a file has no Answer: WriteTo(w) copies the file out and closes the body, Bytes(max) reads it whole up to a size, Reader() hands the body over with its content type, ContentLength() and Filename() say what the server said of it, and the body is also still in HttpResponse.Body. A status the operation does not document is an error: client.StatusCode reads the status from it, and IsNotFound and the other Is helpers say which it is.

Ids ¶

EnvironmentID, NotificationID, RegistryID, UserID, RoleID, GitRepositoryID, GitCredentialID, GitStackID, SecretProviderID, ConfigSetID, TagID, TemplateSourceID, BackupDestinationID, BackupConfigID are kinds of id the package tells apart, each a bare named type over the int or string the document declares, so that one kind where another goes does not compile. Where an id sits among the options it is held by value and sent when not zero. int(id) and SeriesID(n) convert one value, client.IDs and client.StringIDs a list.

Nearly every call that is about a Docker host takes it as the query parameter env, the environment's number from GetEnvironments. Left out, most calls answer with nothing rather than an error, so a caller sets it.

Workarounds ¶

The importer fixed these bugs in the document before generating from it:

  • dockhand-audit-outside-api
  • dockhand-undeclared-responses
  • dockhand-environment-create-fields
  • dockhand-environment-record
  • dockhand-wrong-answer-types
  • dockhand-container-list
  • dockhand-stack-list
  • dockhand-dashboard-stats-env
  • dockhand-stack-action-answers
  • dockhand-vulnerability-count-options
  • dockhand-oidc-redirects
  • dockhand-scan-export-env
  • dockhand-image-answers
  • dockhand-volume-answers
  • dockhand-network-answers
  • dockhand-prune-answers
  • dockhand-stack-answers
  • dockhand-container-answers
  • dockhand-update-answers
  • dockhand-container-update-fields
  • dockhand-activity-answers
  • dockhand-disk-answers
  • dockhand-schedule-answers
  • dockhand-registry-answers
  • dockhand-notification-answers
  • dockhand-scan-answers
  • dockhand-user-answers
  • dockhand-sso-answers
  • dockhand-settings-answers
  • dockhand-template-answers
  • dockhand-tag-answers
  • dockhand-label-answers
  • dockhand-icon-answers
  • dockhand-preference-answers
  • dockhand-secret-provider-answers
  • dockhand-git-answers
  • dockhand-backup-answers
  • dockhand-job-accept
  • dockhand-unsaid-flags
  • dockhand-dates
  • dockhand-unix-dates
  • dockhand-enums-everywhere
  • dockhand-enums-containers
  • dockhand-enums-findings
  • dockhand-enums-checks
  • dockhand-enums-environments
  • dockhand-enums-jobs
  • dockhand-enums-stacks
  • dockhand-enums-runs
  • dockhand-enums-deploys
  • dockhand-enums-notifications
  • dockhand-enums-secret-providers
  • dockhand-enums-changelog
  • dockhand-enums-schedules
  • dockhand-enums-files
  • dockhand-enums-sign-in
  • dockhand-enums-templates

Index ¶

Constants ¶

View Source
const APIVersion = "1.0.51"

APIVersion is the version of the API document this package was generated from (Dockhand API, as the document names itself); a server of another version may answer differently.

View Source
const AcceptJob = "*/*"

AcceptJob is what a call Dockhand can run in the background is given as its Accept option to be answered with the id of a job at once, where it otherwise does all of the work before it answers. The answer then holds JobId alone, and GetJobsById says how the job goes and how it went.

View Source
const DocumentVersion = "1.0.51"

DocumentVersion is the version the document's file is named by: the release of the server it was taken from, which is the one to compare with a running server's where the document's own version names the API and does not move from release to release.

Variables ¶

This section is empty.

Functions ¶

func PossibleValuesForChangeType ¶

func PossibleValuesForChangeType() []string

PossibleValuesForChangeType returns every value of ChangeType.

func PossibleValuesForCheckSeverity ¶

func PossibleValuesForCheckSeverity() []string

PossibleValuesForCheckSeverity returns every value of CheckSeverity.

func PossibleValuesForConnectionType ¶

func PossibleValuesForConnectionType() []string

PossibleValuesForConnectionType returns every value of ConnectionType.

func PossibleValuesForContainerHealth ¶

func PossibleValuesForContainerHealth() []string

PossibleValuesForContainerHealth returns every value of ContainerHealth.

func PossibleValuesForContainerState ¶

func PossibleValuesForContainerState() []string

PossibleValuesForContainerState returns every value of ContainerState.

func PossibleValuesForDeployStatus ¶

func PossibleValuesForDeployStatus() []string

PossibleValuesForDeployStatus returns every value of DeployStatus.

func PossibleValuesForDiskWarningMode ¶

func PossibleValuesForDiskWarningMode() []string

PossibleValuesForDiskWarningMode returns every value of DiskWarningMode.

func PossibleValuesForEnvironmentProtocol ¶

func PossibleValuesForEnvironmentProtocol() []string

PossibleValuesForEnvironmentProtocol returns every value of EnvironmentProtocol.

func PossibleValuesForEventScope ¶

func PossibleValuesForEventScope() []string

PossibleValuesForEventScope returns every value of EventScope.

func PossibleValuesForFileType ¶

func PossibleValuesForFileType() []string

PossibleValuesForFileType returns every value of FileType.

func PossibleValuesForGitAuthType ¶

func PossibleValuesForGitAuthType() []string

PossibleValuesForGitAuthType returns every value of GitAuthType.

func PossibleValuesForJobStatus ¶

func PossibleValuesForJobStatus() []string

PossibleValuesForJobStatus returns every value of JobStatus.

func PossibleValuesForNotificationType ¶

func PossibleValuesForNotificationType() []string

PossibleValuesForNotificationType returns every value of NotificationType.

func PossibleValuesForRestartPolicy ¶

func PossibleValuesForRestartPolicy() []string

PossibleValuesForRestartPolicy returns every value of RestartPolicy.

func PossibleValuesForRunStatus ¶

func PossibleValuesForRunStatus() []string

PossibleValuesForRunStatus returns every value of RunStatus.

func PossibleValuesForScanStage ¶

func PossibleValuesForScanStage() []string

PossibleValuesForScanStage returns every value of ScanStage.

func PossibleValuesForScanner ¶

func PossibleValuesForScanner() []string

PossibleValuesForScanner returns every value of Scanner.

func PossibleValuesForScheduleType ¶

func PossibleValuesForScheduleType() []string

PossibleValuesForScheduleType returns every value of ScheduleType.

func PossibleValuesForSecretProviderType ¶

func PossibleValuesForSecretProviderType() []string

PossibleValuesForSecretProviderType returns every value of SecretProviderType.

func PossibleValuesForSeverity ¶

func PossibleValuesForSeverity() []string

PossibleValuesForSeverity returns every value of Severity.

func PossibleValuesForSignInType ¶

func PossibleValuesForSignInType() []string

PossibleValuesForSignInType returns every value of SignInType.

func PossibleValuesForStackSourceType ¶

func PossibleValuesForStackSourceType() []string

PossibleValuesForStackSourceType returns every value of StackSourceType.

func PossibleValuesForStackStatus ¶

func PossibleValuesForStackStatus() []string

PossibleValuesForStackStatus returns every value of StackStatus.

func PossibleValuesForTemplateType ¶

func PossibleValuesForTemplateType() []string

PossibleValuesForTemplateType returns every value of TemplateType.

Types ¶

type BackupConfigID ¶ added in v0.2.0

type BackupConfigID int

BackupConfigID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and BackupConfigID(n) convert one value, client.IDs a list.

type BackupDestinationFlags ¶ added in v0.2.0

type BackupDestinationFlags struct {
	Backup, Restore bool
}

BackupDestinationFlags names which of the flags a backup destination gives restic are to be forgotten: the ones for a backup, and the ones for a restore.

type BackupDestinationID ¶ added in v0.2.0

type BackupDestinationID int

BackupDestinationID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and BackupDestinationID(n) convert one value, client.IDs a list.

type ChangeType ¶

type ChangeType string

ChangeType is the "ChangeType" enum.

const (
	ChangeTypeFeature ChangeType = "feature"
	ChangeTypeFix     ChangeType = "fix"
)

Values of ChangeType.

func (ChangeType) Known ¶

func (v ChangeType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type CheckSeverity ¶

type CheckSeverity string

CheckSeverity is the "CheckSeverity" enum.

const (
	CheckSeverityError CheckSeverity = "error"
	CheckSeverityWarn  CheckSeverity = "warn"
	CheckSeverityInfo  CheckSeverity = "info"
)

Values of CheckSeverity.

func (CheckSeverity) Known ¶

func (v CheckSeverity) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type Client ¶

type Client struct {
	Client *client.Client
}

Client is a client for Dockhand API; each of its operations is a method. Requests go through Client.Client, the shared base client.

func Connect ¶

func Connect(baseURL, token string, opts ...client.Option) (*Client, error)

Connect returns a client for a Dockhand as it is run: one that sends the API token it is given, or nothing for a Dockhand whose login is switched off and so has no token to give.

func New ¶

func New(baseURL, token string, opts ...client.Option) (*Client, error)

New returns a client for Dockhand API at baseURL (scheme and host, optionally a path prefix) that authenticates with token. The options are the base client's: a logger to trace to, a transport of the caller's own.

func NewWithoutLogin ¶

func NewWithoutLogin(baseURL string, opts ...client.Option) (*Client, error)

NewWithoutLogin returns a client that sends no credentials: for a Dockhand run with its login switched off, and, made with client.WithCookies, for logging in to one that has it on, which is how a token is first come by. New, which is generated, wants a token.

func (Client) DeleteActivity ¶

func (c Client) DeleteActivity(ctx context.Context) (result DeleteActivityResponse, err error)

DeleteActivity calls DELETE /api/activity. Clear all stored container activity events.

func (Client) DeleteAuthLdapById ¶

func (c Client) DeleteAuthLdapById(ctx context.Context, id int) (result DeleteAuthLdapByIdResponse, err error)

DeleteAuthLdapById calls DELETE /api/auth/ldap/{id}. Delete an LDAP provider configuration by id (enterprise only).

func (Client) DeleteAuthOidcById ¶

func (c Client) DeleteAuthOidcById(ctx context.Context, id int) (result DeleteAuthOidcByIdResponse, err error)

DeleteAuthOidcById calls DELETE /api/auth/oidc/{id}. Delete an OIDC provider configuration by id.

func (Client) DeleteAuthTokensById ¶

func (c Client) DeleteAuthTokensById(ctx context.Context, id int) (result DeleteAuthTokensByIdResponse, err error)

DeleteAuthTokensById calls DELETE /api/auth/tokens/{id}. Revoke (permanently delete) one of the authenticated user's API tokens.

func (Client) DeleteAutoUpdateByContainerName ¶

func (c Client) DeleteAutoUpdateByContainerName(ctx context.Context, containerName string, options ...DeleteAutoUpdateByContainerNameOptions) (result DeleteAutoUpdateByContainerNameResponse, err error)

DeleteAutoUpdateByContainerName calls DELETE /api/auto-update/{containerName}. Delete a container's auto-update setting and unregister its schedule.

func (Client) DeleteBackupConfigsById ¶

func (c Client) DeleteBackupConfigsById(ctx context.Context, id BackupConfigID, options ...DeleteBackupConfigsByIdOptions) (result DeleteBackupConfigsByIdResponse, err error)

DeleteBackupConfigsById calls DELETE /api/backup/configs/{id}. Delete a backup configuration and unregister its schedule, optionally forgetting its snapshots too.

func (Client) DeleteBackupDestinationsById ¶

func (c Client) DeleteBackupDestinationsById(ctx context.Context, id BackupDestinationID) (result DeleteBackupDestinationsByIdResponse, err error)

DeleteBackupDestinationsById calls DELETE /api/backup/destinations/{id}. Delete a backup destination and unregister all its maintenance and dependent backup-config schedules.

func (Client) DeleteBackupSnapshotsById ¶

func (c Client) DeleteBackupSnapshotsById(ctx context.Context, id string, options DeleteBackupSnapshotsByIdOptions) (result DeleteBackupSnapshotsByIdResponse, err error)

DeleteBackupSnapshotsById calls DELETE /api/backup/snapshots/{id}. Forget and prune a single snapshot from a destination (destructive restic forget --prune), with a server-authoritative environment access gate.

func (Client) DeleteConfigSetsById ¶

func (c Client) DeleteConfigSetsById(ctx context.Context, id ConfigSetID) (result DeleteConfigSetsByIdResponse, err error)

DeleteConfigSetsById calls DELETE /api/config-sets/{id}. Delete a config set by ID.

func (Client) DeleteContainerIconsByName ¶

func (c Client) DeleteContainerIconsByName(ctx context.Context, name string, options ...DeleteContainerIconsByNameOptions) (result DeleteContainerIconsByNameResponse, err error)

DeleteContainerIconsByName calls DELETE /api/container-icons/{name}. Remove a container's icon override (fall back to automatic matching).

func (Client) DeleteContainersById ¶

func (c Client) DeleteContainersById(ctx context.Context, id string, options DeleteContainersByIdOptions) (result DeleteContainersByIdResponse, err error)

DeleteContainersById calls DELETE /api/containers/{id}. Remove a container and clean up its auto-update schedule and pending-update record.

func (Client) DeleteContainersByIdFilesDelete ¶

func (c Client) DeleteContainersByIdFilesDelete(ctx context.Context, id string, options DeleteContainersByIdFilesDeleteOptions) (result DeleteContainersByIdFilesDeleteResponse, err error)

DeleteContainersByIdFilesDelete calls DELETE /api/containers/{id}/files/delete. Delete a file or directory inside a container (requires the 'exec' permission).

func (Client) DeleteContainersPendingUpdates ¶

func (c Client) DeleteContainersPendingUpdates(ctx context.Context, options DeleteContainersPendingUpdatesOptions) (result DeleteContainersPendingUpdatesResponse, err error)

DeleteContainersPendingUpdates calls DELETE /api/containers/pending-updates. Clear pending-update records for an environment, or for a single container when containerId is given.

func (Client) DeleteEnvironmentsById ¶

func (c Client) DeleteEnvironmentsById(ctx context.Context, id EnvironmentID) (result DeleteEnvironmentsByIdResponse, err error)

DeleteEnvironmentsById calls DELETE /api/environments/{id}. Delete an environment and all its associated git stacks, schedules, icons, and on-disk directories.

func (Client) DeleteEnvironmentsByIdIcon ¶

func (c Client) DeleteEnvironmentsByIdIcon(ctx context.Context, id EnvironmentID) (result DeleteEnvironmentsByIdIconResponse, err error)

DeleteEnvironmentsByIdIcon calls DELETE /api/environments/{id}/icon. Remove an environment's custom icon and reset it to the default "globe" icon.

func (Client) DeleteEnvironmentsByIdNotificationsByNotificationId ¶

func (c Client) DeleteEnvironmentsByIdNotificationsByNotificationId(ctx context.Context, id EnvironmentID, notificationId NotificationID) (result DeleteEnvironmentsByIdNotificationsByNotificationIdResponse, err error)

DeleteEnvironmentsByIdNotificationsByNotificationId calls DELETE /api/environments/{id}/notifications/{notificationId}. Remove a notification-channel link from an environment.

func (Client) DeleteGitCredentialsById ¶

func (c Client) DeleteGitCredentialsById(ctx context.Context, id GitCredentialID) (result DeleteGitCredentialsByIdResponse, err error)

DeleteGitCredentialsById calls DELETE /api/git/credentials/{id}. Delete a git credential by ID.

func (Client) DeleteGitRepositoriesById ¶

func (c Client) DeleteGitRepositoriesById(ctx context.Context, id GitRepositoryID) (result DeleteGitRepositoriesByIdResponse, err error)

DeleteGitRepositoriesById calls DELETE /api/git/repositories/{id}. Delete a git repository, first removing the clone directories of every git stack it backs.

func (Client) DeleteGitStacksById ¶

func (c Client) DeleteGitStacksById(ctx context.Context, id GitStackID) (result DeleteGitStacksByIdResponse, err error)

DeleteGitStacksById calls DELETE /api/git/stacks/{id}. Delete a git stack (removes its deploy files and stack source).

func (Client) DeleteHawserTokens ¶

func (c Client) DeleteHawserTokens(ctx context.Context, options DeleteHawserTokensOptions) (result DeleteHawserTokensResponse, err error)

DeleteHawserTokens calls DELETE /api/hawser/tokens. Revoke a Hawser agent token by ID.

func (Client) DeleteImagesById ¶

func (c Client) DeleteImagesById(ctx context.Context, id string, options ...DeleteImagesByIdOptions) (result DeleteImagesByIdResponse, err error)

DeleteImagesById calls DELETE /api/images/{id}. Remove a Docker image by ID or name (optionally forced), scoped to an environment.

func (Client) DeleteJobsById ¶

func (c Client) DeleteJobsById(ctx context.Context, id string) (result DeleteJobsByIdResponse, err error)

DeleteJobsById calls DELETE /api/jobs/{id}. Request cancellation of a running background job (owner or admin only).

func (Client) DeleteLicense ¶

func (c Client) DeleteLicense(ctx context.Context) (result DeleteLicenseResponse, err error)

DeleteLicense calls DELETE /api/license. Deactivate the currently active license.

func (Client) DeleteNetworksById ¶

func (c Client) DeleteNetworksById(ctx context.Context, id string, options ...DeleteNetworksByIdOptions) (result DeleteNetworksByIdResponse, err error)

DeleteNetworksById calls DELETE /api/networks/{id}. Remove a Docker network by ID (a malformed ID is rejected with 400 by input validation).

func (Client) DeleteNotificationsById ¶

func (c Client) DeleteNotificationsById(ctx context.Context, id NotificationID) (result DeleteNotificationsByIdResponse, err error)

DeleteNotificationsById calls DELETE /api/notifications/{id}. Delete a notification setting by ID.

func (Client) DeletePreferencesEnvironmentOrder ¶

func (c Client) DeletePreferencesEnvironmentOrder(ctx context.Context) (result DeletePreferencesEnvironmentOrderResponse, err error)

DeletePreferencesEnvironmentOrder calls DELETE /api/preferences/environment-order. Reset the environment order back to the default (by name).

func (Client) DeletePreferencesGrid ¶

func (c Client) DeletePreferencesGrid(ctx context.Context, options ...DeletePreferencesGridOptions) (result DeletePreferencesGridResponse, err error)

DeletePreferencesGrid calls DELETE /api/preferences/grid. Reset grid preferences — a single grid when gridId is given, otherwise all grids.

func (Client) DeletePreferencesSidebar ¶

func (c Client) DeletePreferencesSidebar(ctx context.Context) (result DeletePreferencesSidebarResponse, err error)

DeletePreferencesSidebar calls DELETE /api/preferences/sidebar. Reset the sidebar menu preferences to their default order/visibility.

func (Client) DeletePreferencesTagOrder ¶

func (c Client) DeletePreferencesTagOrder(ctx context.Context) (result DeletePreferencesTagOrderResponse, err error)

DeletePreferencesTagOrder calls DELETE /api/preferences/tag-order. Reset the tag order back to the default (by name).

func (Client) DeleteProfileAvatar ¶

func (c Client) DeleteProfileAvatar(ctx context.Context) (result DeleteProfileAvatarResponse, err error)

DeleteProfileAvatar calls DELETE /api/profile/avatar. Remove the authenticated user's avatar.

func (Client) DeleteRegistriesById ¶

func (c Client) DeleteRegistriesById(ctx context.Context, id RegistryID) (result DeleteRegistriesByIdResponse, err error)

DeleteRegistriesById calls DELETE /api/registries/{id}. Delete a registry by ID.

func (Client) DeleteRegistryImage ¶

func (c Client) DeleteRegistryImage(ctx context.Context, options DeleteRegistryImageOptions) (result DeleteRegistryImageResponse, err error)

DeleteRegistryImage calls DELETE /api/registry/image. Delete a tagged image from a registry by resolving its manifest digest, then deleting by digest.

func (Client) DeleteRolesById ¶

func (c Client) DeleteRolesById(ctx context.Context, id RoleID) (result DeleteRolesByIdResponse, err error)

DeleteRolesById calls DELETE /api/roles/{id}. Delete a custom role by id (system roles cannot be deleted; enterprise, admin required when auth is enabled).

func (Client) DeleteSchedulesByTypeById ¶

func (c Client) DeleteSchedulesByTypeById(ctx context.Context, typeParam string, id int) (result DeleteSchedulesByTypeByIdResponse, err error)

DeleteSchedulesByTypeById calls DELETE /api/schedules/{type}/{id}. Delete (or disable, for policy-driven types) a schedule by type and id.

func (Client) DeleteSchedulesExecutionsById ¶

func (c Client) DeleteSchedulesExecutionsById(ctx context.Context, id int) (result DeleteSchedulesExecutionsByIdResponse, err error)

DeleteSchedulesExecutionsById calls DELETE /api/schedules/executions/{id}. Delete a single schedule execution record.

func (Client) DeleteSecretProvidersById ¶

func (c Client) DeleteSecretProvidersById(ctx context.Context, id SecretProviderID) (result DeleteSecretProvidersByIdResponse, err error)

DeleteSecretProvidersById calls DELETE /api/secret-providers/{id}. Delete a secret provider.

func (Client) DeleteSettingsScanner ¶

func (c Client) DeleteSettingsScanner(ctx context.Context, options ...DeleteSettingsScannerOptions) (result DeleteSettingsScannerResponse, err error)

DeleteSettingsScanner calls DELETE /api/settings/scanner. Remove the scanner images (grype/trivy) and clean up scanner database volumes for an environment.

func (Client) DeleteSettingsScannerCache ¶

func (c Client) DeleteSettingsScannerCache(ctx context.Context) (result DeleteSettingsScannerCacheResponse, err error)

DeleteSettingsScannerCache calls DELETE /api/settings/scanner/cache. Clear the vulnerability-scanner cache (local volumes/bind-mount dirs plus each remote environment's scanner volume).

func (Client) DeleteStacksByName ¶

func (c Client) DeleteStacksByName(ctx context.Context, name string, options ...DeleteStacksByNameOptions) (result DeleteStacksByNameResponse, err error)

DeleteStacksByName calls DELETE /api/stacks/{name}. Remove a stack completely (compose down + delete files + database cleanup).

func (Client) DeleteStacksByNameDeploysByRunId ¶

func (c Client) DeleteStacksByNameDeploysByRunId(ctx context.Context, name string, runId int) (result DeleteStacksByNameDeploysByRunIdResponse, err error)

DeleteStacksByNameDeploysByRunId calls DELETE /api/stacks/{name}/deploys/{runId}. Delete a deploy run's database record and its on-disk log file.

func (Client) DeleteStacksByNameIcon ¶

func (c Client) DeleteStacksByNameIcon(ctx context.Context, name string, options ...DeleteStacksByNameIconOptions) (result DeleteStacksByNameIconResponse, err error)

DeleteStacksByNameIcon calls DELETE /api/stacks/{name}/icon. Remove a stack's custom icon.

func (Client) DeleteTagsById ¶

func (c Client) DeleteTagsById(ctx context.Context, id TagID) (result DeleteTagsByIdResponse, err error)

DeleteTagsById calls DELETE /api/tags/{id}. Delete a catalog tag (removes it from every container and stack).

func (Client) DeleteTemplatesSources ¶

func (c Client) DeleteTemplatesSources(ctx context.Context, options DeleteTemplatesSourcesOptions) (result DeleteTemplatesSourcesResponse, err error)

DeleteTemplatesSources calls DELETE /api/templates/sources. Delete a custom template source by ID.

func (Client) DeleteUsersById ¶

func (c Client) DeleteUsersById(ctx context.Context, id UserID, options ...DeleteUsersByIdOptions) (result DeleteUsersByIdResponse, err error)

DeleteUsersById calls DELETE /api/users/{id}. Delete a user by id; deleting the last admin while auth is enabled disables authentication and requires confirmDisableAuth.

func (Client) DeleteUsersByIdMfa ¶

func (c Client) DeleteUsersByIdMfa(ctx context.Context, id UserID) (result DeleteUsersByIdMfaResponse, err error)

DeleteUsersByIdMfa calls DELETE /api/users/{id}/mfa. Disable MFA for a user.

func (Client) DeleteUsersByIdRoles ¶

func (c Client) DeleteUsersByIdRoles(ctx context.Context, id UserID, input DeleteUsersByIdRolesRequest) (result DeleteUsersByIdRolesResponse, err error)

DeleteUsersByIdRoles calls DELETE /api/users/{id}/roles. Remove a role assignment from a user, optionally scoped to an environment (enterprise, admin only).

func (Client) DeleteVolumesByName ¶

func (c Client) DeleteVolumesByName(ctx context.Context, name string, options ...DeleteVolumesByNameOptions) (result DeleteVolumesByNameResponse, err error)

DeleteVolumesByName calls DELETE /api/volumes/{name}. Remove a Docker volume by name, optionally forcing removal.

func (Client) ForgetBackupConfigSchedule ¶ added in v0.2.0

func (c Client) ForgetBackupConfigSchedule(ctx context.Context, id BackupConfigID, keep *PutBackupConfigsByIdRequestRetention) (result PutBackupConfigsByIdResponse, err error)

ForgetBackupConfigSchedule has a backup configuration run only when it is asked to, and says what it keeps from then on. PutBackupConfigsById cannot: it leaves an empty schedule out of what it sends, and Dockhand keeps the one it is not sent. What to keep is always sent beside it, since Dockhand left to itself drops it when a schedule goes and keeps it when there was none to go: nil keeps every snapshot, which only a configuration with no schedule can.

func (Client) ForgetBackupDestinationFlags ¶ added in v0.2.0

func (c Client) ForgetBackupDestinationFlags(ctx context.Context, id BackupDestinationID, which BackupDestinationFlags) (result PutBackupDestinationsByIdResponse, err error)

ForgetBackupDestinationFlags takes the flags named away from a backup destination, which then gives restic none of them. PutBackupDestinationsById cannot: it leaves an empty value out of what it sends, and Dockhand keeps what it is not sent.

func (Client) ForgetConfigSetDescription ¶

func (c Client) ForgetConfigSetDescription(ctx context.Context, id int) (result PutConfigSetsByIdResponse, err error)

ForgetConfigSetDescription has Dockhand forget the description a config set was given. PutConfigSetsById cannot: it leaves an empty text out of what it sends, and Dockhand keeps what it is not sent.

func (Client) ForgetEnvironmentPublicIP ¶

func (c Client) ForgetEnvironmentPublicIP(ctx context.Context, id int) (result PutEnvironmentsByIdResponse, err error)

ForgetEnvironmentPublicIP has Dockhand forget the address an environment's published ports are reached at from outside. PutEnvironmentsById cannot: it leaves an empty publicIp out of what it sends, as it does every text it is not given, and Dockhand keeps what it is not sent.

func (Client) ForgetGitRepositoryCredential ¶

func (c Client) ForgetGitRepositoryCredential(ctx context.Context, id int) (result PutGitRepositoriesByIdResponse, err error)

ForgetGitRepositoryCredential has a git repository fetched with no credential from then on. PutGitRepositoriesById cannot: it leaves a credential of 0 out of what it sends, and Dockhand keeps the one it is not sent.

func (Client) ForgetGitStackSettings ¶

func (c Client) ForgetGitStackSettings(ctx context.Context, id int, which GitStackSettings) (result PutGitStacksByIdResponse, err error)

ForgetGitStackSettings takes the settings named away from a git stack, which then follows its repository's own branch, reads no extra .env file, and so on. PutGitStacksById cannot: it leaves an empty value out of what it sends, and Dockhand keeps what it is not sent. The webhook is switched off with its secret, since Dockhand refuses to forget the secret of one that is on.

func (Client) ForgetNavigationPages ¶

func (c Client) ForgetNavigationPages(ctx context.Context, landing, envClick bool) (result PutSettingsNavigationResponse, err error)

ForgetNavigationPages has Dockhand forget the page it opens on, the page a click on an environment opens, or both, for everyone who chose none of their own. PutSettingsNavigation cannot: it leaves an empty text out of what it sends, and Dockhand keeps what it is not sent.

func (Client) ForgetOidcAdminClaim ¶

func (c Client) ForgetOidcAdminClaim(ctx context.Context, id int) (result PutAuthOidcByIdResponse, err error)

ForgetOidcAdminClaim has Dockhand forget the claim, and the value of it, that a single sign-on provider's record names for an administrator. PutAuthOidcById cannot: it leaves an empty text out of what it sends, and Dockhand keeps what it is not sent.

func (Client) ForgetRegistryCredentials ¶

func (c Client) ForgetRegistryCredentials(ctx context.Context, id int, name, address string) (result PutRegistriesByIdResponse, err error)

ForgetRegistryCredentials has Dockhand forget the user name and password it signs in to a registry with. PutRegistriesById cannot: it leaves an empty name and password out of what it sends, and Dockhand keeps what it is not sent. The registry's name and address go with it, since Dockhand fails a change that does not carry the address.

func (Client) ForgetStackSecretProvider ¶

func (c Client) ForgetStackSecretProvider(ctx context.Context, name, content string, env int) (result PutStacksByNameComposeResponse, err error)

ForgetStackSecretProvider saves a stack's compose file and takes the stack off the secret provider its secrets were loaded from. PutStacksByNameCompose cannot: it leaves a provider of 0 out of what it sends, and Dockhand keeps the provider it is not sent.

func (Client) ForgetTagIcon ¶

func (c Client) ForgetTagIcon(ctx context.Context, id int) (result PutTagsByIdResponse, err error)

ForgetTagIcon has Dockhand forget the icon a tag was given. PutTagsById cannot: it leaves an empty text out of what it sends, and Dockhand keeps what it is not sent.

func (Client) ForgetUserDetails ¶

func (c Client) ForgetUserDetails(ctx context.Context, id int, email, displayName bool) (result PutUsersByIdResponse, err error)

ForgetUserDetails has Dockhand forget a user's email address, the name it shows for the user, or both. PutUsersById cannot: it leaves an empty text out of what it sends, and Dockhand keeps what it is not sent.

func (Client) GetActivity ¶

func (c Client) GetActivity(ctx context.Context, options ...GetActivityOptions) (result GetActivityResponse, err error)

GetActivity calls GET /api/activity. Query container activity events with filters and pagination.

func (Client) GetActivityContainers ¶

func (c Client) GetActivityContainers(ctx context.Context, options ...GetActivityContainersOptions) (result GetActivityContainersResponse, err error)

GetActivityContainers calls GET /api/activity/containers. List distinct container names that appear in the activity log, for filter dropdowns.

func (Client) GetActivityEvents ¶

func (c Client) GetActivityEvents(ctx context.Context) (result GetActivityEventsResponse, err error)

GetActivityEvents calls GET /api/activity/events. Stream live container activity and environment-status events over Server-Sent Events.

func (Client) GetActivityStats ¶

func (c Client) GetActivityStats(ctx context.Context, options ...GetActivityStatsOptions) (result GetActivityStatsResponse, err error)

GetActivityStats calls GET /api/activity/stats. Get aggregate container activity statistics (totals and counts by action).

func (Client) GetAudit ¶

func (c Client) GetAudit(ctx context.Context, options ...GetAuditOptions) (result GetAuditResponse, err error)

GetAudit calls GET /api/audit. Query the audit log with filters and pagination (Enterprise only).

func (Client) GetAuditEvents ¶

func (c Client) GetAuditEvents(ctx context.Context) (result GetAuditEventsResponse, err error)

GetAuditEvents calls GET /api/audit/events. Stream live audit-log events over Server-Sent Events (Enterprise only).

func (Client) GetAuditExport ¶

func (c Client) GetAuditExport(ctx context.Context, options ...GetAuditExportOptions) (result GetAuditExportResponse, err error)

GetAuditExport calls GET /api/audit/export. Export the audit log as a downloadable file in JSON, CSV or Markdown (Enterprise only).

func (Client) GetAuditOutsideApi ¶

func (c Client) GetAuditOutsideApi(ctx context.Context, options ...GetAuditOutsideApiOptions) (result GetAuditOutsideApiResponse, err error)

GetAuditOutsideApi calls GET /audit. List audit log entries with optional filters (Enterprise only).

func (Client) GetAuditUsers ¶

func (c Client) GetAuditUsers(ctx context.Context) (result GetAuditUsersResponse, err error)

GetAuditUsers calls GET /api/audit/users. List the distinct usernames that appear in the audit log, for filter dropdowns (Enterprise only).

func (Client) GetAuditUsersOutsideApi ¶

func (c Client) GetAuditUsersOutsideApi(ctx context.Context) (result GetAuditUsersOutsideApiResponse, err error)

GetAuditUsersOutsideApi calls GET /audit/users. List distinct usernames that appear in the audit log, for use as a filter dropdown (Enterprise only).

func (Client) GetAuthLdap ¶

func (c Client) GetAuthLdap(ctx context.Context) (result GetAuthLdapResponse, err error)

GetAuthLdap calls GET /api/auth/ldap. List all configured LDAP providers (enterprise only; bind passwords are masked).

func (Client) GetAuthLdapById ¶

func (c Client) GetAuthLdapById(ctx context.Context, id int) (result GetAuthLdapByIdResponse, err error)

GetAuthLdapById calls GET /api/auth/ldap/{id}. Get a single LDAP provider configuration by id (enterprise only; bind password is masked).

func (Client) GetAuthOidc ¶

func (c Client) GetAuthOidc(ctx context.Context) (result GetAuthOidcResponse, err error)

GetAuthOidc calls GET /api/auth/oidc. List all configured OIDC providers (client secrets are masked).

func (Client) GetAuthOidcById ¶

func (c Client) GetAuthOidcById(ctx context.Context, id int) (result GetAuthOidcByIdResponse, err error)

GetAuthOidcById calls GET /api/auth/oidc/{id}. Get a single OIDC provider configuration by id (client secret is masked).

func (Client) GetAuthOidcByIdInitiate ¶

func (c Client) GetAuthOidcByIdInitiate(ctx context.Context, id int, options ...GetAuthOidcByIdInitiateOptions) (result GetAuthOidcByIdInitiateResponse, err error)

GetAuthOidcByIdInitiate calls GET /api/auth/oidc/{id}/initiate. Start the OIDC login flow for a provider — on success throws a 302 redirect to the IdP authorization URL.

func (Client) GetAuthOidcCallback ¶

func (c Client) GetAuthOidcCallback(ctx context.Context, options ...GetAuthOidcCallbackOptions) (result GetAuthOidcCallbackResponse, err error)

GetAuthOidcCallback calls GET /api/auth/oidc/callback. Handle the OIDC redirect callback from the IdP — always responds with a 302 redirect (to the original destination on success, or to /login with an error query param on failure).

func (Client) GetAuthProviders ¶

func (c Client) GetAuthProviders(ctx context.Context) (result GetAuthProvidersResponse, err error)

GetAuthProviders calls GET /api/auth/providers. List the authentication providers offered on the login page (local, LDAP, OIDC), plus the default provider.

func (Client) GetAuthSession ¶

func (c Client) GetAuthSession(ctx context.Context) (result GetAuthSessionResponse, err error)

GetAuthSession calls GET /api/auth/session. Get the current session (public — used by the frontend to bootstrap auth state).

func (Client) GetAuthSettings ¶

func (c Client) GetAuthSettings(ctx context.Context) (result GetAuthSettingsResponse, err error)

GetAuthSettings calls GET /api/auth/settings. Get the global authentication settings (whether auth is enabled and the default provider).

func (Client) GetAuthTokens ¶

func (c Client) GetAuthTokens(ctx context.Context) (result GetAuthTokensResponse, err error)

GetAuthTokens calls GET /api/auth/tokens. List the authenticated user's API tokens (never returns the hash/secret).

func (Client) GetAutoUpdate ¶

func (c Client) GetAutoUpdate(ctx context.Context, options ...GetAutoUpdateOptions) (result GetAutoUpdateResponse, err error)

GetAutoUpdate calls GET /api/auto-update. Get all enabled auto-update settings for an environment, keyed by container name.

func (Client) GetAutoUpdateByContainerName ¶

func (c Client) GetAutoUpdateByContainerName(ctx context.Context, containerName string, options ...GetAutoUpdateByContainerNameOptions) (result GetAutoUpdateByContainerNameResponse, err error)

GetAutoUpdateByContainerName calls GET /api/auto-update/{containerName}. Get the auto-update setting for a container (returns sensible defaults when none is stored).

func (Client) GetBackupConfigs ¶

func (c Client) GetBackupConfigs(ctx context.Context, options ...GetBackupConfigsOptions) (result GetBackupConfigsResponse, err error)

GetBackupConfigs calls GET /api/backup/configs. List backup configurations, optionally filtered by type, target and environment (enterprise callers only see configs for environments they can access).

func (Client) GetBackupConfigsById ¶

func (c Client) GetBackupConfigsById(ctx context.Context, id BackupConfigID) (result GetBackupConfigsByIdResponse, err error)

GetBackupConfigsById calls GET /api/backup/configs/{id}. Fetch a single backup configuration by id, enforcing environment-scoped access.

func (Client) GetBackupDestinations ¶

func (c Client) GetBackupDestinations(ctx context.Context) (result GetBackupDestinationsResponse, err error)

GetBackupDestinations calls GET /api/backup/destinations. List all backup destinations (restic repositories); the password is stripped and cloud-credential env vars are omitted from the list view.

func (Client) GetBackupDestinationsById ¶

func (c Client) GetBackupDestinationsById(ctx context.Context, id BackupDestinationID) (result GetBackupDestinationsByIdResponse, err error)

GetBackupDestinationsById calls GET /api/backup/destinations/{id}. Fetch a single backup destination; decrypted cloud-credential env vars are only included for callers who can manage backups, and the password is always stripped.

func (Client) GetBackupInstance ¶

func (c Client) GetBackupInstance(ctx context.Context) (result GetBackupInstanceResponse, err error)

GetBackupInstance calls GET /api/backup/instance. This install's stable backup instance id, used to tell own snapshots from foreign orphans.

func (Client) GetBackupSnapshots ¶

func (c Client) GetBackupSnapshots(ctx context.Context, options ...GetBackupSnapshotsOptions) (result GetBackupSnapshotsResponse, err error)

GetBackupSnapshots calls GET /api/backup/snapshots. List restic snapshots for a backup config or a single destination (job-polled).

func (Client) GetBackupSnapshotsByIdBrowse ¶

func (c Client) GetBackupSnapshotsByIdBrowse(ctx context.Context, id string, options ...GetBackupSnapshotsByIdBrowseOptions) (result GetBackupSnapshotsByIdBrowseResponse, err error)

GetBackupSnapshotsByIdBrowse calls GET /api/backup/snapshots/{id}/browse. List directory entries at a path inside a snapshot (job-polled).

func (Client) GetBackupSnapshotsByIdDump ¶

func (c Client) GetBackupSnapshotsByIdDump(ctx context.Context, id string, options ...GetBackupSnapshotsByIdDumpOptions) (result GetBackupSnapshotsByIdDumpResponse, err error)

GetBackupSnapshotsByIdDump calls GET /api/backup/snapshots/{id}/dump. Read a single file (or archive) out of a snapshot (job-polled restic dump).

func (Client) GetBackupSnapshotsByIdMetadata ¶

func (c Client) GetBackupSnapshotsByIdMetadata(ctx context.Context, id string, options ...GetBackupSnapshotsByIdMetadataOptions) (result GetBackupSnapshotsByIdMetadataResponse, err error)

GetBackupSnapshotsByIdMetadata calls GET /api/backup/snapshots/{id}/metadata. The snapshot's redacted metadata layout (job-polled restic dump).

func (Client) GetBackupSnapshotsDiff ¶

func (c Client) GetBackupSnapshotsDiff(ctx context.Context, options ...GetBackupSnapshotsDiffOptions) (result GetBackupSnapshotsDiffResponse, err error)

GetBackupSnapshotsDiff calls GET /api/backup/snapshots/diff. Diff two snapshots' file trees (added/changed/removed) - job-polled.

func (Client) GetBackupStackDirListing ¶

func (c Client) GetBackupStackDirListing(ctx context.Context, options GetBackupStackDirListingOptions) (result GetBackupStackDirListingResponse, err error)

GetBackupStackDirListing calls GET /api/backup/stack-dir-listing. Probe the target host and list the actual contents of a stack's directory, for the backup create/edit dialog's file picker.

func (Client) GetBackupStackPath ¶

func (c Client) GetBackupStackPath(ctx context.Context, options GetBackupStackPathOptions) (result GetBackupStackPathResponse, err error)

GetBackupStackPath calls GET /api/backup/stack-path. Preview where a stack's directory will be captured from on the host, without running a backup.

func (Client) GetChangelog ¶

func (c Client) GetChangelog(ctx context.Context) (result GetChangelogResponse, err error)

GetChangelog calls GET /api/changelog. Return the bundled Dockhand changelog data.

func (Client) GetConfigSets ¶

func (c Client) GetConfigSets(ctx context.Context) (result GetConfigSetsResponse, err error)

GetConfigSets calls GET /api/config-sets. List all config sets (reusable bundles of env vars, labels, ports, volumes, and runtime defaults).

func (Client) GetConfigSetsById ¶

func (c Client) GetConfigSetsById(ctx context.Context, id ConfigSetID) (result GetConfigSetsByIdResponse, err error)

GetConfigSetsById calls GET /api/config-sets/{id}. Fetch a single config set by its numeric ID.

func (Client) GetContainerIcons ¶

func (c Client) GetContainerIcons(ctx context.Context, options ...GetContainerIconsOptions) (result GetContainerIconsResponse, err error)

GetContainerIcons calls GET /api/container-icons. List all container icon overrides for an environment as a name -> icon map.

func (Client) GetContainerIconsByName ¶

func (c Client) GetContainerIconsByName(ctx context.Context, name string, options ...GetContainerIconsByNameOptions) (result GetContainerIconsByNameResponse, err error)

GetContainerIconsByName calls GET /api/container-icons/{name}. Get a container's uploaded custom icon (raw image/webp bytes, not JSON).

func (Client) GetContainerTags ¶

func (c Client) GetContainerTags(ctx context.Context, options ...GetContainerTagsOptions) (result GetContainerTagsResponse, err error)

GetContainerTags calls GET /api/container-tags. List all container tag assignments for an environment as a name -> tagIds map.

func (Client) GetContainerTagsByName ¶

func (c Client) GetContainerTagsByName(ctx context.Context, name string, options ...GetContainerTagsByNameOptions) (result GetContainerTagsByNameResponse, err error)

GetContainerTagsByName calls GET /api/container-tags/{name}. Get the tag ids assigned to one container (by name).

func (Client) GetContainers ¶

func (c Client) GetContainers(ctx context.Context, options ...GetContainersOptions) (result GetContainersResponse, err error)

GetContainers calls GET /api/containers. List containers for one environment (dockhand.hidden=true label is filtered out).

func (Client) GetContainersById ¶

func (c Client) GetContainersById(ctx context.Context, id string, options GetContainersByIdOptions) (result GetContainersByIdResponse, err error)

GetContainersById calls GET /api/containers/{id}. Return the full Docker inspect payload for a single container.

func (Client) GetContainersByIdCompose ¶

func (c Client) GetContainersByIdCompose(ctx context.Context, id string, options GetContainersByIdComposeOptions) (result GetContainersByIdComposeResponse, err error)

GetContainersByIdCompose calls GET /api/containers/{id}/compose. Generate a docker-compose service definition from a running container's inspect (requires the 'view' permission).

func (Client) GetContainersByIdFiles ¶

func (c Client) GetContainersByIdFiles(ctx context.Context, id string, options GetContainersByIdFilesOptions) (result GetContainersByIdFilesResponse, err error)

GetContainersByIdFiles calls GET /api/containers/{id}/files. List the contents of a directory inside a container's filesystem.

func (Client) GetContainersByIdFilesContent ¶

func (c Client) GetContainersByIdFilesContent(ctx context.Context, id string, options GetContainersByIdFilesContentOptions) (result GetContainersByIdFilesContentResponse, err error)

GetContainersByIdFilesContent calls GET /api/containers/{id}/files/content. Read the content of a single file inside a container (max 1 MB).

func (Client) GetContainersByIdFilesDownload ¶

func (c Client) GetContainersByIdFilesDownload(ctx context.Context, id string, options GetContainersByIdFilesDownloadOptions) (result GetContainersByIdFilesDownloadResponse, err error)

GetContainersByIdFilesDownload calls GET /api/containers/{id}/files/download. Download a file or directory from a container as a tar (optionally gzip-compressed) archive attachment.

func (Client) GetContainersByIdInspect ¶

func (c Client) GetContainersByIdInspect(ctx context.Context, id string, options GetContainersByIdInspectOptions) (result GetContainersByIdInspectResponse, err error)

GetContainersByIdInspect calls GET /api/containers/{id}/inspect. Return the full Docker inspect payload for a container (requires the 'inspect' permission).

func (Client) GetContainersByIdLogs ¶

func (c Client) GetContainersByIdLogs(ctx context.Context, id string, options GetContainersByIdLogsOptions) (result GetContainersByIdLogsResponse, err error)

GetContainersByIdLogs calls GET /api/containers/{id}/logs. Return the last N lines of a container's combined stdout/stderr logs as a single string.

func (Client) GetContainersByIdLogsStream ¶

func (c Client) GetContainersByIdLogsStream(ctx context.Context, id string, options GetContainersByIdLogsStreamOptions) (result GetContainersByIdLogsStreamResponse, err error)

GetContainersByIdLogsStream calls GET /api/containers/{id}/logs/stream. Stream a container's logs live as Server-Sent Events (connected/log/end/error events, with keepalive heartbeats).

func (Client) GetContainersByIdShells ¶

func (c Client) GetContainersByIdShells(ctx context.Context, id string, options GetContainersByIdShellsOptions) (result GetContainersByIdShellsResponse, err error)

GetContainersByIdShells calls GET /api/containers/{id}/shells. Probe a container for available shells (bash/sh/zsh/ash) and report the preferred default (requires the 'exec' permission).

func (Client) GetContainersByIdStats ¶

func (c Client) GetContainersByIdStats(ctx context.Context, id string, options GetContainersByIdStatsOptions) (result GetContainersByIdStatsResponse, err error)

GetContainersByIdStats calls GET /api/containers/{id}/stats. Return a one-shot CPU/memory/network/block-IO stats snapshot for a container (Docker-CLI-equivalent memory accounting).

func (Client) GetContainersByIdTop ¶

func (c Client) GetContainersByIdTop(ctx context.Context, id string, options GetContainersByIdTopOptions) (result GetContainersByIdTopResponse, err error)

GetContainersByIdTop calls GET /api/containers/{id}/top. List the processes running inside a container (via `ps` in the container, falling back to the Docker top API).

func (Client) GetContainersByIdVersionNotes ¶

func (c Client) GetContainersByIdVersionNotes(ctx context.Context, id string, options GetContainersByIdVersionNotesOptions) (result GetContainersByIdVersionNotesResponse, err error)

GetContainersByIdVersionNotes calls GET /api/containers/{id}/version-notes. Resolve GitHub release notes for the versions a semver update-check surfaced (requires the 'view' permission).

func (Client) GetContainersCheckUpdates ¶

func (c Client) GetContainersCheckUpdates(ctx context.Context, options GetContainersCheckUpdatesOptions) (result GetContainersCheckUpdatesResponse, err error)

GetContainersCheckUpdates calls GET /api/containers/check-updates. Read the cached pending image-update records for an environment (no fresh check; requires the 'view' permission).

func (Client) GetContainersPendingUpdates ¶

func (c Client) GetContainersPendingUpdates(ctx context.Context, options GetContainersPendingUpdatesOptions) (result GetContainersPendingUpdatesResponse, err error)

GetContainersPendingUpdates calls GET /api/containers/pending-updates. List the containers in an environment that have a pending image update recorded (requires the 'view' permission).

func (Client) GetContainersSizes ¶

func (c Client) GetContainersSizes(ctx context.Context, options GetContainersSizesOptions) (result GetContainersSizesResponse, err error)

GetContainersSizes calls GET /api/containers/sizes. List all containers in an environment together with their writable-layer and root-filesystem sizes (requires the 'view' permission).

func (Client) GetContainersStats ¶

func (c Client) GetContainersStats(ctx context.Context, options GetContainersStatsOptions) (result GetContainersStatsResponse, err error)

GetContainersStats calls GET /api/containers/stats. Return a CPU/memory/network/block-IO stats snapshot for every running container in an environment (requires the 'view' permission).

func (Client) GetContainersStatsStream ¶

func (c Client) GetContainersStatsStream(ctx context.Context, options ...GetContainersStatsStreamOptions) (result GetContainersStatsStreamResponse, err error)

GetContainersStatsStream calls GET /api/containers/stats/stream. Stream live CPU/memory/network/block-IO stats for all running containers in an environment (one snapshot round, then closes).

func (Client) GetDashboardPreferences ¶

func (c Client) GetDashboardPreferences(ctx context.Context) (result GetDashboardPreferencesResponse, err error)

GetDashboardPreferences calls GET /api/dashboard/preferences. Get the current user's dashboard preferences (grid layout, lock state, view mode).

func (Client) GetDashboardStats ¶

func (c Client) GetDashboardStats(ctx context.Context) (result GetDashboardStatsResponse, err error)

GetDashboardStats calls GET /api/dashboard/stats. Get aggregated dashboard statistics per environment (containers, images, volumes, stacks, metrics).

func (Client) GetDashboardStatsStream ¶

func (c Client) GetDashboardStatsStream(ctx context.Context) (result GetDashboardStatsStreamResponse, err error)

GetDashboardStatsStream calls GET /api/dashboard/stats/stream. Stream per-environment dashboard stats progressively over Server-Sent Events.

func (Client) GetDebugMemory ¶

func (c Client) GetDebugMemory(ctx context.Context, options ...GetDebugMemoryOptions) (result GetDebugMemoryResponse, err error)

GetDebugMemory calls GET /api/debug/memory. Return Node.js/V8 memory diagnostics; only enabled when MEMORY_MONITOR=true.

func (Client) GetDependencies ¶

func (c Client) GetDependencies(ctx context.Context) (result GetDependenciesResponse, err error)

GetDependencies calls GET /api/dependencies. Return the combined list of npm dependencies and external tool images (grype, trivy), sorted by name, excluding Dockhand itself.

func (Client) GetDocs ¶

func (c Client) GetDocs(ctx context.Context) (result GetDocsResponse, err error)

GetDocs calls GET /api/docs. The full OpenAPI 3.0 specification for the Dockhand REST API (unauthenticated).

func (Client) GetEnvironments ¶

func (c Client) GetEnvironments(ctx context.Context) (result GetEnvironmentsResponse, err error)

GetEnvironments calls GET /api/environments. List all Docker environments (hosts) known to Dockhand.

func (Client) GetEnvironmentsById ¶

func (c Client) GetEnvironmentsById(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdResponse, err error)

GetEnvironmentsById calls GET /api/environments/{id}. Get a single environment by id, including its parsed labels and public IP.

func (Client) GetEnvironmentsByIdDiskWarning ¶

func (c Client) GetEnvironmentsByIdDiskWarning(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdDiskWarningResponse, err error)

GetEnvironmentsByIdDiskWarning calls GET /api/environments/{id}/disk-warning. Get the disk-space warning thresholds for an environment.

func (Client) GetEnvironmentsByIdIcon ¶

func (c Client) GetEnvironmentsByIdIcon(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdIconResponse, err error)

GetEnvironmentsByIdIcon calls GET /api/environments/{id}/icon. Get the custom icon image for an environment (raw image/webp bytes, not JSON).

func (Client) GetEnvironmentsByIdImagePrune ¶

func (c Client) GetEnvironmentsByIdImagePrune(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdImagePruneResponse, err error)

GetEnvironmentsByIdImagePrune calls GET /api/environments/{id}/image-prune. Get the automatic image-prune schedule settings for an environment.

func (Client) GetEnvironmentsByIdNotifications ¶

func (c Client) GetEnvironmentsByIdNotifications(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdNotificationsResponse, err error)

GetEnvironmentsByIdNotifications calls GET /api/environments/{id}/notifications. List notification channel configurations attached to an environment.

func (Client) GetEnvironmentsByIdNotificationsByNotificationId ¶

func (c Client) GetEnvironmentsByIdNotificationsByNotificationId(ctx context.Context, id EnvironmentID, notificationId NotificationID) (result GetEnvironmentsByIdNotificationsByNotificationIdResponse, err error)

GetEnvironmentsByIdNotificationsByNotificationId calls GET /api/environments/{id}/notifications/{notificationId}. Get one notification-channel link for an environment.

func (Client) GetEnvironmentsByIdRemoteStacksDir ¶

func (c Client) GetEnvironmentsByIdRemoteStacksDir(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdRemoteStacksDirResponse, err error)

GetEnvironmentsByIdRemoteStacksDir calls GET /api/environments/{id}/remote-stacks-dir. Get the per-environment remote stacks directory used to stage stack files onto a direct (agentless) daemon.

func (Client) GetEnvironmentsByIdTimezone ¶

func (c Client) GetEnvironmentsByIdTimezone(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdTimezoneResponse, err error)

GetEnvironmentsByIdTimezone calls GET /api/environments/{id}/timezone. Get the IANA timezone used for scheduling on an environment.

func (Client) GetEnvironmentsByIdUpdateCheck ¶

func (c Client) GetEnvironmentsByIdUpdateCheck(ctx context.Context, id EnvironmentID) (result GetEnvironmentsByIdUpdateCheckResponse, err error)

GetEnvironmentsByIdUpdateCheck calls GET /api/environments/{id}/update-check. Get the automatic container-image update-check schedule for an environment.

func (Client) GetEnvironmentsDetectSocket ¶

func (c Client) GetEnvironmentsDetectSocket(ctx context.Context) (result GetEnvironmentsDetectSocketResponse, err error)

GetEnvironmentsDetectSocket calls GET /api/environments/detect-socket. Detect common Docker/Podman socket paths that exist on the Dockhand host.

func (Client) GetEvents ¶

func (c Client) GetEvents(ctx context.Context, options ...GetEventsOptions) (result GetEventsResponse, err error)

GetEvents calls GET /api/events. Stream live Docker events (container/image/volume/network) for an environment via SSE, with periodic heartbeats.

func (Client) GetGitCredentials ¶

func (c Client) GetGitCredentials(ctx context.Context) (result GetGitCredentialsResponse, err error)

GetGitCredentials calls GET /api/git/credentials. List all stored git credentials with secrets stripped (only hasPassword/hasSshKey flags returned).

func (Client) GetGitCredentialsById ¶

func (c Client) GetGitCredentialsById(ctx context.Context, id GitCredentialID) (result GetGitCredentialsByIdResponse, err error)

GetGitCredentialsById calls GET /api/git/credentials/{id}. Get a single git credential by ID with secrets stripped (only hasPassword/hasSshKey flags returned).

func (Client) GetGitRepositories ¶

func (c Client) GetGitRepositories(ctx context.Context) (result GetGitRepositoriesResponse, err error)

GetGitRepositories calls GET /api/git/repositories. List all git repositories (repositories are global, not scoped to an environment).

func (Client) GetGitRepositoriesById ¶

func (c Client) GetGitRepositoriesById(ctx context.Context, id GitRepositoryID) (result GetGitRepositoriesByIdResponse, err error)

GetGitRepositoriesById calls GET /api/git/repositories/{id}. Get a single git repository by ID.

func (Client) GetGitRepositoriesByIdSync ¶

func (c Client) GetGitRepositoriesByIdSync(ctx context.Context, id GitRepositoryID) (result GetGitRepositoriesByIdSyncResponse, err error)

GetGitRepositoriesByIdSync calls GET /api/git/repositories/{id}/sync. Check whether the tracked branch has new commits upstream without pulling them.

func (Client) GetGitStacks ¶

func (c Client) GetGitStacks(ctx context.Context, options ...GetGitStacksOptions) (result GetGitStacksResponse, err error)

GetGitStacks calls GET /api/git/stacks. List git-deployed stacks (optionally scoped to one environment).

func (Client) GetGitStacksById ¶

func (c Client) GetGitStacksById(ctx context.Context, id GitStackID) (result GetGitStacksByIdResponse, err error)

GetGitStacksById calls GET /api/git/stacks/{id}. Get one git stack.

func (Client) GetGitStacksByIdEnvFiles ¶

func (c Client) GetGitStacksByIdEnvFiles(ctx context.Context, id GitStackID) (result GetGitStacksByIdEnvFilesResponse, err error)

GetGitStacksByIdEnvFiles calls GET /api/git/stacks/{id}/env-files. List the .env files present in a git stack's cloned repository.

func (Client) GetGitStacksByIdWebhook ¶

func (c Client) GetGitStacksByIdWebhook(ctx context.Context, id GitStackID, options ...GetGitStacksByIdWebhookOptions) (result GetGitStacksByIdWebhookResponse, err error)

GetGitStacksByIdWebhook calls GET /api/git/stacks/{id}/webhook. GET webhook trigger for a git stack, with the secret passed as the `secret` query parameter.

func (Client) GetGitWebhookById ¶

func (c Client) GetGitWebhookById(ctx context.Context, id int, options ...GetGitWebhookByIdOptions) (result GetGitWebhookByIdResponse, err error)

GetGitWebhookById calls GET /api/git/webhook/{id}. GET webhook trigger for a git repository, with the secret passed as the `secret` query parameter.

func (Client) GetHawserConnect ¶

func (c Client) GetHawserConnect(ctx context.Context) (result GetHawserConnectResponse, err error)

GetHawserConnect calls GET /api/hawser/connect. Report the Hawser Edge WebSocket endpoint status and list currently connected agents.

func (Client) GetHawserTokens ¶

func (c Client) GetHawserTokens(ctx context.Context) (result GetHawserTokensResponse, err error)

GetHawserTokens calls GET /api/hawser/tokens. List all Hawser agent tokens (only the prefix is returned, never the full token).

func (Client) GetHealth ¶

func (c Client) GetHealth(ctx context.Context) (result GetHealthResponse, err error)

GetHealth calls GET /api/health. Liveness probe — always returns 200 when the SvelteKit process is up.

func (Client) GetHealthDatabase ¶

func (c Client) GetHealthDatabase(ctx context.Context) (result GetHealthDatabaseResponse, err error)

GetHealthDatabase calls GET /api/health/database. Public database health check reporting schema/migration/table status; authenticated settings:view callers also get connection details.

func (Client) GetHost ¶

func (c Client) GetHost(ctx context.Context, options ...GetHostOptions) (result GetHostResponse, err error)

GetHost calls GET /api/host. Return host info (hostname, IP, CPU, memory, uptime, Docker counts) for the daemon behind an environment.

func (Client) GetIconsSelfhstByRef ¶

func (c Client) GetIconsSelfhstByRef(ctx context.Context, ref string) (result GetIconsSelfhstByRefResponse, err error)

GetIconsSelfhstByRef calls GET /api/icons/selfhst/{ref}. Get a selfh.st app icon, fetched once from the CDN and cached on disk.

func (Client) GetIconsSelfhstManifest ¶

func (c Client) GetIconsSelfhstManifest(ctx context.Context) (result GetIconsSelfhstManifestResponse, err error)

GetIconsSelfhstManifest calls GET /api/icons/selfhst-manifest. Get the selfh.st icon manifest (index.json), cached on disk with a 7-day TTL.

func (Client) GetImages ¶

func (c Client) GetImages(ctx context.Context, options ...GetImagesOptions) (result GetImagesResponse, err error)

GetImages calls GET /api/images. List the Docker images of an environment (returns an empty array when no env is given or Docker is unreachable).

func (Client) GetImagesByIdExport ¶

func (c Client) GetImagesByIdExport(ctx context.Context, id string, options ...GetImagesByIdExportOptions) (result GetImagesByIdExportResponse, err error)

GetImagesByIdExport calls GET /api/images/{id}/export. Export a Docker image as a downloadable tar (or tar.gz) stream.

func (Client) GetImagesByIdHistory ¶

func (c Client) GetImagesByIdHistory(ctx context.Context, id string, options ...GetImagesByIdHistoryOptions) (result GetImagesByIdHistoryResponse, err error)

GetImagesByIdHistory calls GET /api/images/{id}/history. Return the layer build history of a Docker image.

func (Client) GetImagesScan ¶

func (c Client) GetImagesScan(ctx context.Context, options GetImagesScanOptions) (result GetImagesScanResponse, err error)

GetImagesScan calls GET /api/images/scan. Return the latest cached vulnerability scan for an image, resolving its tag to a SHA256 ID.

func (Client) GetImagesScanExport ¶

func (c Client) GetImagesScanExport(ctx context.Context, options GetImagesScanExportOptions) (result GetImagesScanExportResponse, err error)

GetImagesScanExport calls GET /api/images/scan/export. Export the cached vulnerability findings for a single image as json, csv, or sarif.

func (Client) GetJobsById ¶

func (c Client) GetJobsById(ctx context.Context, id string) (result GetJobsByIdResponse, err error)

GetJobsById calls GET /api/jobs/{id}. Poll a background job's status and accumulated output lines (owner or admin only).

func (Client) GetLabels ¶

func (c Client) GetLabels(ctx context.Context) (result GetLabelsResponse, err error)

GetLabels calls GET /api/labels. List all unique environment labels with their usage counts, the environments carrying each label, and any custom color.

func (Client) GetLegalLicense ¶

func (c Client) GetLegalLicense(ctx context.Context, options ...GetLegalLicenseOptions) (result GetLegalLicenseResponse, err error)

GetLegalLicense calls GET /api/legal/license. Return the bundled LICENSE.txt — as JSON by default, or as raw text/plain when format=text.

func (Client) GetLegalPrivacy ¶

func (c Client) GetLegalPrivacy(ctx context.Context, options ...GetLegalPrivacyOptions) (result GetLegalPrivacyResponse, err error)

GetLegalPrivacy calls GET /api/legal/privacy. Return the bundled PRIVACY.txt — as JSON by default, or as raw text/plain when format=text.

func (Client) GetLicense ¶

func (c Client) GetLicense(ctx context.Context) (result GetLicenseResponse, err error)

GetLicense calls GET /api/license. Get the current license status plus the server hostname the license is bound to.

func (Client) GetLogsMerged ¶

func (c Client) GetLogsMerged(ctx context.Context, options GetLogsMergedOptions) (result GetLogsMergedResponse, err error)

GetLogsMerged calls GET /api/logs/merged. Stream merged, color-tagged logs from multiple containers over Server-Sent Events.

func (Client) GetMetrics ¶

func (c Client) GetMetrics(ctx context.Context) (result GetMetricsResponse, err error)

GetMetrics calls GET /metrics. Prometheus metrics endpoint (disabled and 404s unless EXPORT_METRICS=true; public if app auth is disabled, otherwise requires a session or bearer token).

func (Client) GetNetworks ¶

func (c Client) GetNetworks(ctx context.Context, options ...GetNetworksOptions) (result GetNetworksResponse, err error)

GetNetworks calls GET /api/networks. List Docker networks for an environment (returns an empty array when no env is given).

func (Client) GetNetworksById ¶

func (c Client) GetNetworksById(ctx context.Context, id string, options ...GetNetworksByIdOptions) (result GetNetworksByIdResponse, err error)

GetNetworksById calls GET /api/networks/{id}. Inspect a Docker network by ID (a malformed ID is rejected with 400 by input validation).

func (Client) GetNetworksByIdInspect ¶

func (c Client) GetNetworksByIdInspect(ctx context.Context, id string, options ...GetNetworksByIdInspectOptions) (result GetNetworksByIdInspectResponse, err error)

GetNetworksByIdInspect calls GET /api/networks/{id}/inspect. Inspect a Docker network by ID (a malformed ID is rejected with 400 by input validation).

func (Client) GetNotifications ¶

func (c Client) GetNotifications(ctx context.Context) (result GetNotificationsResponse, err error)

GetNotifications calls GET /api/notifications. List all notification settings (SMTP and Apprise) with SMTP passwords masked.

func (Client) GetNotificationsById ¶

func (c Client) GetNotificationsById(ctx context.Context, id NotificationID) (result GetNotificationsByIdResponse, err error)

GetNotificationsById calls GET /api/notifications/{id}. Get a single notification setting by ID, with any SMTP password masked.

func (Client) GetNotificationsTriggerTest ¶

func (c Client) GetNotificationsTriggerTest(ctx context.Context) (result GetNotificationsTriggerTestResponse, err error)

GetNotificationsTriggerTest calls GET /api/notifications/trigger-test. List all available notification event types, grouped into categories.

func (Client) GetPreferencesEnvironmentOrder ¶

func (c Client) GetPreferencesEnvironmentOrder(ctx context.Context) (result GetPreferencesEnvironmentOrderResponse, err error)

GetPreferencesEnvironmentOrder calls GET /api/preferences/environment-order. Retrieve the saved environment order (environment ids, most preferred first).

func (Client) GetPreferencesFavoriteGroups ¶

func (c Client) GetPreferencesFavoriteGroups(ctx context.Context, options GetPreferencesFavoriteGroupsOptions) (result GetPreferencesFavoriteGroupsResponse, err error)

GetPreferencesFavoriteGroups calls GET /api/preferences/favorite-groups. Get the saved log favorite-groups for an environment.

func (Client) GetPreferencesFavorites ¶

func (c Client) GetPreferencesFavorites(ctx context.Context, options GetPreferencesFavoritesOptions) (result GetPreferencesFavoritesResponse, err error)

GetPreferencesFavorites calls GET /api/preferences/favorites. Get the saved log favorites (container names) for an environment.

func (Client) GetPreferencesGrid ¶

func (c Client) GetPreferencesGrid(ctx context.Context) (result GetPreferencesGridResponse, err error)

GetPreferencesGrid calls GET /api/preferences/grid. Retrieve all saved data-grid column preferences (per-user when auth is enabled).

func (Client) GetPreferencesSidebar ¶

func (c Client) GetPreferencesSidebar(ctx context.Context) (result GetPreferencesSidebarResponse, err error)

GetPreferencesSidebar calls GET /api/preferences/sidebar. Retrieve the saved sidebar menu preferences (order and hidden items).

func (Client) GetPreferencesTagOrder ¶

func (c Client) GetPreferencesTagOrder(ctx context.Context) (result GetPreferencesTagOrderResponse, err error)

GetPreferencesTagOrder calls GET /api/preferences/tag-order. Retrieve the saved tag order (tag ids, most preferred first).

func (Client) GetProfile ¶

func (c Client) GetProfile(ctx context.Context) (result GetProfileResponse, err error)

GetProfile calls GET /api/profile. Get the authenticated user's own profile.

func (Client) GetProfilePreferences ¶

func (c Client) GetProfilePreferences(ctx context.Context) (result GetProfilePreferencesResponse, err error)

GetProfilePreferences calls GET /api/profile/preferences. Get the current user's UI preferences (theme, fonts, editor options).

func (Client) GetRegistries ¶

func (c Client) GetRegistries(ctx context.Context) (result GetRegistriesResponse, err error)

GetRegistries calls GET /api/registries. List all configured container registries with passwords stripped (only a hasCredentials flag).

func (Client) GetRegistriesById ¶

func (c Client) GetRegistriesById(ctx context.Context, id RegistryID) (result GetRegistriesByIdResponse, err error)

GetRegistriesById calls GET /api/registries/{id}. Get a single registry by ID with the password stripped (only a hasCredentials flag).

func (Client) GetRegistryCatalog ¶

func (c Client) GetRegistryCatalog(ctx context.Context, options GetRegistryCatalogOptions) (result GetRegistryCatalogResponse, err error)

GetRegistryCatalog calls GET /api/registry/catalog. List repositories in a registry's V2 catalog (with Harbor project-API fallback), paginated.

func (Client) GetRegistrySearch ¶

func (c Client) GetRegistrySearch(ctx context.Context, options GetRegistrySearchOptions) (result GetRegistrySearchResponse, err error)

GetRegistrySearch calls GET /api/registry/search. Search for images by name in Docker Hub or a configured private registry (direct + catalog fallback).

func (Client) GetRegistryTagInfo ¶

func (c Client) GetRegistryTagInfo(ctx context.Context, options GetRegistryTagInfoOptions) (result GetRegistryTagInfoResponse, err error)

GetRegistryTagInfo calls GET /api/registry/tag-info. Resolve the compressed size and creation date of a single registry tag from its manifest (lazy per-tag fetch for the registry browser).

func (Client) GetRegistryTags ¶

func (c Client) GetRegistryTags(ctx context.Context, options GetRegistryTagsOptions) (result GetRegistryTagsResponse, err error)

GetRegistryTags calls GET /api/registry/tags. List the tags of an image from Docker Hub or a configured registry (paginated for Docker Hub).

func (Client) GetRoles ¶

func (c Client) GetRoles(ctx context.Context) (result GetRolesResponse, err error)

GetRoles calls GET /api/roles. List all roles (built-in and custom); needs admin or users:view, plus an enterprise license.

func (Client) GetRolesById ¶

func (c Client) GetRolesById(ctx context.Context, id RoleID) (result GetRolesByIdResponse, err error)

GetRolesById calls GET /api/roles/{id}. Get a single role by id; needs admin or users:view, plus an enterprise license.

func (Client) GetSchedules ¶

func (c Client) GetSchedules(ctx context.Context) (result GetSchedulesResponse, err error)

GetSchedules calls GET /api/schedules. List all schedules (container/env auto-updates, git syncs, image-prune, backups, repo maintenance, system jobs).

func (Client) GetSchedulesExecutions ¶

func (c Client) GetSchedulesExecutions(ctx context.Context, options ...GetSchedulesExecutionsOptions) (result GetSchedulesExecutionsResponse, err error)

GetSchedulesExecutions calls GET /api/schedules/executions. List schedule execution history, filterable and paginated.

func (Client) GetSchedulesExecutionsById ¶

func (c Client) GetSchedulesExecutionsById(ctx context.Context, id int) (result GetSchedulesExecutionsByIdResponse, err error)

GetSchedulesExecutionsById calls GET /api/schedules/executions/{id}. Get a single schedule execution, including its logs.

func (Client) GetSchedulesSettings ¶

func (c Client) GetSchedulesSettings(ctx context.Context) (result GetSchedulesSettingsResponse, err error)

GetSchedulesSettings calls GET /api/schedules/settings. Get the schedules-page display preference (hide system jobs), per-user with a global fallback.

func (Client) GetSchedulesStream ¶

func (c Client) GetSchedulesStream(ctx context.Context) (result GetSchedulesStreamResponse, err error)

GetSchedulesStream calls GET /api/schedules/stream. Server-Sent Events stream that polls and pushes schedule updates (same shape as GET /api/schedules).

func (Client) GetSecretProviders ¶

func (c Client) GetSecretProviders(ctx context.Context) (result GetSecretProvidersResponse, err error)

GetSecretProviders calls GET /api/secret-providers. List configured secret providers (summaries never include the decrypted config).

func (Client) GetSecretProvidersById ¶

func (c Client) GetSecretProvidersById(ctx context.Context, id SecretProviderID) (result GetSecretProvidersByIdResponse, err error)

GetSecretProvidersById calls GET /api/secret-providers/{id}. Get one secret provider with its non-secret config coordinates (the token is redacted out).

func (Client) GetSecretProvidersDefault ¶

func (c Client) GetSecretProvidersDefault(ctx context.Context) (result GetSecretProvidersDefaultResponse, err error)

GetSecretProvidersDefault calls GET /api/secret-providers/default. Get the global default secret provider preselected for new stacks.

func (Client) GetSelfUpdateCheck ¶

func (c Client) GetSelfUpdateCheck(ctx context.Context) (result GetSelfUpdateCheckResponse, err error)

GetSelfUpdateCheck calls GET /api/self-update/check. Check whether a newer Dockhand image is available (version-tag compare via GitHub changelog, or registry-digest compare for mutable tags like :latest).

func (Client) GetSelfUpdateProgress ¶

func (c Client) GetSelfUpdateProgress(ctx context.Context, options GetSelfUpdateProgressOptions) (result GetSelfUpdateProgressResponse, err error)

GetSelfUpdateProgress calls GET /api/self-update/progress. Poll the self-update sidecar container's logs and exit state for progress tracking.

func (Client) GetSettingsGeneral ¶

func (c Client) GetSettingsGeneral(ctx context.Context) (result GetSettingsGeneralResponse, err error)

GetSettingsGeneral calls GET /api/settings/general. Get global (instance-wide) general settings.

func (Client) GetSettingsNavigation ¶

func (c Client) GetSettingsNavigation(ctx context.Context) (result GetSettingsNavigationResponse, err error)

GetSettingsNavigation calls GET /api/settings/navigation. Get the effective navigation preferences (landing page, env-click target) plus the raw global and per-user values.

func (Client) GetSettingsScanner ¶

func (c Client) GetSettingsScanner(ctx context.Context, options ...GetSettingsScannerOptions) (result GetSettingsScannerResponse, err error)

GetSettingsScanner calls GET /api/settings/scanner. Get the vulnerability-scanner settings for an environment, plus (unless settingsOnly) scanner availability, versions and optional update info.

func (Client) GetSettingsSemver ¶

func (c Client) GetSettingsSemver(ctx context.Context) (result GetSettingsSemverResponse, err error)

GetSettingsSemver calls GET /api/settings/semver. Get the global newer-version-tag (semver) detection config.

func (Client) GetSettingsTheme ¶

func (c Client) GetSettingsTheme(ctx context.Context) (result GetSettingsThemeResponse, err error)

GetSettingsTheme calls GET /api/settings/theme. Public theme + editor display settings (used by the login page before auth).

func (Client) GetStackTags ¶

func (c Client) GetStackTags(ctx context.Context, options ...GetStackTagsOptions) (result GetStackTagsResponse, err error)

GetStackTags calls GET /api/stack-tags. List all stack tag assignments for an environment as a name -> tagIds map.

func (Client) GetStacks ¶

func (c Client) GetStacks(ctx context.Context, options ...GetStacksOptions) (result GetStacksResponse, err error)

GetStacks calls GET /api/stacks. List compose stacks for one environment (internal, external, and git).

func (Client) GetStacksBasePath ¶

func (c Client) GetStacksBasePath(ctx context.Context, options ...GetStacksBasePathOptions) (result GetStacksBasePathResponse, err error)

GetStacksBasePath calls GET /api/stacks/base-path. Return the default Dockhand stacks directory ($DATA_DIR/stacks/) where new stacks are stored by default.

func (Client) GetStacksByNameCompose ¶

func (c Client) GetStacksByNameCompose(ctx context.Context, name string, options ...GetStacksByNameComposeOptions) (result GetStacksByNameComposeResponse, err error)

GetStacksByNameCompose calls GET /api/stacks/{name}/compose. Get a stack's compose file content plus its resolved compose/env paths.

func (Client) GetStacksByNameDeletePreview ¶

func (c Client) GetStacksByNameDeletePreview(ctx context.Context, name string, options ...GetStacksByNameDeletePreviewOptions) (result GetStacksByNameDeletePreviewResponse, err error)

GetStacksByNameDeletePreview calls GET /api/stacks/{name}/delete-preview. Preview the on-disk directories and named volumes a delete-with-files would remove for a stack.

func (Client) GetStacksByNameDeploys ¶

func (c Client) GetStacksByNameDeploys(ctx context.Context, name string, options ...GetStacksByNameDeploysOptions) (result GetStacksByNameDeploysResponse, err error)

GetStacksByNameDeploys calls GET /api/stacks/{name}/deploys. List deploy runs recorded for a stack (no log text -- see GET .../{runId}/log).

func (Client) GetStacksByNameDeploysByRunId ¶

func (c Client) GetStacksByNameDeploysByRunId(ctx context.Context, name string, runId int) (result GetStacksByNameDeploysByRunIdResponse, err error)

GetStacksByNameDeploysByRunId calls GET /api/stacks/{name}/deploys/{runId}. Get a single deploy run's metadata (no log text -- see GET .../{runId}/log).

func (Client) GetStacksByNameDeploysByRunIdLog ¶

func (c Client) GetStacksByNameDeploysByRunIdLog(ctx context.Context, name string, runId int) (result GetStacksByNameDeploysByRunIdLogResponse, err error)

GetStacksByNameDeploysByRunIdLog calls GET /api/stacks/{name}/deploys/{runId}/log. Get a deploy run's log text (text/plain, from the on-disk file).

func (Client) GetStacksByNameEnv ¶

func (c Client) GetStacksByNameEnv(ctx context.Context, name string, options ...GetStacksByNameEnvOptions) (result GetStacksByNameEnvResponse, err error)

GetStacksByNameEnv calls GET /api/stacks/{name}/env. Get a stack's env vars plus injected provider keys.

func (Client) GetStacksByNameEnvRaw ¶

func (c Client) GetStacksByNameEnvRaw(ctx context.Context, name string, options ...GetStacksByNameEnvRawOptions) (result GetStacksByNameEnvRawResponse, err error)

GetStacksByNameEnvRaw calls GET /api/stacks/{name}/env/raw. Get the raw .env file content as-is (comments and formatting preserved) for a stack.

func (Client) GetStacksByNameIcon ¶

func (c Client) GetStacksByNameIcon(ctx context.Context, name string, options ...GetStacksByNameIconOptions) (result GetStacksByNameIconResponse, err error)

GetStacksByNameIcon calls GET /api/stacks/{name}/icon. Get a stack's uploaded custom icon (raw image/webp bytes, not JSON).

func (Client) GetStacksByNameTags ¶

func (c Client) GetStacksByNameTags(ctx context.Context, name string, options ...GetStacksByNameTagsOptions) (result GetStacksByNameTagsResponse, err error)

GetStacksByNameTags calls GET /api/stacks/{name}/tags. Get the tag ids assigned to one stack (by name).

func (Client) GetStacksDefaultPath ¶

func (c Client) GetStacksDefaultPath(ctx context.Context, options GetStacksDefaultPathOptions) (result GetStacksDefaultPathResponse, err error)

GetStacksDefaultPath calls GET /api/stacks/default-path. Compute the default compose/env file paths for a new stack, either under a custom base location or under Dockhand's default stacks directory.

func (Client) GetStacksPathHints ¶

func (c Client) GetStacksPathHints(ctx context.Context, options GetStacksPathHintsOptions) (result GetStacksPathHintsResponse, err error)

GetStacksPathHints calls GET /api/stacks/path-hints. Return path hints (working directory and config file paths) extracted from a stack's Docker container labels.

func (Client) GetStacksSources ¶

func (c Client) GetStacksSources(ctx context.Context, options ...GetStacksSourcesOptions) (result GetStacksSourcesResponse, err error)

GetStacksSources calls GET /api/stacks/sources. List stack source records (their stored compose/env paths and source type, plus an env-var count).

func (Client) GetSystem ¶

func (c Client) GetSystem(ctx context.Context, options ...GetSystemOptions) (result GetSystemResponse, err error)

GetSystem calls GET /api/system. Return aggregated system info — Docker daemon, host, Node.js runtime, database, and object counts for an environment.

func (Client) GetSystemDisk ¶

func (c Client) GetSystemDisk(ctx context.Context, options GetSystemDiskOptions) (result GetSystemDiskResponse, err error)

GetSystemDisk calls GET /api/system/disk. Return Docker disk usage (df) for an environment, or null when collection is disabled, times out, or fails.

func (Client) GetSystemFiles ¶

func (c Client) GetSystemFiles(ctx context.Context, options ...GetSystemFilesOptions) (result GetSystemFilesResponse, err error)

GetSystemFiles calls GET /api/system/files. List the entries of a directory on Dockhand's local filesystem (protected paths are hidden).

func (Client) GetSystemFilesContent ¶

func (c Client) GetSystemFilesContent(ctx context.Context, options GetSystemFilesContentOptions) (result GetSystemFilesContentResponse, err error)

GetSystemFilesContent calls GET /api/system/files/content. Read a text file from Dockhand's local filesystem (max 10MB, protected paths denied).

func (Client) GetTags ¶

func (c Client) GetTags(ctx context.Context) (result GetTagsResponse, err error)

GetTags calls GET /api/tags. List the global tag catalog (name + colour).

func (Client) GetTemplates ¶

func (c Client) GetTemplates(ctx context.Context) (result GetTemplatesResponse, err error)

GetTemplates calls GET /api/templates. Return the normalized app templates aggregated from all enabled template sources (server-side cached for 1 hour).

func (Client) GetTemplatesSources ¶

func (c Client) GetTemplatesSources(ctx context.Context) (result GetTemplatesSourcesResponse, err error)

GetTemplatesSources calls GET /api/templates/sources. List all configured template sources (built-in and custom).

func (Client) GetUsers ¶

func (c Client) GetUsers(ctx context.Context) (result GetUsersResponse, err error)

GetUsers calls GET /api/users. List all local/SSO users.

func (Client) GetUsersById ¶

func (c Client) GetUsersById(ctx context.Context, id UserID) (result GetUsersByIdResponse, err error)

GetUsersById calls GET /api/users/{id}. Get a single user by id (password hash is never returned; isAdmin is derived from role assignment).

func (Client) GetUsersByIdRoles ¶

func (c Client) GetUsersByIdRoles(ctx context.Context, id UserID) (result GetUsersByIdRolesResponse, err error)

GetUsersByIdRoles calls GET /api/users/{id}/roles. List the roles assigned to a user (enterprise only).

func (Client) GetVolumes ¶

func (c Client) GetVolumes(ctx context.Context, options ...GetVolumesOptions) (result GetVolumesResponse, err error)

GetVolumes calls GET /api/volumes. List Docker volumes for an environment; returns an empty array when no environment is specified.

func (Client) GetVolumesByName ¶

func (c Client) GetVolumesByName(ctx context.Context, name string, options ...GetVolumesByNameOptions) (result GetVolumesByNameResponse, err error)

GetVolumesByName calls GET /api/volumes/{name}. Inspect a single Docker volume by name (the name is validated as a Docker identifier).

func (Client) GetVolumesByNameBrowse ¶

func (c Client) GetVolumesByNameBrowse(ctx context.Context, name string, options ...GetVolumesByNameBrowseOptions) (result GetVolumesByNameBrowseResponse, err error)

GetVolumesByNameBrowse calls GET /api/volumes/{name}/browse. Browse a directory inside a Docker volume via a cached helper container; the volume is mounted read-only when in use by other containers.

func (Client) GetVolumesByNameBrowseContent ¶

func (c Client) GetVolumesByNameBrowseContent(ctx context.Context, name string, options GetVolumesByNameBrowseContentOptions) (result GetVolumesByNameBrowseContentResponse, err error)

GetVolumesByNameBrowseContent calls GET /api/volumes/{name}/browse/content. Read the content of a single file inside a Docker volume (files larger than 1MB are rejected).

func (Client) GetVolumesByNameExport ¶

func (c Client) GetVolumesByNameExport(ctx context.Context, name string, options ...GetVolumesByNameExportOptions) (result GetVolumesByNameExportResponse, err error)

GetVolumesByNameExport calls GET /api/volumes/{name}/export. Export a Docker volume (or a sub-path) as a downloadable archive — streaming tar, gzip-compressed tar.gz, or raw single-file bytes.

func (Client) GetVolumesByNameInspect ¶

func (c Client) GetVolumesByNameInspect(ctx context.Context, name string, options ...GetVolumesByNameInspectOptions) (result GetVolumesByNameInspectResponse, err error)

GetVolumesByNameInspect calls GET /api/volumes/{name}/inspect. Inspect a Docker volume by name, returning the raw Docker volume inspect object.

func (Client) GetVulnerabilities ¶

func (c Client) GetVulnerabilities(ctx context.Context, options ...GetVulnerabilitiesOptions) (result GetVulnerabilitiesResponse, err error)

GetVulnerabilities calls GET /api/vulnerabilities. A filtered, sorted page of aggregated vulnerability findings for an environment.

func (Client) GetVulnerabilitiesCount ¶

func (c Client) GetVulnerabilitiesCount(ctx context.Context, options ...GetVulnerabilitiesCountOptions) (result GetVulnerabilitiesCountResponse, err error)

GetVulnerabilitiesCount calls GET /api/vulnerabilities/count. Return the total finding count, severity summary, and distinct image/container/stack filter values for an environment.

func (Client) GetVulnerabilitiesExport ¶

func (c Client) GetVulnerabilitiesExport(ctx context.Context, options ...GetVulnerabilitiesExportOptions) (result GetVulnerabilitiesExportResponse, err error)

GetVulnerabilitiesExport calls GET /api/vulnerabilities/export. Export an environment's aggregated vulnerability findings as json or csv, matching the grid's filters and sort.

func (Client) NeverEndSessions ¶

func (c Client) NeverEndSessions(ctx context.Context) (result PutAuthSettingsResponse, err error)

NeverEndSessions has Dockhand keep a signed-in session until it is signed out of, however long that is. PutAuthSettings cannot: a session that never ends is a time of 0, which it leaves out of what it sends.

func (Client) PostAuthLdap ¶

func (c Client) PostAuthLdap(ctx context.Context, input PostAuthLdapRequest) (result PostAuthLdapResponse, err error)

PostAuthLdap calls POST /api/auth/ldap. Create a new LDAP provider configuration (enterprise only).

func (Client) PostAuthLdapByIdTest ¶

func (c Client) PostAuthLdapByIdTest(ctx context.Context, id int) (result PostAuthLdapByIdTestResponse, err error)

PostAuthLdapByIdTest calls POST /api/auth/ldap/{id}/test. Test connectivity of a stored LDAP configuration by id (enterprise only).

func (Client) PostAuthLogin ¶

func (c Client) PostAuthLogin(ctx context.Context, input PostAuthLoginRequest) (result PostAuthLoginResponse, err error)

PostAuthLogin calls POST /api/auth/login. Authenticate with username/password (local or LDAP) and set the session cookie.

func (Client) PostAuthLogout ¶

func (c Client) PostAuthLogout(ctx context.Context) (result PostAuthLogoutResponse, err error)

PostAuthLogout calls POST /api/auth/logout. Destroy the current session (clears the dockhand_session cookie).

func (Client) PostAuthOidc ¶

func (c Client) PostAuthOidc(ctx context.Context, input PostAuthOidcRequest) (result PostAuthOidcResponse, err error)

PostAuthOidc calls POST /api/auth/oidc. Create a new OIDC provider configuration.

func (Client) PostAuthOidcByIdInitiate ¶

func (c Client) PostAuthOidcByIdInitiate(ctx context.Context, id int, input PostAuthOidcByIdInitiateRequest) (result PostAuthOidcByIdInitiateResponse, err error)

PostAuthOidcByIdInitiate calls POST /api/auth/oidc/{id}/initiate. Return the OIDC authorization URL for a provider without redirecting (JSON response).

func (Client) PostAuthOidcByIdTest ¶

func (c Client) PostAuthOidcByIdTest(ctx context.Context, id int) (result PostAuthOidcByIdTestResponse, err error)

PostAuthOidcByIdTest calls POST /api/auth/oidc/{id}/test. Test the discovery/connection of a stored OIDC configuration by id.

func (Client) PostAuthTokens ¶

func (c Client) PostAuthTokens(ctx context.Context, input PostAuthTokensRequest) (result PostAuthTokensResponse, err error)

PostAuthTokens calls POST /api/auth/tokens. Create a new API token for the authenticated user (requires a session, not a Bearer token).

func (Client) PostAutoUpdateByContainerName ¶

func (c Client) PostAutoUpdateByContainerName(ctx context.Context, containerName string, input PostAutoUpdateByContainerNameRequest, options ...PostAutoUpdateByContainerNameOptions) (result PostAutoUpdateByContainerNameResponse, err error)

PostAutoUpdateByContainerName calls POST /api/auto-update/{containerName}. Create or update a container's auto-update setting; enabled=false deletes it and its schedule.

func (Client) PostBackupConfigs ¶

func (c Client) PostBackupConfigs(ctx context.Context, input PostBackupConfigsRequest) (result PostBackupConfigsResponse, err error)

PostBackupConfigs calls POST /api/backup/configs. Create a backup configuration for a container or stack, optionally scheduled, and register its cron schedule when enabled.

func (Client) PostBackupConfigsByIdRun ¶

func (c Client) PostBackupConfigsByIdRun(ctx context.Context, id BackupConfigID, options ...PostBackupConfigsByIdRunOptions) (result PostBackupConfigsByIdRunResponse, err error)

PostBackupConfigsByIdRun calls POST /api/backup/configs/{id}/run. Trigger a manual backup run for a configuration, streaming progress as a Server-Sent Events job.

func (Client) PostBackupConfigsByIdStop ¶

func (c Client) PostBackupConfigsByIdStop(ctx context.Context, id BackupConfigID) (result PostBackupConfigsByIdStopResponse, err error)

PostBackupConfigsByIdStop calls POST /api/backup/configs/{id}/stop. Cancel the in-flight backup for a configuration.

func (Client) PostBackupDestinations ¶

func (c Client) PostBackupDestinations(ctx context.Context, input PostBackupDestinationsRequest) (result PostBackupDestinationsResponse, err error)

PostBackupDestinations calls POST /api/backup/destinations. Create a restic backup destination, auto-initialize and test the repository, and register its default maintenance schedules.

func (Client) PostBackupDestinationsByIdInit ¶

func (c Client) PostBackupDestinationsByIdInit(ctx context.Context, id BackupDestinationID) (result PostBackupDestinationsByIdInitResponse, err error)

PostBackupDestinationsByIdInit calls POST /api/backup/destinations/{id}/init. Initialize the restic repository for a destination and record the resulting test status.

func (Client) PostBackupDestinationsByIdRotateKey ¶

PostBackupDestinationsByIdRotateKey calls POST /api/backup/destinations/{id}/rotate-key. Rotate the restic repository password for a destination and persist the new password.

func (Client) PostBackupDestinationsByIdTask ¶

PostBackupDestinationsByIdTask calls POST /api/backup/destinations/{id}/task. Run a restic repository maintenance task (unlock, check, prune, stats, repair-index or repair-snapshots) against a destination.

func (Client) PostBackupDestinationsByIdTest ¶

func (c Client) PostBackupDestinationsByIdTest(ctx context.Context, id BackupDestinationID) (result PostBackupDestinationsByIdTestResponse, err error)

PostBackupDestinationsByIdTest calls POST /api/backup/destinations/{id}/test. Test connectivity to a saved backup destination's repository and update its stored test status.

func (Client) PostBackupDestinationsByIdVerify ¶

PostBackupDestinationsByIdVerify calls POST /api/backup/destinations/{id}/verify. Verify the integrity of a destination's backups by reading a data subset, streaming progress as a Server-Sent Events job.

func (Client) PostBackupDestinationsTest ¶

func (c Client) PostBackupDestinationsTest(ctx context.Context, input PostBackupDestinationsTestRequest) (result PostBackupDestinationsTestResponse, err error)

PostBackupDestinationsTest calls POST /api/backup/destinations/test. Test a backup repository — either a saved destination (by destinationId) or inline credentials supplied for a not-yet-saved destination.

func (Client) PostBackupRestore ¶

func (c Client) PostBackupRestore(ctx context.Context, input PostBackupRestoreRequest, options ...PostBackupRestoreOptions) (result PostBackupRestoreResponse, err error)

PostBackupRestore calls POST /api/backup/restore. Restore a backup snapshot in-place or to a new location, streaming progress as a Server-Sent Events job.

func (Client) PostBackupRestorePreview ¶

func (c Client) PostBackupRestorePreview(ctx context.Context, input PostBackupRestorePreviewRequest) (result PostBackupRestorePreviewResponse, err error)

PostBackupRestorePreview calls POST /api/backup/restore/preview. Preview what a restore would write (resolved targets + volume/stack contents).

func (Client) PostBackupRestoreStop ¶

func (c Client) PostBackupRestoreStop(ctx context.Context, input PostBackupRestoreStopRequest) (result PostBackupRestoreStopResponse, err error)

PostBackupRestoreStop calls POST /api/backup/restore/stop. Cancel a running restore — kills the restore helper for a given snapshotId, or all restore helpers when snapshotId is omitted.

func (Client) PostBackupSnapshotsBatchDelete ¶

func (c Client) PostBackupSnapshotsBatchDelete(ctx context.Context, input PostBackupSnapshotsBatchDeleteRequest) (result PostBackupSnapshotsBatchDeleteResponse, err error)

PostBackupSnapshotsBatchDelete calls POST /api/backup/snapshots/batch-delete. Forget and prune several snapshots from one destination in a single restic forget --prune, with per-snapshot ownership and environment access gates.

func (Client) PostBatch ¶

func (c Client) PostBatch(ctx context.Context, input PostBatchRequest, options ...PostBatchOptions) (result PostBatchResponse, err error)

PostBatch calls POST /api/batch. Run a bulk operation (start/stop/restart/pause/unpause/remove/down, depending on entity type) across many containers, images, volumes, networks, or stacks; clients that send Accept application/json get a synchronous summary, others get a jobId and progress over Server-Sent Events.

func (Client) PostConfigSets ¶

func (c Client) PostConfigSets(ctx context.Context, input PostConfigSetsRequest) (result PostConfigSetsResponse, err error)

PostConfigSets calls POST /api/config-sets. Create a new config set.

func (Client) PostContainerIconsByName ¶

func (c Client) PostContainerIconsByName(ctx context.Context, name string, input PostContainerIconsByNameRequest, options ...PostContainerIconsByNameOptions) (result PostContainerIconsByNameResponse, err error)

PostContainerIconsByName calls POST /api/container-icons/{name}. Set a container's icon override - either a name reference or an uploaded image.

func (Client) PostContainers ¶

func (c Client) PostContainers(ctx context.Context, input PostContainersRequest, options ...PostContainersOptions) (result PostContainersResponse, err error)

PostContainers calls POST /api/containers. Create a new container in an environment (auto-pulls the image first if it isn't present locally), optionally starting it right away.

func (Client) PostContainersBatchUpdate ¶

PostContainersBatchUpdate calls POST /api/containers/batch-update. Recreate a set of containers with their latest images, preserving all settings (requires the 'create' permission).

func (Client) PostContainersBatchUpdateStream ¶

PostContainersBatchUpdateStream calls POST /api/containers/batch-update-stream. Recreate a set of containers with live streaming progress (Server-Sent Events), optionally blocking on vulnerability criteria (requires the 'create' permission).

func (Client) PostContainersByIdExec ¶

func (c Client) PostContainersByIdExec(ctx context.Context, id string, input PostContainersByIdExecRequest, options PostContainersByIdExecOptions) (result PostContainersByIdExecResponse, err error)

PostContainersByIdExec calls POST /api/containers/{id}/exec. Create a Docker exec instance in a container and return its ID plus the Docker connection info for a terminal WebSocket.

func (Client) PostContainersByIdExecRun ¶

PostContainersByIdExecRun calls POST /api/containers/{id}/exec/run. Run a finite command in a container and wait for the result, returning stdout, stderr and the exit code (a non-interactive alternative to the terminal exec endpoint).

func (Client) PostContainersByIdFilesChmod ¶

PostContainersByIdFilesChmod calls POST /api/containers/{id}/files/chmod. Change the mode (permissions) of a file or directory inside a container (requires the 'exec' permission).

func (Client) PostContainersByIdFilesChown ¶

PostContainersByIdFilesChown calls POST /api/containers/{id}/files/chown. Change the owner (and optional group) of a file or directory inside a container (requires the 'exec' permission).

func (Client) PostContainersByIdFilesCreate ¶

PostContainersByIdFilesCreate calls POST /api/containers/{id}/files/create. Create an empty file or a directory inside a container (requires the 'exec' permission).

func (Client) PostContainersByIdFilesRename ¶

PostContainersByIdFilesRename calls POST /api/containers/{id}/files/rename. Rename or move a file or directory inside a container (requires the 'exec' permission).

func (Client) PostContainersByIdFilesUpload ¶

func (c Client) PostContainersByIdFilesUpload(ctx context.Context, id string, input io.Reader, contentType string, options PostContainersByIdFilesUploadOptions) (result PostContainersByIdFilesUploadResponse, err error)

PostContainersByIdFilesUpload calls POST /api/containers/{id}/files/upload. Upload one or more files into a container directory (requires the 'exec' permission).

input is sent as contentType, or as multipart/form-data when that is empty.

func (Client) PostContainersByIdPause ¶

func (c Client) PostContainersByIdPause(ctx context.Context, id string, options PostContainersByIdPauseOptions) (result PostContainersByIdPauseResponse, err error)

PostContainersByIdPause calls POST /api/containers/{id}/pause. Pause all processes in a running container (requires the container 'stop' permission).

func (Client) PostContainersByIdRename ¶

PostContainersByIdRename calls POST /api/containers/{id}/rename. Rename a container and update any associated auto-update schedule (requires the 'create' permission).

func (Client) PostContainersByIdRestart ¶

func (c Client) PostContainersByIdRestart(ctx context.Context, id string, options PostContainersByIdRestartOptions) (result PostContainersByIdRestartResponse, err error)

PostContainersByIdRestart calls POST /api/containers/{id}/restart. Restart a container.

func (Client) PostContainersByIdStart ¶

func (c Client) PostContainersByIdStart(ctx context.Context, id string, options PostContainersByIdStartOptions) (result PostContainersByIdStartResponse, err error)

PostContainersByIdStart calls POST /api/containers/{id}/start. Start a stopped container.

func (Client) PostContainersByIdStop ¶

func (c Client) PostContainersByIdStop(ctx context.Context, id string, options PostContainersByIdStopOptions) (result PostContainersByIdStopResponse, err error)

PostContainersByIdStop calls POST /api/containers/{id}/stop. Stop a running container.

func (Client) PostContainersByIdUnpause ¶

func (c Client) PostContainersByIdUnpause(ctx context.Context, id string, options PostContainersByIdUnpauseOptions) (result PostContainersByIdUnpauseResponse, err error)

PostContainersByIdUnpause calls POST /api/containers/{id}/unpause. Resume all processes in a paused container (requires the container 'start' permission).

func (Client) PostContainersByIdUpdate ¶

PostContainersByIdUpdate calls POST /api/containers/{id}/update. Recreate a container with updated create-options (optionally re-pulling the image first), preserving its configuration (requires the 'create' permission).

func (Client) PostContainersByIdUpdateRuntime ¶

PostContainersByIdUpdateRuntime calls POST /api/containers/{id}/update-runtime. Update a running container's restart policy and/or CPU/memory/blkio/pids limits in-place (no recreate).

func (Client) PostContainersCheckUpdates ¶

func (c Client) PostContainersCheckUpdates(ctx context.Context, options PostContainersCheckUpdatesOptions) (result PostContainersCheckUpdatesResponse, err error)

PostContainersCheckUpdates calls POST /api/containers/check-updates. Trigger a fresh image-update check across all (non-hidden, non-podman-infra) containers in an environment.

func (Client) PostDashboardPreferences ¶

func (c Client) PostDashboardPreferences(ctx context.Context, input PostDashboardPreferencesRequest) (result PostDashboardPreferencesResponse, err error)

PostDashboardPreferences calls POST /api/dashboard/preferences. Update the current user's dashboard preferences (only provided fields are merged).

func (Client) PostEnvironments ¶

func (c Client) PostEnvironments(ctx context.Context, input PostEnvironmentsRequest) (result PostEnvironmentsResponse, err error)

PostEnvironments calls POST /api/environments. Register a new Docker environment (host).

func (Client) PostEnvironmentsByIdDiskWarning ¶

func (c Client) PostEnvironmentsByIdDiskWarning(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdDiskWarningRequest) (result PostEnvironmentsByIdDiskWarningResponse, err error)

PostEnvironmentsByIdDiskWarning calls POST /api/environments/{id}/disk-warning. Save the disk-space warning thresholds for an environment (each field optional/independent).

func (Client) PostEnvironmentsByIdIcon ¶

func (c Client) PostEnvironmentsByIdIcon(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdIconRequest) (result PostEnvironmentsByIdIconResponse, err error)

PostEnvironmentsByIdIcon calls POST /api/environments/{id}/icon. Upload a custom icon for an environment (base64-encoded image, ~200KB limit).

func (Client) PostEnvironmentsByIdImagePrune ¶

func (c Client) PostEnvironmentsByIdImagePrune(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdImagePruneRequest) (result PostEnvironmentsByIdImagePruneResponse, err error)

PostEnvironmentsByIdImagePrune calls POST /api/environments/{id}/image-prune. Save the automatic image-prune schedule for an environment (registers/unregisters the croner job).

func (Client) PostEnvironmentsByIdNotifications ¶

func (c Client) PostEnvironmentsByIdNotifications(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdNotificationsRequest) (result PostEnvironmentsByIdNotificationsResponse, err error)

PostEnvironmentsByIdNotifications calls POST /api/environments/{id}/notifications. Attach a notification channel to an environment.

func (Client) PostEnvironmentsByIdRemoteStacksDir ¶

func (c Client) PostEnvironmentsByIdRemoteStacksDir(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdRemoteStacksDirRequest) (result PostEnvironmentsByIdRemoteStacksDirResponse, err error)

PostEnvironmentsByIdRemoteStacksDir calls POST /api/environments/{id}/remote-stacks-dir. Set (or clear) the per-environment remote stacks directory for a direct (agentless) daemon.

func (Client) PostEnvironmentsByIdTest ¶

func (c Client) PostEnvironmentsByIdTest(ctx context.Context, id EnvironmentID) (result PostEnvironmentsByIdTestResponse, err error)

PostEnvironmentsByIdTest calls POST /api/environments/{id}/test. Test connectivity to a saved environment's Docker/Hawser endpoint.

func (Client) PostEnvironmentsByIdTimezone ¶

func (c Client) PostEnvironmentsByIdTimezone(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdTimezoneRequest) (result PostEnvironmentsByIdTimezoneResponse, err error)

PostEnvironmentsByIdTimezone calls POST /api/environments/{id}/timezone. Set the IANA timezone for an environment and refresh its schedules to use it.

func (Client) PostEnvironmentsByIdUpdateCheck ¶

func (c Client) PostEnvironmentsByIdUpdateCheck(ctx context.Context, id EnvironmentID, input PostEnvironmentsByIdUpdateCheckRequest) (result PostEnvironmentsByIdUpdateCheckResponse, err error)

PostEnvironmentsByIdUpdateCheck calls POST /api/environments/{id}/update-check. Save the automatic image update-check schedule for an environment (registers/unregisters the croner job).

func (Client) PostEnvironmentsTest ¶

func (c Client) PostEnvironmentsTest(ctx context.Context, input PostEnvironmentsTestRequest) (result PostEnvironmentsTestResponse, err error)

PostEnvironmentsTest calls POST /api/environments/test. Test a Docker/Hawser connection configuration WITHOUT saving it as an environment.

func (Client) PostGitBranches ¶

func (c Client) PostGitBranches(ctx context.Context, input PostGitBranchesRequest) (result PostGitBranchesResponse, err error)

PostGitBranches calls POST /api/git/branches. List remote branches for a git repository via `git ls-remote`.

func (Client) PostGitCredentials ¶

func (c Client) PostGitCredentials(ctx context.Context, input PostGitCredentialsRequest) (result PostGitCredentialsResponse, err error)

PostGitCredentials calls POST /api/git/credentials. Create a new git credential (none/password/ssh auth) and return it with secrets stripped.

func (Client) PostGitPreviewEnv ¶

func (c Client) PostGitPreviewEnv(ctx context.Context, input PostGitPreviewEnvRequest) (result PostGitPreviewEnvResponse, err error)

PostGitPreviewEnv calls POST /api/git/preview-env. Clone a repo to a temp dir and preview its merged env-file variables for the git-stack env editor.

func (Client) PostGitRepositories ¶

func (c Client) PostGitRepositories(ctx context.Context, input PostGitRepositoriesRequest) (result PostGitRepositoriesResponse, err error)

PostGitRepositories calls POST /api/git/repositories. Create a git repository (branch defaults to main); deployment config lives on git stacks, not here.

func (Client) PostGitRepositoriesByIdDeploy ¶

func (c Client) PostGitRepositoriesByIdDeploy(ctx context.Context, id GitRepositoryID) (result PostGitRepositoriesByIdDeployResponse, err error)

PostGitRepositoriesByIdDeploy calls POST /api/git/repositories/{id}/deploy. Deploy the compose stack(s) defined in a git repository (clones/pulls, then runs docker compose).

func (Client) PostGitRepositoriesByIdSync ¶

func (c Client) PostGitRepositoriesByIdSync(ctx context.Context, id GitRepositoryID) (result PostGitRepositoriesByIdSyncResponse, err error)

PostGitRepositoriesByIdSync calls POST /api/git/repositories/{id}/sync. Sync (git pull) the local clone of a repository to the latest commit on its tracked branch.

func (Client) PostGitRepositoriesByIdTest ¶

func (c Client) PostGitRepositoriesByIdTest(ctx context.Context, id GitRepositoryID) (result PostGitRepositoriesByIdTestResponse, err error)

PostGitRepositoriesByIdTest calls POST /api/git/repositories/{id}/test. Test connectivity/authentication to a saved repository using its stored credential.

func (Client) PostGitRepositoriesTest ¶

func (c Client) PostGitRepositoriesTest(ctx context.Context, input PostGitRepositoriesTestRequest) (result PostGitRepositoriesTestResponse, err error)

PostGitRepositoriesTest calls POST /api/git/repositories/test. Test an unsaved repository configuration (url/branch/credentialId) before creating it.

func (Client) PostGitStacks ¶

func (c Client) PostGitStacks(ctx context.Context, input PostGitStacksRequest) (result PostGitStacksResponse, err error)

PostGitStacks calls POST /api/git/stacks. Create a git-deployed stack (from an existing repo or new repo url/branch).

func (Client) PostGitStacksByIdDeploy ¶

func (c Client) PostGitStacksByIdDeploy(ctx context.Context, id GitStackID) (result PostGitStacksByIdDeployResponse, err error)

PostGitStacksByIdDeploy calls POST /api/git/stacks/{id}/deploy. Deploy a git stack, streaming the deploy log as SSE result events via the job-response channel.

func (Client) PostGitStacksByIdDeployStream ¶

func (c Client) PostGitStacksByIdDeployStream(ctx context.Context, id GitStackID, options ...PostGitStacksByIdDeployStreamOptions) (result PostGitStacksByIdDeployStreamResponse, err error)

PostGitStacksByIdDeployStream calls POST /api/git/stacks/{id}/deploy-stream. Deploy a git stack with live progress; streams SSE, or returns a jobId to poll (Accept negotiated).

func (Client) PostGitStacksByIdEnvFiles ¶

func (c Client) PostGitStacksByIdEnvFiles(ctx context.Context, id GitStackID, input PostGitStacksByIdEnvFilesRequest) (result PostGitStacksByIdEnvFilesResponse, err error)

PostGitStacksByIdEnvFiles calls POST /api/git/stacks/{id}/env-files. Read and parse one .env file from a git stack's repository into a key/value map.

func (Client) PostGitStacksByIdSync ¶

func (c Client) PostGitStacksByIdSync(ctx context.Context, id GitStackID) (result PostGitStacksByIdSyncResponse, err error)

PostGitStacksByIdSync calls POST /api/git/stacks/{id}/sync. Sync (git pull) a git stack's repository clone to the latest tracked commit.

func (Client) PostGitStacksByIdTest ¶

func (c Client) PostGitStacksByIdTest(ctx context.Context, id GitStackID) (result PostGitStacksByIdTestResponse, err error)

PostGitStacksByIdTest calls POST /api/git/stacks/{id}/test. Test a git stack's repository access and compose configuration without deploying.

func (Client) PostGitStacksByIdWebhook ¶

func (c Client) PostGitStacksByIdWebhook(ctx context.Context, id GitStackID) (result PostGitStacksByIdWebhookResponse, err error)

PostGitStacksByIdWebhook calls POST /api/git/stacks/{id}/webhook. Webhook trigger (GitHub/GitLab) that deploys a git stack when its signature/token verifies.

func (Client) PostGitWebhookById ¶

func (c Client) PostGitWebhookById(ctx context.Context, id int, input PostGitWebhookByIdRequest) (result PostGitWebhookByIdResponse, err error)

PostGitWebhookById calls POST /api/git/webhook/{id}. Webhook trigger (GitHub/GitLab) that deploys from a git repository when its signature/token verifies.

func (Client) PostHawserConnect ¶

func (c Client) PostHawserConnect(ctx context.Context) (result PostHawserConnectResponse, err error)

PostHawserConnect calls POST /api/hawser/connect. Fallback for non-WebSocket clients; always advises upgrading to a WebSocket connection.

func (Client) PostHawserTokens ¶

func (c Client) PostHawserTokens(ctx context.Context, input PostHawserTokensRequest) (result PostHawserTokensResponse, err error)

PostHawserTokens calls POST /api/hawser/tokens. Generate a new Hawser agent token for an environment (the plaintext token is returned only once).

func (Client) PostIconsSelfhstBatch ¶

func (c Client) PostIconsSelfhstBatch(ctx context.Context, input PostIconsSelfhstBatchRequest) (result PostIconsSelfhstBatchResponse, err error)

PostIconsSelfhstBatch calls POST /api/icons/selfhst/batch. Resolve multiple selfh.st app icons in one request (avoids per-icon requests a WAF flags as crawling).

func (Client) PostImagesByIdTag ¶

func (c Client) PostImagesByIdTag(ctx context.Context, id string, input PostImagesByIdTagRequest, options ...PostImagesByIdTagOptions) (result PostImagesByIdTagResponse, err error)

PostImagesByIdTag calls POST /api/images/{id}/tag. Tag a Docker image into a repository (defaults the tag to "latest").

func (Client) PostImagesLoad ¶

func (c Client) PostImagesLoad(ctx context.Context, input io.Reader, contentType string, options ...PostImagesLoadOptions) (result PostImagesLoadResponse, err error)

PostImagesLoad calls POST /api/images/load. Load a Docker image from an uploaded tar (docker load) for air-gapped hosts.

input is sent as contentType, or as application/x-tar when that is empty.

func (Client) PostImagesPull ¶

func (c Client) PostImagesPull(ctx context.Context, input PostImagesPullRequest, options ...PostImagesPullOptions) (result PostImagesPullResponse, err error)

PostImagesPull calls POST /api/images/pull. Pull a Docker image and stream pull (and optional scan-on-pull) progress as Server-Sent Events.

func (Client) PostImagesPush ¶

func (c Client) PostImagesPush(ctx context.Context, input PostImagesPushRequest, options ...PostImagesPushOptions) (result PostImagesPushResponse, err error)

PostImagesPush calls POST /api/images/push. Tag a local image and push it to a configured registry (streams progress, or runs synchronously for Accept: application/json).

func (Client) PostImagesScan ¶

func (c Client) PostImagesScan(ctx context.Context, input PostImagesScanRequest, options ...PostImagesScanOptions) (result PostImagesScanResponse, err error)

PostImagesScan calls POST /api/images/scan. Start a vulnerability scan of an image and stream scan progress as Server-Sent Events, persisting the results.

func (Client) PostLabels ¶

func (c Client) PostLabels(ctx context.Context, input PostLabelsRequest) (result PostLabelsResponse, err error)

PostLabels calls POST /api/labels. Perform a bulk label operation on environments — rename, delete, add to environments, or set a custom color — selected via the action field.

func (Client) PostLicense ¶

func (c Client) PostLicense(ctx context.Context, input PostLicenseRequest) (result PostLicenseResponse, err error)

PostLicense calls POST /api/license. Activate a license by name and key.

func (Client) PostNetworks ¶

func (c Client) PostNetworks(ctx context.Context, input PostNetworksRequest, options ...PostNetworksOptions) (result PostNetworksResponse, err error)

PostNetworks calls POST /api/networks. Create a Docker network in the given environment.

func (Client) PostNetworksByIdConnect ¶

func (c Client) PostNetworksByIdConnect(ctx context.Context, id string, input PostNetworksByIdConnectRequest, options ...PostNetworksByIdConnectOptions) (result PostNetworksByIdConnectResponse, err error)

PostNetworksByIdConnect calls POST /api/networks/{id}/connect. Connect a container to a Docker network.

func (Client) PostNetworksByIdDisconnect ¶

PostNetworksByIdDisconnect calls POST /api/networks/{id}/disconnect. Disconnect a container from a Docker network (optionally forcing the disconnect).

func (Client) PostNotifications ¶

func (c Client) PostNotifications(ctx context.Context, input PostNotificationsRequest) (result PostNotificationsResponse, err error)

PostNotifications calls POST /api/notifications. Create a notification setting (SMTP or Apprise); the response masks any SMTP password.

func (Client) PostNotificationsByIdTest ¶

func (c Client) PostNotificationsByIdTest(ctx context.Context, id NotificationID) (result PostNotificationsByIdTestResponse, err error)

PostNotificationsByIdTest calls POST /api/notifications/{id}/test. Send a test notification through an already-saved notification setting.

func (Client) PostNotificationsTest ¶

func (c Client) PostNotificationsTest(ctx context.Context, input PostNotificationsTestRequest) (result PostNotificationsTestResponse, err error)

PostNotificationsTest calls POST /api/notifications/test. Send a test notification using an ad-hoc config supplied in the body (nothing is saved).

func (Client) PostNotificationsTriggerTest ¶

func (c Client) PostNotificationsTriggerTest(ctx context.Context, input PostNotificationsTriggerTestRequest) (result PostNotificationsTriggerTestResponse, err error)

PostNotificationsTriggerTest calls POST /api/notifications/trigger-test. Trigger a real notification for a given event type (development/testing helper).

func (Client) PostPreferencesEnvironmentOrder ¶

func (c Client) PostPreferencesEnvironmentOrder(ctx context.Context, input PostPreferencesEnvironmentOrderRequest) (result PostPreferencesEnvironmentOrderResponse, err error)

PostPreferencesEnvironmentOrder calls POST /api/preferences/environment-order. Save the environment order.

func (Client) PostPreferencesFavoriteGroups ¶

func (c Client) PostPreferencesFavoriteGroups(ctx context.Context, input PostPreferencesFavoriteGroupsRequest) (result PostPreferencesFavoriteGroupsResponse, err error)

PostPreferencesFavoriteGroups calls POST /api/preferences/favorite-groups. Add, remove, update or reorder log favorite-groups for an environment.

func (Client) PostPreferencesFavorites ¶

func (c Client) PostPreferencesFavorites(ctx context.Context, input PostPreferencesFavoritesRequest) (result PostPreferencesFavoritesResponse, err error)

PostPreferencesFavorites calls POST /api/preferences/favorites. Add, remove or reorder log favorites (container names) for an environment.

func (Client) PostPreferencesGrid ¶

func (c Client) PostPreferencesGrid(ctx context.Context, input PostPreferencesGridRequest) (result PostPreferencesGridResponse, err error)

PostPreferencesGrid calls POST /api/preferences/grid. Save column preferences for one data grid and return all grid preferences.

func (Client) PostPreferencesSidebar ¶

func (c Client) PostPreferencesSidebar(ctx context.Context, input PostPreferencesSidebarRequest) (result PostPreferencesSidebarResponse, err error)

PostPreferencesSidebar calls POST /api/preferences/sidebar. Save the sidebar menu preferences (order and hidden items).

func (Client) PostPreferencesTagOrder ¶

func (c Client) PostPreferencesTagOrder(ctx context.Context, input PostPreferencesTagOrderRequest) (result PostPreferencesTagOrderResponse, err error)

PostPreferencesTagOrder calls POST /api/preferences/tag-order. Save the tag order.

func (Client) PostProfileAvatar ¶

func (c Client) PostProfileAvatar(ctx context.Context, input PostProfileAvatarRequest) (result PostProfileAvatarResponse, err error)

PostProfileAvatar calls POST /api/profile/avatar. Upload the authenticated user's avatar as a base64 image data URL (max ~500KB).

func (Client) PostPruneAll ¶

func (c Client) PostPruneAll(ctx context.Context, options ...PostPruneAllOptions) (result PostPruneAllResponse, err error)

PostPruneAll calls POST /api/prune/all. Prune all unused Docker resources (containers, images, volumes and networks) in a single operation.

func (Client) PostPruneContainers ¶

func (c Client) PostPruneContainers(ctx context.Context, options ...PostPruneContainersOptions) (result PostPruneContainersResponse, err error)

PostPruneContainers calls POST /api/prune/containers. Prune (delete) all stopped containers in the target environment.

func (Client) PostPruneImages ¶

func (c Client) PostPruneImages(ctx context.Context, options ...PostPruneImagesOptions) (result PostPruneImagesResponse, err error)

PostPruneImages calls POST /api/prune/images. Prune unused Docker images, streaming progress as a Server-Sent Events job.

func (Client) PostPruneNetworks ¶

func (c Client) PostPruneNetworks(ctx context.Context, options ...PostPruneNetworksOptions) (result PostPruneNetworksResponse, err error)

PostPruneNetworks calls POST /api/prune/networks. Prune (delete) all unused Docker networks in the target environment.

func (Client) PostPruneVolumes ¶

func (c Client) PostPruneVolumes(ctx context.Context, options ...PostPruneVolumesOptions) (result PostPruneVolumesResponse, err error)

PostPruneVolumes calls POST /api/prune/volumes. Prune (delete) all unused Docker volumes in the target environment.

func (Client) PostRegistries ¶

func (c Client) PostRegistries(ctx context.Context, input PostRegistriesRequest) (result PostRegistriesResponse, err error)

PostRegistries calls POST /api/registries. Create a container registry (optionally set it as default); credentials are trimmed and stored encrypted.

func (Client) PostRegistriesByIdDefault ¶

func (c Client) PostRegistriesByIdDefault(ctx context.Context, id RegistryID) (result PostRegistriesByIdDefaultResponse, err error)

PostRegistriesByIdDefault calls POST /api/registries/{id}/default. Mark a registry as the default registry.

func (Client) PostRegistriesTest ¶

func (c Client) PostRegistriesTest(ctx context.Context, input PostRegistriesTestRequest) (result PostRegistriesTestResponse, err error)

PostRegistriesTest calls POST /api/registries/test. Test registry connectivity and (if credentials are given) authentication against the V2 endpoint.

func (Client) PostRoles ¶

func (c Client) PostRoles(ctx context.Context, input PostRolesRequest) (result PostRolesResponse, err error)

PostRoles calls POST /api/roles. Create a custom role (enterprise; admin required when auth is enabled).

func (Client) PostSchedulesByTypeByIdRun ¶

func (c Client) PostSchedulesByTypeByIdRun(ctx context.Context, typeParam string, id int) (result PostSchedulesByTypeByIdRunResponse, err error)

PostSchedulesByTypeByIdRun calls POST /api/schedules/{type}/{id}/run. Manually trigger a single run of a schedule (outside its cron), by type and id.

func (Client) PostSchedulesByTypeByIdToggle ¶

func (c Client) PostSchedulesByTypeByIdToggle(ctx context.Context, typeParam string, id int) (result PostSchedulesByTypeByIdToggleResponse, err error)

PostSchedulesByTypeByIdToggle calls POST /api/schedules/{type}/{id}/toggle. Toggle a schedule's enabled/disabled state (registers/unregisters the croner job accordingly).

func (Client) PostSchedulesSystemByIdToggle ¶

func (c Client) PostSchedulesSystemByIdToggle(ctx context.Context, id int) (result PostSchedulesSystemByIdToggleResponse, err error)

PostSchedulesSystemByIdToggle calls POST /api/schedules/system/{id}/toggle. Toggle one of the three built-in system cleanup jobs (schedule/event/scanner cleanup) on or off.

func (Client) PostSecretProviders ¶

func (c Client) PostSecretProviders(ctx context.Context, input PostSecretProvidersRequest) (result PostSecretProvidersResponse, err error)

PostSecretProviders calls POST /api/secret-providers. Create a secret provider (Vault, Infisical, Doppler, 1Password Connect).

func (Client) PostSecretProvidersByIdProbe ¶

func (c Client) PostSecretProvidersByIdProbe(ctx context.Context, id SecretProviderID, input PostSecretProvidersByIdProbeRequest) (result PostSecretProvidersByIdProbeResponse, err error)

PostSecretProvidersByIdProbe calls POST /api/secret-providers/{id}/probe. Live-probe which key NAMES exist in a stored provider (names only, values never leave the server).

func (Client) PostSecretProvidersByIdTest ¶

func (c Client) PostSecretProvidersByIdTest(ctx context.Context, id SecretProviderID, input PostSecretProvidersByIdTestRequest) (result PostSecretProvidersByIdTestResponse, err error)

PostSecretProvidersByIdTest calls POST /api/secret-providers/{id}/test. Test a stored provider's connectivity, optionally against typed override fields the edit form would save.

func (Client) PostSecretProvidersTest ¶

func (c Client) PostSecretProvidersTest(ctx context.Context, input PostSecretProvidersTestRequest) (result PostSecretProvidersTestResponse, err error)

PostSecretProvidersTest calls POST /api/secret-providers/test. Test an unsaved provider config (before creating the provider).

func (Client) PostSelfUpdate ¶

func (c Client) PostSelfUpdate(ctx context.Context, input PostSelfUpdateRequest) (result PostSelfUpdateResponse, err error)

PostSelfUpdate calls POST /api/self-update. Pull a new Dockhand image and hand off to an updater sidecar that replaces this running container.

func (Client) PostSettingsGeneral ¶

func (c Client) PostSettingsGeneral(ctx context.Context, input PostSettingsGeneralRequest) (result PostSettingsGeneralResponse, err error)

PostSettingsGeneral calls POST /api/settings/general. Update global general settings (all fields optional; only supplied keys are written).

func (Client) PostSettingsScanner ¶

func (c Client) PostSettingsScanner(ctx context.Context, input PostSettingsScannerRequest) (result PostSettingsScannerResponse, err error)

PostSettingsScanner calls POST /api/settings/scanner. Save the vulnerability-scanner settings for an environment.

func (Client) PostSettingsSemver ¶

func (c Client) PostSettingsSemver(ctx context.Context, input PostSettingsSemverRequest) (result PostSettingsSemverResponse, err error)

PostSettingsSemver calls POST /api/settings/semver. Set the global newer-version-tag (semver) detection config.

func (Client) PostStacks ¶

func (c Client) PostStacks(ctx context.Context, input PostStacksRequest, options ...PostStacksOptions) (result PostStacksResponse, err error)

PostStacks calls POST /api/stacks. Create and (optionally) deploy a compose stack.

func (Client) PostStacksAdopt ¶

func (c Client) PostStacksAdopt(ctx context.Context, input PostStacksAdoptRequest) (result PostStacksAdoptResponse, err error)

PostStacksAdopt calls POST /api/stacks/adopt. Adopt previously discovered compose stacks into Dockhand for a given environment.

func (Client) PostStacksByNameCheckPathChange ¶

PostStacksByNameCheckPathChange calls POST /api/stacks/{name}/check-path-change. Check whether a proposed compose path moves the stack to a different directory and how many files the old directory still holds.

func (Client) PostStacksByNameDeploy ¶

func (c Client) PostStacksByNameDeploy(ctx context.Context, name string, input PostStacksByNameDeployRequest, options ...PostStacksByNameDeployOptions) (result PostStacksByNameDeployResponse, err error)

PostStacksByNameDeploy calls POST /api/stacks/{name}/deploy. Deploy (docker compose up) a stack, optionally pulling images, building, and force-recreating; progress and the final result stream over Server-Sent Events.

func (Client) PostStacksByNameDown ¶

func (c Client) PostStacksByNameDown(ctx context.Context, name string, input PostStacksByNameDownRequest, options ...PostStacksByNameDownOptions) (result PostStacksByNameDownResponse, err error)

PostStacksByNameDown calls POST /api/stacks/{name}/down. Take a stack down (docker compose down — removes containers, keeps files), asynchronously.

func (Client) PostStacksByNameEnvValidate ¶

func (c Client) PostStacksByNameEnvValidate(ctx context.Context, name string, input PostStacksByNameEnvValidateRequest, options ...PostStacksByNameEnvValidateOptions) (result PostStacksByNameEnvValidateResponse, err error)

PostStacksByNameEnvValidate calls POST /api/stacks/{name}/env/validate. Validate a stack's defined environment variables against the variables required/optional by its compose file (compose content and the defined variable list may be supplied in the body, otherwise loaded from the saved file/DB).

func (Client) PostStacksByNameIcon ¶

func (c Client) PostStacksByNameIcon(ctx context.Context, name string, input PostStacksByNameIconRequest, options ...PostStacksByNameIconOptions) (result PostStacksByNameIconResponse, err error)

PostStacksByNameIcon calls POST /api/stacks/{name}/icon. Set a stack's icon - either a name reference or an uploaded image.

func (Client) PostStacksByNameRelocate ¶

func (c Client) PostStacksByNameRelocate(ctx context.Context, name string, input PostStacksByNameRelocateRequest, options ...PostStacksByNameRelocateOptions) (result PostStacksByNameRelocateResponse, err error)

PostStacksByNameRelocate calls POST /api/stacks/{name}/relocate. Move all stack files from the old directory to a new location, update the stored compose/env paths, and return the refreshed compose/env content.

func (Client) PostStacksByNameRestart ¶

func (c Client) PostStacksByNameRestart(ctx context.Context, name string, options ...PostStacksByNameRestartOptions) (result PostStacksByNameRestartResponse, err error)

PostStacksByNameRestart calls POST /api/stacks/{name}/restart. Restart a stack (mode=restart|ordered|recreate); progress and the final result stream over Server-Sent Events.

func (Client) PostStacksByNameStart ¶

func (c Client) PostStacksByNameStart(ctx context.Context, name string, options ...PostStacksByNameStartOptions) (result PostStacksByNameStartResponse, err error)

PostStacksByNameStart calls POST /api/stacks/{name}/start. Start a stack (docker compose start/up), asynchronously.

func (Client) PostStacksByNameStop ¶

func (c Client) PostStacksByNameStop(ctx context.Context, name string, options ...PostStacksByNameStopOptions) (result PostStacksByNameStopResponse, err error)

PostStacksByNameStop calls POST /api/stacks/{name}/stop. Stop a stack (docker compose stop), asynchronously.

func (Client) PostStacksByNameValidate ¶

func (c Client) PostStacksByNameValidate(ctx context.Context, name string, input PostStacksByNameValidateRequest, options ...PostStacksByNameValidateOptions) (result PostStacksByNameValidateResponse, err error)

PostStacksByNameValidate calls POST /api/stacks/{name}/validate. Run the Compose Validate preflight linter on a compose file and return findings with severities and line numbers (requires the 'view' permission).

func (Client) PostStacksScan ¶

func (c Client) PostStacksScan(ctx context.Context, input PostStacksScanRequest) (result PostStacksScanResponse, err error)

PostStacksScan calls POST /api/stacks/scan. Scan a given filesystem path (or all configured external paths when none is given) for compose stacks, flagging which discovered stacks are already running.

func (Client) PostStacksValidatePath ¶

func (c Client) PostStacksValidatePath(ctx context.Context, input PostStacksValidatePathRequest) (result PostStacksValidatePathResponse, err error)

PostStacksValidatePath calls POST /api/stacks/validate-path. Validate a candidate external stack path (exists, is a directory, no overlap with already-configured paths); validation failures are returned as 200 with valid=false.

func (Client) PostSystemFiles ¶

func (c Client) PostSystemFiles(ctx context.Context, input PostSystemFilesRequest) (result PostSystemFilesResponse, err error)

PostSystemFiles calls POST /api/system/files. Create a directory on Dockhand's local filesystem (absolute path, no traversal, non-protected).

func (Client) PostTags ¶

func (c Client) PostTags(ctx context.Context, input PostTagsRequest) (result PostTagsResponse, err error)

PostTags calls POST /api/tags. Create a tag (or return the existing one with the same name) in the global catalog.

func (Client) PostTemplatesCompose ¶

func (c Client) PostTemplatesCompose(ctx context.Context, input PostTemplatesComposeRequest) (result PostTemplatesComposeResponse, err error)

PostTemplatesCompose calls POST /api/templates/compose. Return the compose YAML for a template — generated for container templates, fetched from the repository for stack templates.

func (Client) PostTemplatesSources ¶

func (c Client) PostTemplatesSources(ctx context.Context, input PostTemplatesSourcesRequest) (result PostTemplatesSourcesResponse, err error)

PostTemplatesSources calls POST /api/templates/sources. Add a custom template source with a name and URL.

func (Client) PostUsers ¶

func (c Client) PostUsers(ctx context.Context, input PostUsersRequest) (result PostUsersResponse, err error)

PostUsers calls POST /api/users. Create a local user (allowed without auth only during initial setup, before any admin exists).

func (Client) PostUsersByIdMfa ¶

func (c Client) PostUsersByIdMfa(ctx context.Context, id UserID, input PostUsersByIdMfaRequest) (result PostUsersByIdMfaResponse, err error)

PostUsersByIdMfa calls POST /api/users/{id}/mfa. Set up or verify MFA for a user (action=setup regenerates a secret; action=verify confirms a code).

func (Client) PostUsersByIdRoles ¶

func (c Client) PostUsersByIdRoles(ctx context.Context, id UserID, input PostUsersByIdRolesRequest) (result PostUsersByIdRolesResponse, err error)

PostUsersByIdRoles calls POST /api/users/{id}/roles. Assign a role to a user, optionally scoped to an environment (enterprise, admin only).

func (Client) PostVolumes ¶

func (c Client) PostVolumes(ctx context.Context, input PostVolumesRequest, options ...PostVolumesOptions) (result PostVolumesResponse, err error)

PostVolumes calls POST /api/volumes. Create a Docker volume in an environment.

func (Client) PostVolumesByNameBrowseRelease ¶

func (c Client) PostVolumesByNameBrowseRelease(ctx context.Context, name string, options ...PostVolumesByNameBrowseReleaseOptions) (result PostVolumesByNameBrowseReleaseResponse, err error)

PostVolumesByNameBrowseRelease calls POST /api/volumes/{name}/browse/release. Release the cached helper container used to browse a Docker volume.

func (Client) PostVolumesByNameClone ¶

func (c Client) PostVolumesByNameClone(ctx context.Context, name string, input PostVolumesByNameCloneRequest, options ...PostVolumesByNameCloneOptions) (result PostVolumesByNameCloneResponse, err error)

PostVolumesByNameClone calls POST /api/volumes/{name}/clone. Clone a Docker volume into a new named volume, copying the data with a temporary helper container and preserving driver/options/labels.

func (Client) PostVulnerabilitiesScanAll ¶

func (c Client) PostVulnerabilitiesScanAll(ctx context.Context, options ...PostVulnerabilitiesScanAllOptions) (result PostVulnerabilitiesScanAllResponse, err error)

PostVulnerabilitiesScanAll calls POST /api/vulnerabilities/scan-all. Scan every image in an environment for vulnerabilities, streaming per-image progress as Server-Sent Events.

func (Client) PutAuthLdapById ¶

func (c Client) PutAuthLdapById(ctx context.Context, id int, input PutAuthLdapByIdRequest) (result PutAuthLdapByIdResponse, err error)

PutAuthLdapById calls PUT /api/auth/ldap/{id}. Update an existing LDAP provider configuration (only supplied fields change; a masked bindPassword is ignored).

func (Client) PutAuthOidcById ¶

func (c Client) PutAuthOidcById(ctx context.Context, id int, input PutAuthOidcByIdRequest) (result PutAuthOidcByIdResponse, err error)

PutAuthOidcById calls PUT /api/auth/oidc/{id}. Update an existing OIDC provider configuration (only supplied fields change; a masked clientSecret is ignored).

func (Client) PutAuthSettings ¶

func (c Client) PutAuthSettings(ctx context.Context, input PutAuthSettingsRequest) (result PutAuthSettingsResponse, err error)

PutAuthSettings calls PUT /api/auth/settings. Update the global authentication settings (enabling auth requires at least one admin/user to exist).

func (Client) PutBackupConfigsById ¶

func (c Client) PutBackupConfigsById(ctx context.Context, id BackupConfigID, input PutBackupConfigsByIdRequest) (result PutBackupConfigsByIdResponse, err error)

PutBackupConfigsById calls PUT /api/backup/configs/{id}. Update a backup configuration and re-register or remove its cron schedule accordingly.

func (Client) PutBackupDestinationsById ¶

func (c Client) PutBackupDestinationsById(ctx context.Context, id BackupDestinationID, input PutBackupDestinationsByIdRequest) (result PutBackupDestinationsByIdResponse, err error)

PutBackupDestinationsById calls PUT /api/backup/destinations/{id}. Update a backup destination, re-validating repository and flags when supplied and re-registering maintenance schedules when policies change.

func (Client) PutConfigSetsById ¶

func (c Client) PutConfigSetsById(ctx context.Context, id ConfigSetID, input PutConfigSetsByIdRequest) (result PutConfigSetsByIdResponse, err error)

PutConfigSetsById calls PUT /api/config-sets/{id}. Update an existing config set by ID.

func (Client) PutContainerTagsByName ¶

func (c Client) PutContainerTagsByName(ctx context.Context, name string, input PutContainerTagsByNameRequest, options ...PutContainerTagsByNameOptions) (result PutContainerTagsByNameResponse, err error)

PutContainerTagsByName calls PUT /api/container-tags/{name}. Replace the tag ids assigned to one container (by name).

func (Client) PutContainersByIdFilesContent ¶

PutContainersByIdFilesContent calls PUT /api/containers/{id}/files/content. Overwrite the content of a file inside a container (max 1 MB, requires the 'exec' permission).

func (Client) PutEnvironmentsById ¶

func (c Client) PutEnvironmentsById(ctx context.Context, id EnvironmentID, input PutEnvironmentsByIdRequest) (result PutEnvironmentsByIdResponse, err error)

PutEnvironmentsById calls PUT /api/environments/{id}. Update an environment; renaming also renames its on-disk stacks/git-repos directories.

func (Client) PutEnvironmentsByIdImagePrune ¶

func (c Client) PutEnvironmentsByIdImagePrune(ctx context.Context, id EnvironmentID) (result PutEnvironmentsByIdImagePruneResponse, err error)

PutEnvironmentsByIdImagePrune calls PUT /api/environments/{id}/image-prune. Immediately run an image prune for an environment (outside its schedule).

func (Client) PutEnvironmentsByIdNotificationsByNotificationId ¶

func (c Client) PutEnvironmentsByIdNotificationsByNotificationId(ctx context.Context, id EnvironmentID, notificationId NotificationID, input PutEnvironmentsByIdNotificationsByNotificationIdRequest) (result PutEnvironmentsByIdNotificationsByNotificationIdResponse, err error)

PutEnvironmentsByIdNotificationsByNotificationId calls PUT /api/environments/{id}/notifications/{notificationId}. Update a notification-channel link (enabled state and/or event type filter).

func (Client) PutGitCredentialsById ¶

func (c Client) PutGitCredentialsById(ctx context.Context, id GitCredentialID, input PutGitCredentialsByIdRequest) (result PutGitCredentialsByIdResponse, err error)

PutGitCredentialsById calls PUT /api/git/credentials/{id}. Update a git credential and return it with secrets stripped.

func (Client) PutGitRepositoriesById ¶

func (c Client) PutGitRepositoriesById(ctx context.Context, id GitRepositoryID, input PutGitRepositoriesByIdRequest) (result PutGitRepositoriesByIdResponse, err error)

PutGitRepositoriesById calls PUT /api/git/repositories/{id}. Update a git repository's basic fields (name/url/branch/credential).

func (Client) PutGitStacksById ¶

func (c Client) PutGitStacksById(ctx context.Context, id GitStackID, input PutGitStacksByIdRequest) (result PutGitStacksByIdResponse, err error)

PutGitStacksById calls PUT /api/git/stacks/{id}. Update a git stack (rename, schedule, webhook, secret-provider binding).

func (Client) PutNotificationsById ¶

func (c Client) PutNotificationsById(ctx context.Context, id NotificationID, input PutNotificationsByIdRequest) (result PutNotificationsByIdResponse, err error)

PutNotificationsById calls PUT /api/notifications/{id}. Update a notification setting; a masked SMTP password ("********") keeps the stored value.

func (Client) PutProfile ¶

func (c Client) PutProfile(ctx context.Context, input PutProfileRequest) (result PutProfileResponse, err error)

PutProfile calls PUT /api/profile. Update the authenticated user's own profile (email/display name, and optionally the password with current-password confirmation).

func (Client) PutProfilePreferences ¶

func (c Client) PutProfilePreferences(ctx context.Context, input PutProfilePreferencesRequest) (result PutProfilePreferencesResponse, err error)

PutProfilePreferences calls PUT /api/profile/preferences. Update the current user's UI preferences (each field is optional).

func (Client) PutRegistriesById ¶

func (c Client) PutRegistriesById(ctx context.Context, id RegistryID, input PutRegistriesByIdRequest) (result PutRegistriesByIdResponse, err error)

PutRegistriesById calls PUT /api/registries/{id}. Update a registry (optionally set as default); credentials are trimmed and the response strips the password.

func (Client) PutRolesById ¶

func (c Client) PutRolesById(ctx context.Context, id RoleID, input PutRolesByIdRequest) (result PutRolesByIdResponse, err error)

PutRolesById calls PUT /api/roles/{id}. Update a custom role (system roles cannot be modified; enterprise, admin required when auth is enabled).

func (Client) PutSchedulesSettings ¶

func (c Client) PutSchedulesSettings(ctx context.Context, input PutSchedulesSettingsRequest) (result PutSchedulesSettingsResponse, err error)

PutSchedulesSettings calls PUT /api/schedules/settings. Update the schedules-page display preference (hide system jobs) for the current user.

func (Client) PutSecretProvidersById ¶

func (c Client) PutSecretProvidersById(ctx context.Context, id SecretProviderID, input PutSecretProvidersByIdRequest) (result PutSecretProvidersByIdResponse, err error)

PutSecretProvidersById calls PUT /api/secret-providers/{id}. Update a secret provider (name, type, and/or rotate its config); omitted fields are left unchanged.

func (Client) PutSecretProvidersDefault ¶

func (c Client) PutSecretProvidersDefault(ctx context.Context, input PutSecretProvidersDefaultRequest) (result PutSecretProvidersDefaultResponse, err error)

PutSecretProvidersDefault calls PUT /api/secret-providers/default. Set or clear the global default secret provider.

func (Client) PutSettingsNavigation ¶

func (c Client) PutSettingsNavigation(ctx context.Context, input PutSettingsNavigationRequest, options ...PutSettingsNavigationOptions) (result PutSettingsNavigationResponse, err error)

PutSettingsNavigation calls PUT /api/settings/navigation. Update navigation preferences (landing page, env-click target) at global or per-user scope.

func (Client) PutStacksByNameCompose ¶

func (c Client) PutStacksByNameCompose(ctx context.Context, name string, input PutStacksByNameComposeRequest, options ...PutStacksByNameComposeOptions) (result PutStacksByNameComposeResponse, err error)

PutStacksByNameCompose calls PUT /api/stacks/{name}/compose. Save a stack's compose file (and optionally relocate it, bind a secret provider, and redeploy).

func (Client) PutStacksByNameEnv ¶

func (c Client) PutStacksByNameEnv(ctx context.Context, name string, input PutStacksByNameEnvRequest, options ...PutStacksByNameEnvOptions) (result PutStacksByNameEnvResponse, err error)

PutStacksByNameEnv calls PUT /api/stacks/{name}/env. Save a stack's env vars to the DB.

func (Client) PutStacksByNameEnvRaw ¶

func (c Client) PutStacksByNameEnvRaw(ctx context.Context, name string, input PutStacksByNameEnvRawRequest, options ...PutStacksByNameEnvRawOptions) (result PutStacksByNameEnvRawResponse, err error)

PutStacksByNameEnvRaw calls PUT /api/stacks/{name}/env/raw. Write raw .env file content to disk for a stack; empty content deletes the .env file, and masked "***" placeholders are rejected to avoid corrupting secrets.

func (Client) PutStacksByNameTags ¶

func (c Client) PutStacksByNameTags(ctx context.Context, name string, input PutStacksByNameTagsRequest, options ...PutStacksByNameTagsOptions) (result PutStacksByNameTagsResponse, err error)

PutStacksByNameTags calls PUT /api/stacks/{name}/tags. Replace the tag ids assigned to one stack (by name).

func (Client) PutTagsById ¶

func (c Client) PutTagsById(ctx context.Context, id TagID, input PutTagsByIdRequest) (result PutTagsByIdResponse, err error)

PutTagsById calls PUT /api/tags/{id}. Update a global catalog tag's name and/or colour.

func (Client) PutTemplatesSources ¶

func (c Client) PutTemplatesSources(ctx context.Context, input PutTemplatesSourcesRequest) (result PutTemplatesSourcesResponse, err error)

PutTemplatesSources calls PUT /api/templates/sources. Update a template source — toggle enabled, or change its name/URL (only provided fields are changed).

func (Client) PutUsersById ¶

func (c Client) PutUsersById(ctx context.Context, id UserID, input PutUsersByIdRequest) (result PutUsersByIdResponse, err error)

PutUsersById calls PUT /api/users/{id}. Update a user (self-edit is always allowed; admin/active changes require admin; demoting or deactivating the last admin needs confirmDisableAuth).

func (Client) SaveGeneralSettings ¶

func (c Client) SaveGeneralSettings(ctx context.Context, settings map[string]any) (result PostSettingsGeneralResponse, err error)

SaveGeneralSettings has Dockhand save the general settings named, each exactly as it is given, and leave the rest as they are. PostSettingsGeneral cannot say every value: it leaves a number that is 0 and a text that is empty out of what it sends, and Dockhand keeps what it is not sent. A grace of no days is a setting Dockhand takes, and an empty text is how the place it keeps its stacks is forgotten. Dockhand can answer that the save failed and have saved it all the same: what it has is told by reading the settings, not by this answer.

func (Client) SetLogFavorites ¶

func (c Client) SetLogFavorites(ctx context.Context, env int, kept []any) (result PostPreferencesFavoritesResponse, err error)

SetLogFavorites saves everything kept for an environment's log view, in order: a container's name as a text and a group as a record of its name and its containers. PostPreferencesFavorites cannot send a group: it takes names alone, and what is sent is all that is kept afterwards.

type ConfigSetID ¶

type ConfigSetID int

ConfigSetID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and ConfigSetID(n) convert one value, client.IDs a list.

type ConnectionType ¶

type ConnectionType string

ConnectionType is the "ConnectionType" enum.

const (
	ConnectionTypeSocket         ConnectionType = "socket"
	ConnectionTypeDirect         ConnectionType = "direct"
	ConnectionTypeHawserStandard ConnectionType = "hawser-standard"
	ConnectionTypeHawserEdge     ConnectionType = "hawser-edge"
)

Values of ConnectionType.

func (ConnectionType) Known ¶

func (v ConnectionType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type ContainerHealth ¶

type ContainerHealth string

ContainerHealth is the "ContainerHealth" enum.

const (
	ContainerHealthHealthy   ContainerHealth = "healthy"
	ContainerHealthUnhealthy ContainerHealth = "unhealthy"
	ContainerHealthStarting  ContainerHealth = "starting"
)

Values of ContainerHealth.

func (ContainerHealth) Known ¶

func (v ContainerHealth) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type ContainerState ¶

type ContainerState string

ContainerState is the "ContainerState" enum.

const (
	ContainerStateRunning    ContainerState = "running"
	ContainerStateExited     ContainerState = "exited"
	ContainerStatePaused     ContainerState = "paused"
	ContainerStateRestarting ContainerState = "restarting"
	ContainerStateCreated    ContainerState = "created"
	ContainerStateDead       ContainerState = "dead"
	ContainerStateRemoving   ContainerState = "removing"
)

Values of ContainerState.

func (ContainerState) Known ¶

func (v ContainerState) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type DeleteActivityAnswer ¶

type DeleteActivityAnswer struct {
	Success bool `json:"success"`
}

DeleteActivityAnswer is an object the document declares inline.

type DeleteActivityResponse ¶

type DeleteActivityResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteActivityAnswer
	*DeleteActivityAnswer
}

DeleteActivityResponse is the result of DeleteActivity.

Answer is the DeleteActivityAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteActivityResponse) Answered ¶

func (r DeleteActivityResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteActivityResponse) Record ¶

Record is the DeleteActivityAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteAuthLdapByIdAnswer ¶

type DeleteAuthLdapByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteAuthLdapByIdAnswer is an object the document declares inline.

type DeleteAuthLdapByIdResponse ¶

type DeleteAuthLdapByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteAuthLdapByIdAnswer
	*DeleteAuthLdapByIdAnswer
}

DeleteAuthLdapByIdResponse is the result of DeleteAuthLdapById.

Answer is the DeleteAuthLdapByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteAuthLdapByIdResponse) Answered ¶

func (r DeleteAuthLdapByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteAuthLdapByIdResponse) Record ¶

Record is the DeleteAuthLdapByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteAuthOidcByIdAnswer ¶

type DeleteAuthOidcByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteAuthOidcByIdAnswer is an object the document declares inline.

type DeleteAuthOidcByIdResponse ¶

type DeleteAuthOidcByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteAuthOidcByIdAnswer
	*DeleteAuthOidcByIdAnswer
}

DeleteAuthOidcByIdResponse is the result of DeleteAuthOidcById.

Answer is the DeleteAuthOidcByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteAuthOidcByIdResponse) Answered ¶

func (r DeleteAuthOidcByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteAuthOidcByIdResponse) Record ¶

Record is the DeleteAuthOidcByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteAuthTokensByIdAnswer ¶

type DeleteAuthTokensByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteAuthTokensByIdAnswer is an object the document declares inline.

type DeleteAuthTokensByIdResponse ¶

type DeleteAuthTokensByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteAuthTokensByIdAnswer
	*DeleteAuthTokensByIdAnswer
}

DeleteAuthTokensByIdResponse is the result of DeleteAuthTokensById.

Answer is the DeleteAuthTokensByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteAuthTokensByIdResponse) Answered ¶

func (r DeleteAuthTokensByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteAuthTokensByIdResponse) Record ¶

Record is the DeleteAuthTokensByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteAutoUpdateByContainerNameAnswer ¶

type DeleteAutoUpdateByContainerNameAnswer struct {
	Success bool `json:"success"`
}

DeleteAutoUpdateByContainerNameAnswer is an object the document declares inline.

type DeleteAutoUpdateByContainerNameOptions ¶

type DeleteAutoUpdateByContainerNameOptions struct {
	// Environment the container belongs to (from GET /api/environments)
	Env EnvironmentID
}

DeleteAutoUpdateByContainerNameOptions holds the query and header parameters of DeleteAutoUpdateByContainerName.

func (DeleteAutoUpdateByContainerNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteAutoUpdateByContainerNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteAutoUpdateByContainerNameResponse ¶

type DeleteAutoUpdateByContainerNameResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteAutoUpdateByContainerNameAnswer
	*DeleteAutoUpdateByContainerNameAnswer
}

DeleteAutoUpdateByContainerNameResponse is the result of DeleteAutoUpdateByContainerName.

Answer is the DeleteAutoUpdateByContainerNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteAutoUpdateByContainerNameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteAutoUpdateByContainerNameResponse) Record ¶

Record is the DeleteAutoUpdateByContainerNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteBackupConfigsByIdAnswer ¶ added in v0.2.0

type DeleteBackupConfigsByIdAnswer struct {
	// with deleteSnapshots: how many of its snapshots were removed
	Snapshots *DeleteBackupConfigsByIdAnswerSnapshots `json:"snapshots,omitempty"`
	Success   bool                                    `json:"success"`
}

DeleteBackupConfigsByIdAnswer is an object the document declares inline.

type DeleteBackupConfigsByIdAnswerSnapshots ¶ added in v0.2.0

type DeleteBackupConfigsByIdAnswerSnapshots struct {
	Deleted int    `json:"deleted,omitempty"`
	Error   string `json:"error,omitempty"`
	Skipped int    `json:"skipped,omitempty"`
}

DeleteBackupConfigsByIdAnswerSnapshots is an object the document declares inline.

with deleteSnapshots: how many of its snapshots were removed

type DeleteBackupConfigsByIdOptions ¶

type DeleteBackupConfigsByIdOptions struct {
	// Also forget and prune this config's snapshots (default false; snapshots survive so a restore is still possible)
	DeleteSnapshots *bool
}

DeleteBackupConfigsByIdOptions holds the query and header parameters of DeleteBackupConfigsById.

func (DeleteBackupConfigsByIdOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteBackupConfigsByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteBackupConfigsByIdResponse ¶

type DeleteBackupConfigsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteBackupConfigsByIdAnswer
	*DeleteBackupConfigsByIdAnswer
}

DeleteBackupConfigsByIdResponse is the result of DeleteBackupConfigsById.

Answer is the DeleteBackupConfigsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteBackupConfigsByIdResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteBackupConfigsByIdResponse) Record ¶ added in v0.2.0

Record is the DeleteBackupConfigsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteBackupDestinationsByIdAnswer ¶ added in v0.2.0

type DeleteBackupDestinationsByIdAnswer struct {
	Error   string `json:"error,omitempty"`
	Success bool   `json:"success"`
}

DeleteBackupDestinationsByIdAnswer is an object the document declares inline.

type DeleteBackupDestinationsByIdResponse ¶

type DeleteBackupDestinationsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteBackupDestinationsByIdAnswer
	*DeleteBackupDestinationsByIdAnswer
}

DeleteBackupDestinationsByIdResponse is the result of DeleteBackupDestinationsById.

Answer is the DeleteBackupDestinationsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteBackupDestinationsByIdResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteBackupDestinationsByIdResponse) Record ¶ added in v0.2.0

Record is the DeleteBackupDestinationsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteBackupSnapshotsByIdAnswer ¶ added in v0.2.0

type DeleteBackupSnapshotsByIdAnswer struct {
	Error   string `json:"error,omitempty"`
	Success bool   `json:"success"`
}

DeleteBackupSnapshotsByIdAnswer is an object the document declares inline.

type DeleteBackupSnapshotsByIdOptions ¶

type DeleteBackupSnapshotsByIdOptions struct {
	// Destination holding the snapshot (required) (from GET /api/backup/destinations)
	DestinationId BackupDestinationID

	// Optional environment id for an early enterprise access check; the authoritative gate resolves the snapshot's owning environment server-side (from GET /api/environments)
	Env EnvironmentID
}

DeleteBackupSnapshotsByIdOptions holds the query and header parameters of DeleteBackupSnapshotsById.

func (DeleteBackupSnapshotsByIdOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteBackupSnapshotsByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteBackupSnapshotsByIdResponse ¶

type DeleteBackupSnapshotsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteBackupSnapshotsByIdAnswer
	*DeleteBackupSnapshotsByIdAnswer
}

DeleteBackupSnapshotsByIdResponse is the result of DeleteBackupSnapshotsById.

Answer is the DeleteBackupSnapshotsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteBackupSnapshotsByIdResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteBackupSnapshotsByIdResponse) Record ¶ added in v0.2.0

Record is the DeleteBackupSnapshotsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteConfigSetsByIdAnswer ¶

type DeleteConfigSetsByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteConfigSetsByIdAnswer is an object the document declares inline.

type DeleteConfigSetsByIdResponse ¶

type DeleteConfigSetsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteConfigSetsByIdAnswer
	*DeleteConfigSetsByIdAnswer
}

DeleteConfigSetsByIdResponse is the result of DeleteConfigSetsById.

Answer is the DeleteConfigSetsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteConfigSetsByIdResponse) Answered ¶

func (r DeleteConfigSetsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteConfigSetsByIdResponse) Record ¶

Record is the DeleteConfigSetsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteContainerIconsByNameAnswer ¶

type DeleteContainerIconsByNameAnswer struct {
	Success bool `json:"success"`
}

DeleteContainerIconsByNameAnswer is an object the document declares inline.

type DeleteContainerIconsByNameOptions ¶

type DeleteContainerIconsByNameOptions struct {
	// Environment id the container belongs to
	Env EnvironmentID
}

DeleteContainerIconsByNameOptions holds the query and header parameters of DeleteContainerIconsByName.

func (DeleteContainerIconsByNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteContainerIconsByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteContainerIconsByNameResponse ¶

type DeleteContainerIconsByNameResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteContainerIconsByNameAnswer
	*DeleteContainerIconsByNameAnswer
}

DeleteContainerIconsByNameResponse is the result of DeleteContainerIconsByName.

Answer is the DeleteContainerIconsByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteContainerIconsByNameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteContainerIconsByNameResponse) Record ¶

Record is the DeleteContainerIconsByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteContainersByIdAnswer ¶

type DeleteContainersByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteContainersByIdAnswer is an object the document declares inline.

type DeleteContainersByIdFilesDeleteAnswer ¶

type DeleteContainersByIdFilesDeleteAnswer struct {
	Path    string `json:"path"`
	Success bool   `json:"success"`
}

DeleteContainersByIdFilesDeleteAnswer is an object the document declares inline.

type DeleteContainersByIdFilesDeleteOptions ¶

type DeleteContainersByIdFilesDeleteOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Absolute path inside the container to delete
	Path string
}

DeleteContainersByIdFilesDeleteOptions holds the query and header parameters of DeleteContainersByIdFilesDelete.

func (DeleteContainersByIdFilesDeleteOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteContainersByIdFilesDeleteOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteContainersByIdFilesDeleteResponse ¶

type DeleteContainersByIdFilesDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteContainersByIdFilesDeleteAnswer
	*DeleteContainersByIdFilesDeleteAnswer
}

DeleteContainersByIdFilesDeleteResponse is the result of DeleteContainersByIdFilesDelete.

Answer is the DeleteContainersByIdFilesDeleteAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteContainersByIdFilesDeleteResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteContainersByIdFilesDeleteResponse) Record ¶

Record is the DeleteContainersByIdFilesDeleteAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteContainersByIdOptions ¶

type DeleteContainersByIdOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Force removal of a running container (Docker force flag)
	Force *bool
}

DeleteContainersByIdOptions holds the query and header parameters of DeleteContainersById.

func (DeleteContainersByIdOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteContainersByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteContainersByIdResponse ¶

type DeleteContainersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteContainersByIdAnswer
	*DeleteContainersByIdAnswer
}

DeleteContainersByIdResponse is the result of DeleteContainersById.

Answer is the DeleteContainersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteContainersByIdResponse) Answered ¶

func (r DeleteContainersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteContainersByIdResponse) Record ¶

Record is the DeleteContainersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteContainersPendingUpdatesAnswer ¶

type DeleteContainersPendingUpdatesAnswer struct {
	Success bool `json:"success"`
}

DeleteContainersPendingUpdatesAnswer is an object the document declares inline.

type DeleteContainersPendingUpdatesOptions ¶

type DeleteContainersPendingUpdatesOptions struct {
	// The target environment ID (required) (from GET /api/environments)
	Env EnvironmentID

	// The container to clear; omit to clear ALL pending updates in the environment (from GET /api/containers)
	ContainerId string
}

DeleteContainersPendingUpdatesOptions holds the query and header parameters of DeleteContainersPendingUpdates.

func (DeleteContainersPendingUpdatesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteContainersPendingUpdatesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteContainersPendingUpdatesResponse ¶

type DeleteContainersPendingUpdatesResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteContainersPendingUpdatesAnswer
	*DeleteContainersPendingUpdatesAnswer
}

DeleteContainersPendingUpdatesResponse is the result of DeleteContainersPendingUpdates.

Answer is the DeleteContainersPendingUpdatesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteContainersPendingUpdatesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteContainersPendingUpdatesResponse) Record ¶

Record is the DeleteContainersPendingUpdatesAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteEnvironmentsByIdAnswer ¶

type DeleteEnvironmentsByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteEnvironmentsByIdAnswer is an object the document declares inline.

type DeleteEnvironmentsByIdIconAnswer ¶

type DeleteEnvironmentsByIdIconAnswer struct {
	Icon    string `json:"icon"`
	Success bool   `json:"success"`
}

DeleteEnvironmentsByIdIconAnswer is an object the document declares inline.

type DeleteEnvironmentsByIdIconResponse ¶

type DeleteEnvironmentsByIdIconResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteEnvironmentsByIdIconAnswer
	*DeleteEnvironmentsByIdIconAnswer
}

DeleteEnvironmentsByIdIconResponse is the result of DeleteEnvironmentsByIdIcon.

Answer is the DeleteEnvironmentsByIdIconAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteEnvironmentsByIdIconResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteEnvironmentsByIdIconResponse) Record ¶

Record is the DeleteEnvironmentsByIdIconAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer ¶

type DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer struct {
	Success bool `json:"success"`
}

DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer is an object the document declares inline.

type DeleteEnvironmentsByIdNotificationsByNotificationIdResponse ¶

type DeleteEnvironmentsByIdNotificationsByNotificationIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer
	*DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer
}

DeleteEnvironmentsByIdNotificationsByNotificationIdResponse is the result of DeleteEnvironmentsByIdNotificationsByNotificationId.

Answer is the DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteEnvironmentsByIdNotificationsByNotificationIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteEnvironmentsByIdNotificationsByNotificationIdResponse) Record ¶

Record is the DeleteEnvironmentsByIdNotificationsByNotificationIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteEnvironmentsByIdResponse ¶

type DeleteEnvironmentsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteEnvironmentsByIdAnswer
	*DeleteEnvironmentsByIdAnswer
}

DeleteEnvironmentsByIdResponse is the result of DeleteEnvironmentsById.

Answer is the DeleteEnvironmentsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteEnvironmentsByIdResponse) Answered ¶

func (r DeleteEnvironmentsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteEnvironmentsByIdResponse) Record ¶

Record is the DeleteEnvironmentsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteGitCredentialsByIdAnswer ¶

type DeleteGitCredentialsByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteGitCredentialsByIdAnswer is an object the document declares inline.

type DeleteGitCredentialsByIdResponse ¶

type DeleteGitCredentialsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteGitCredentialsByIdAnswer
	*DeleteGitCredentialsByIdAnswer
}

DeleteGitCredentialsByIdResponse is the result of DeleteGitCredentialsById.

Answer is the DeleteGitCredentialsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteGitCredentialsByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteGitCredentialsByIdResponse) Record ¶

Record is the DeleteGitCredentialsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteGitRepositoriesByIdAnswer ¶

type DeleteGitRepositoriesByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteGitRepositoriesByIdAnswer is an object the document declares inline.

type DeleteGitRepositoriesByIdResponse ¶

type DeleteGitRepositoriesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteGitRepositoriesByIdAnswer
	*DeleteGitRepositoriesByIdAnswer
}

DeleteGitRepositoriesByIdResponse is the result of DeleteGitRepositoriesById.

Answer is the DeleteGitRepositoriesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteGitRepositoriesByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteGitRepositoriesByIdResponse) Record ¶

Record is the DeleteGitRepositoriesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteGitStacksByIdAnswer ¶

type DeleteGitStacksByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteGitStacksByIdAnswer is an object the document declares inline.

type DeleteGitStacksByIdResponse ¶

type DeleteGitStacksByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteGitStacksByIdAnswer
	*DeleteGitStacksByIdAnswer
}

DeleteGitStacksByIdResponse is the result of DeleteGitStacksById.

Answer is the DeleteGitStacksByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteGitStacksByIdResponse) Answered ¶

func (r DeleteGitStacksByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteGitStacksByIdResponse) Record ¶

Record is the DeleteGitStacksByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteHawserTokensAnswer ¶

type DeleteHawserTokensAnswer struct {
	Message string `json:"message"`
	Success bool   `json:"success"`
}

DeleteHawserTokensAnswer is an object the document declares inline.

type DeleteHawserTokensOptions ¶

type DeleteHawserTokensOptions struct {
	// ID of the token to revoke (from GET /api/hawser/tokens)
	Id *int
}

DeleteHawserTokensOptions holds the query and header parameters of DeleteHawserTokens.

func (DeleteHawserTokensOptions) ToHeaders ¶

func (o DeleteHawserTokensOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteHawserTokensOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteHawserTokensResponse ¶

type DeleteHawserTokensResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteHawserTokensAnswer
	*DeleteHawserTokensAnswer
}

DeleteHawserTokensResponse is the result of DeleteHawserTokens.

Answer is the DeleteHawserTokensAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteHawserTokensResponse) Answered ¶

func (r DeleteHawserTokensResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteHawserTokensResponse) Record ¶

Record is the DeleteHawserTokensAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteImagesByIdAnswer ¶

type DeleteImagesByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteImagesByIdAnswer is an object the document declares inline.

type DeleteImagesByIdOptions ¶

type DeleteImagesByIdOptions struct {
	// ID of the environment the image belongs to (from GET /api/environments)
	Env EnvironmentID

	// Force removal even if the image is tagged or referenced (default false)
	Force *bool
}

DeleteImagesByIdOptions holds the query and header parameters of DeleteImagesById.

func (DeleteImagesByIdOptions) ToHeaders ¶

func (o DeleteImagesByIdOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteImagesByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteImagesByIdResponse ¶

type DeleteImagesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteImagesByIdAnswer
	*DeleteImagesByIdAnswer
}

DeleteImagesByIdResponse is the result of DeleteImagesById.

Answer is the DeleteImagesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteImagesByIdResponse) Answered ¶

func (r DeleteImagesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteImagesByIdResponse) Record ¶

Record is the DeleteImagesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteJobsByIdAnswer ¶

type DeleteJobsByIdAnswer struct {
	Cancelled bool `json:"cancelled"`
}

DeleteJobsByIdAnswer is an object the document declares inline.

type DeleteJobsByIdResponse ¶

type DeleteJobsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteJobsByIdAnswer
	*DeleteJobsByIdAnswer
}

DeleteJobsByIdResponse is the result of DeleteJobsById.

Answer is the DeleteJobsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteJobsByIdResponse) Answered ¶

func (r DeleteJobsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteJobsByIdResponse) Record ¶

Record is the DeleteJobsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteLicenseAnswer ¶

type DeleteLicenseAnswer struct {
	Success bool `json:"success"`
}

DeleteLicenseAnswer is an object the document declares inline.

type DeleteLicenseResponse ¶

type DeleteLicenseResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteLicenseAnswer
	*DeleteLicenseAnswer
}

DeleteLicenseResponse is the result of DeleteLicense.

Answer is the DeleteLicenseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteLicenseResponse) Answered ¶

func (r DeleteLicenseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteLicenseResponse) Record ¶

Record is the DeleteLicenseAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteNetworksByIdAnswer ¶

type DeleteNetworksByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteNetworksByIdAnswer is an object the document declares inline.

type DeleteNetworksByIdOptions ¶

type DeleteNetworksByIdOptions struct {
	// Environment the network belongs to (from GET /api/environments)
	Env EnvironmentID
}

DeleteNetworksByIdOptions holds the query and header parameters of DeleteNetworksById.

func (DeleteNetworksByIdOptions) ToHeaders ¶

func (o DeleteNetworksByIdOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteNetworksByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteNetworksByIdResponse ¶

type DeleteNetworksByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteNetworksByIdAnswer
	*DeleteNetworksByIdAnswer
}

DeleteNetworksByIdResponse is the result of DeleteNetworksById.

Answer is the DeleteNetworksByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteNetworksByIdResponse) Answered ¶

func (r DeleteNetworksByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteNetworksByIdResponse) Record ¶

Record is the DeleteNetworksByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteNotificationsByIdAnswer ¶

type DeleteNotificationsByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteNotificationsByIdAnswer is an object the document declares inline.

type DeleteNotificationsByIdResponse ¶

type DeleteNotificationsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteNotificationsByIdAnswer
	*DeleteNotificationsByIdAnswer
}

DeleteNotificationsByIdResponse is the result of DeleteNotificationsById.

Answer is the DeleteNotificationsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteNotificationsByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteNotificationsByIdResponse) Record ¶

Record is the DeleteNotificationsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeletePreferencesEnvironmentOrderAnswer ¶

type DeletePreferencesEnvironmentOrderAnswer struct {
	Order []int `json:"order,omitzero"`
}

DeletePreferencesEnvironmentOrderAnswer is an object the document declares inline.

type DeletePreferencesEnvironmentOrderResponse ¶

type DeletePreferencesEnvironmentOrderResponse struct {
	HttpResponse *http.Response
	Answer       *DeletePreferencesEnvironmentOrderAnswer
	*DeletePreferencesEnvironmentOrderAnswer
}

DeletePreferencesEnvironmentOrderResponse is the result of DeletePreferencesEnvironmentOrder.

Answer is the DeletePreferencesEnvironmentOrderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeletePreferencesEnvironmentOrderResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeletePreferencesEnvironmentOrderResponse) Record ¶

Record is the DeletePreferencesEnvironmentOrderAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeletePreferencesGridAnswer ¶

type DeletePreferencesGridAnswer struct {
	// the columns saved for each grid, by the grid's id
	Preferences map[string]DeletePreferencesGridAnswerPreferences `json:"preferences,omitzero"`
}

DeletePreferencesGridAnswer is an object the document declares inline.

type DeletePreferencesGridAnswerPreferences ¶

type DeletePreferencesGridAnswerPreferences struct {
	Columns []DeletePreferencesGridAnswerPreferencesColumns `json:"columns,omitzero"`
}

DeletePreferencesGridAnswerPreferences is an object the document declares inline.

type DeletePreferencesGridAnswerPreferencesColumns ¶

type DeletePreferencesGridAnswerPreferencesColumns struct {
	Id      string `json:"id,omitempty"`
	Visible bool   `json:"visible"`
}

DeletePreferencesGridAnswerPreferencesColumns is an object the document declares inline.

type DeletePreferencesGridOptions ¶

type DeletePreferencesGridOptions struct {
	// Grid ID to reset; omit to reset every grid
	GridId string
}

DeletePreferencesGridOptions holds the query and header parameters of DeletePreferencesGrid.

func (DeletePreferencesGridOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeletePreferencesGridOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeletePreferencesGridResponse ¶

type DeletePreferencesGridResponse struct {
	HttpResponse *http.Response
	Answer       *DeletePreferencesGridAnswer
	*DeletePreferencesGridAnswer
}

DeletePreferencesGridResponse is the result of DeletePreferencesGrid.

Answer is the DeletePreferencesGridAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeletePreferencesGridResponse) Answered ¶

func (r DeletePreferencesGridResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeletePreferencesGridResponse) Record ¶

Record is the DeletePreferencesGridAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeletePreferencesSidebarAnswer ¶

type DeletePreferencesSidebarAnswer struct {
	Preferences *DeletePreferencesSidebarAnswerPreferences `json:"preferences,omitempty"`
}

DeletePreferencesSidebarAnswer is an object the document declares inline.

type DeletePreferencesSidebarAnswerPreferences ¶

type DeletePreferencesSidebarAnswerPreferences struct {
	Hidden []string `json:"hidden,omitzero"`
	Order  []string `json:"order,omitzero"`
}

DeletePreferencesSidebarAnswerPreferences is an object the document declares inline.

type DeletePreferencesSidebarResponse ¶

type DeletePreferencesSidebarResponse struct {
	HttpResponse *http.Response
	Answer       *DeletePreferencesSidebarAnswer
	*DeletePreferencesSidebarAnswer
}

DeletePreferencesSidebarResponse is the result of DeletePreferencesSidebar.

Answer is the DeletePreferencesSidebarAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeletePreferencesSidebarResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeletePreferencesSidebarResponse) Record ¶

Record is the DeletePreferencesSidebarAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeletePreferencesTagOrderAnswer ¶

type DeletePreferencesTagOrderAnswer struct {
	Order []int `json:"order,omitzero"`
}

DeletePreferencesTagOrderAnswer is an object the document declares inline.

type DeletePreferencesTagOrderResponse ¶

type DeletePreferencesTagOrderResponse struct {
	HttpResponse *http.Response
	Answer       *DeletePreferencesTagOrderAnswer
	*DeletePreferencesTagOrderAnswer
}

DeletePreferencesTagOrderResponse is the result of DeletePreferencesTagOrder.

Answer is the DeletePreferencesTagOrderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeletePreferencesTagOrderResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeletePreferencesTagOrderResponse) Record ¶

Record is the DeletePreferencesTagOrderAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteProfileAvatarAnswer ¶

type DeleteProfileAvatarAnswer struct {
	Success bool `json:"success"`
}

DeleteProfileAvatarAnswer is an object the document declares inline.

type DeleteProfileAvatarResponse ¶

type DeleteProfileAvatarResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteProfileAvatarAnswer
	*DeleteProfileAvatarAnswer
}

DeleteProfileAvatarResponse is the result of DeleteProfileAvatar.

Answer is the DeleteProfileAvatarAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteProfileAvatarResponse) Answered ¶

func (r DeleteProfileAvatarResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteProfileAvatarResponse) Record ¶

Record is the DeleteProfileAvatarAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteRegistriesByIdAnswer ¶

type DeleteRegistriesByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteRegistriesByIdAnswer is an object the document declares inline.

type DeleteRegistriesByIdResponse ¶

type DeleteRegistriesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteRegistriesByIdAnswer
	*DeleteRegistriesByIdAnswer
}

DeleteRegistriesByIdResponse is the result of DeleteRegistriesById.

Answer is the DeleteRegistriesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteRegistriesByIdResponse) Answered ¶

func (r DeleteRegistriesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteRegistriesByIdResponse) Record ¶

Record is the DeleteRegistriesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteRegistryImageAnswer ¶

type DeleteRegistryImageAnswer struct {
	Message string `json:"message,omitempty"`
	Success bool   `json:"success"`
}

DeleteRegistryImageAnswer is an object the document declares inline.

type DeleteRegistryImageOptions ¶

type DeleteRegistryImageOptions struct {
	// ID of the configured registry (from GET /api/registries)
	Registry RegistryID

	// Repository/image name (may include an org path)
	Image string

	// Tag to delete
	Tag string
}

DeleteRegistryImageOptions holds the query and header parameters of DeleteRegistryImage.

func (DeleteRegistryImageOptions) ToHeaders ¶

func (o DeleteRegistryImageOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteRegistryImageOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteRegistryImageResponse ¶

type DeleteRegistryImageResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteRegistryImageAnswer
	*DeleteRegistryImageAnswer
}

DeleteRegistryImageResponse is the result of DeleteRegistryImage.

Answer is the DeleteRegistryImageAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteRegistryImageResponse) Answered ¶

func (r DeleteRegistryImageResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteRegistryImageResponse) Record ¶

Record is the DeleteRegistryImageAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteRolesByIdAnswer ¶

type DeleteRolesByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteRolesByIdAnswer is an object the document declares inline.

type DeleteRolesByIdResponse ¶

type DeleteRolesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteRolesByIdAnswer
	*DeleteRolesByIdAnswer
}

DeleteRolesByIdResponse is the result of DeleteRolesById.

Answer is the DeleteRolesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteRolesByIdResponse) Answered ¶

func (r DeleteRolesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteRolesByIdResponse) Record ¶

Record is the DeleteRolesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteSchedulesByTypeByIdAnswer ¶

type DeleteSchedulesByTypeByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteSchedulesByTypeByIdAnswer is an object the document declares inline.

type DeleteSchedulesByTypeByIdResponse ¶

type DeleteSchedulesByTypeByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteSchedulesByTypeByIdAnswer
	*DeleteSchedulesByTypeByIdAnswer
}

DeleteSchedulesByTypeByIdResponse is the result of DeleteSchedulesByTypeById.

Answer is the DeleteSchedulesByTypeByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteSchedulesByTypeByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteSchedulesByTypeByIdResponse) Record ¶

Record is the DeleteSchedulesByTypeByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteSchedulesExecutionsByIdAnswer ¶

type DeleteSchedulesExecutionsByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteSchedulesExecutionsByIdAnswer is an object the document declares inline.

type DeleteSchedulesExecutionsByIdResponse ¶

type DeleteSchedulesExecutionsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteSchedulesExecutionsByIdAnswer
	*DeleteSchedulesExecutionsByIdAnswer
}

DeleteSchedulesExecutionsByIdResponse is the result of DeleteSchedulesExecutionsById.

Answer is the DeleteSchedulesExecutionsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteSchedulesExecutionsByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteSchedulesExecutionsByIdResponse) Record ¶

Record is the DeleteSchedulesExecutionsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteSecretProvidersByIdAnswer ¶

type DeleteSecretProvidersByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteSecretProvidersByIdAnswer is an object the document declares inline.

type DeleteSecretProvidersByIdResponse ¶

type DeleteSecretProvidersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteSecretProvidersByIdAnswer
	*DeleteSecretProvidersByIdAnswer
}

DeleteSecretProvidersByIdResponse is the result of DeleteSecretProvidersById.

Answer is the DeleteSecretProvidersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteSecretProvidersByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteSecretProvidersByIdResponse) Record ¶

Record is the DeleteSecretProvidersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteSettingsScannerAnswer ¶

type DeleteSettingsScannerAnswer struct {
	Errors  []string `json:"errors,omitzero"`
	Removed []string `json:"removed,omitzero"`
	Success bool     `json:"success"`
}

DeleteSettingsScannerAnswer is an object the document declares inline.

type DeleteSettingsScannerCacheAnswer ¶

type DeleteSettingsScannerCacheAnswer struct {
	RemovedDirs         []string `json:"removedDirs"`
	RemovedVolumes      []string `json:"removedVolumes"`
	SkippedEnvironments []string `json:"skippedEnvironments"`
	Success             bool     `json:"success"`
}

DeleteSettingsScannerCacheAnswer is an object the document declares inline.

type DeleteSettingsScannerCacheResponse ¶

type DeleteSettingsScannerCacheResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteSettingsScannerCacheAnswer
	*DeleteSettingsScannerCacheAnswer
}

DeleteSettingsScannerCacheResponse is the result of DeleteSettingsScannerCache.

Answer is the DeleteSettingsScannerCacheAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteSettingsScannerCacheResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteSettingsScannerCacheResponse) Record ¶

Record is the DeleteSettingsScannerCacheAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteSettingsScannerOptions ¶

type DeleteSettingsScannerOptions struct {
	// Must be true to actually perform the removal (required)
	RemoveImages *bool

	// Which scanner image to remove (grype or trivy); omit to remove both
	Scanner Scanner

	// Environment id whose scanner images should be removed (required) (from GET /api/environments)
	Env EnvironmentID
}

DeleteSettingsScannerOptions holds the query and header parameters of DeleteSettingsScanner.

func (DeleteSettingsScannerOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteSettingsScannerOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteSettingsScannerResponse ¶

type DeleteSettingsScannerResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteSettingsScannerAnswer
	*DeleteSettingsScannerAnswer
}

DeleteSettingsScannerResponse is the result of DeleteSettingsScanner.

Answer is the DeleteSettingsScannerAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteSettingsScannerResponse) Answered ¶

func (r DeleteSettingsScannerResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteSettingsScannerResponse) Record ¶

Record is the DeleteSettingsScannerAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteStacksByNameAnswer ¶

type DeleteStacksByNameAnswer struct {
	Success bool `json:"success"`
}

DeleteStacksByNameAnswer is an object the document declares inline.

type DeleteStacksByNameDeploysByRunIdAnswer ¶

type DeleteStacksByNameDeploysByRunIdAnswer struct {
	Success bool `json:"success"`
}

DeleteStacksByNameDeploysByRunIdAnswer is an object the document declares inline.

type DeleteStacksByNameDeploysByRunIdResponse ¶

type DeleteStacksByNameDeploysByRunIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteStacksByNameDeploysByRunIdAnswer
	*DeleteStacksByNameDeploysByRunIdAnswer
}

DeleteStacksByNameDeploysByRunIdResponse is the result of DeleteStacksByNameDeploysByRunId.

Answer is the DeleteStacksByNameDeploysByRunIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteStacksByNameDeploysByRunIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteStacksByNameDeploysByRunIdResponse) Record ¶

Record is the DeleteStacksByNameDeploysByRunIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteStacksByNameIconAnswer ¶

type DeleteStacksByNameIconAnswer struct {
	Success bool `json:"success"`
}

DeleteStacksByNameIconAnswer is an object the document declares inline.

type DeleteStacksByNameIconOptions ¶

type DeleteStacksByNameIconOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID
}

DeleteStacksByNameIconOptions holds the query and header parameters of DeleteStacksByNameIcon.

func (DeleteStacksByNameIconOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteStacksByNameIconOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteStacksByNameIconResponse ¶

type DeleteStacksByNameIconResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteStacksByNameIconAnswer
	*DeleteStacksByNameIconAnswer
}

DeleteStacksByNameIconResponse is the result of DeleteStacksByNameIcon.

Answer is the DeleteStacksByNameIconAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteStacksByNameIconResponse) Answered ¶

func (r DeleteStacksByNameIconResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteStacksByNameIconResponse) Record ¶

Record is the DeleteStacksByNameIconAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteStacksByNameOptions ¶

type DeleteStacksByNameOptions struct {
	// Environment id (from GET /api/environments)
	Env EnvironmentID

	// Force removal even if the compose down step fails
	Force *bool

	// Also remove named volumes (docker compose down --volumes)
	Volumes *bool

	// Delete the stack's on-disk files/directory too (default true; pass files=false to keep them on disk)
	Files *bool
}

DeleteStacksByNameOptions holds the query and header parameters of DeleteStacksByName.

func (DeleteStacksByNameOptions) ToHeaders ¶

func (o DeleteStacksByNameOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteStacksByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteStacksByNameResponse ¶

type DeleteStacksByNameResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteStacksByNameAnswer
	*DeleteStacksByNameAnswer
}

DeleteStacksByNameResponse is the result of DeleteStacksByName.

Answer is the DeleteStacksByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteStacksByNameResponse) Answered ¶

func (r DeleteStacksByNameResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteStacksByNameResponse) Record ¶

Record is the DeleteStacksByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteTagsByIdAnswer ¶

type DeleteTagsByIdAnswer struct {
	Success bool `json:"success"`
}

DeleteTagsByIdAnswer is an object the document declares inline.

type DeleteTagsByIdResponse ¶

type DeleteTagsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteTagsByIdAnswer
	*DeleteTagsByIdAnswer
}

DeleteTagsByIdResponse is the result of DeleteTagsById.

Answer is the DeleteTagsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteTagsByIdResponse) Answered ¶

func (r DeleteTagsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteTagsByIdResponse) Record ¶

Record is the DeleteTagsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteTemplatesSourcesAnswer ¶

type DeleteTemplatesSourcesAnswer struct {
	Ok bool `json:"ok"`
}

DeleteTemplatesSourcesAnswer is an object the document declares inline.

type DeleteTemplatesSourcesOptions ¶

type DeleteTemplatesSourcesOptions struct {
	// ID of the template source to delete (from GET /api/templates/sources)
	Id *int
}

DeleteTemplatesSourcesOptions holds the query and header parameters of DeleteTemplatesSources.

func (DeleteTemplatesSourcesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (DeleteTemplatesSourcesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteTemplatesSourcesResponse ¶

type DeleteTemplatesSourcesResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteTemplatesSourcesAnswer
	*DeleteTemplatesSourcesAnswer
}

DeleteTemplatesSourcesResponse is the result of DeleteTemplatesSources.

Answer is the DeleteTemplatesSourcesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteTemplatesSourcesResponse) Answered ¶

func (r DeleteTemplatesSourcesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteTemplatesSourcesResponse) Record ¶

Record is the DeleteTemplatesSourcesAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteUsersByIdAnswer ¶

type DeleteUsersByIdAnswer struct {
	AuthDisabled bool `json:"authDisabled"`
	Success      bool `json:"success"`
}

DeleteUsersByIdAnswer is an object the document declares inline.

type DeleteUsersByIdMfaResponse ¶

type DeleteUsersByIdMfaResponse struct {
	HttpResponse *http.Response
}

DeleteUsersByIdMfaResponse is the result of DeleteUsersByIdMfa.

type DeleteUsersByIdOptions ¶

type DeleteUsersByIdOptions struct {
	// Set to true to confirm deleting the last admin (which disables authentication)
	ConfirmDisableAuth *bool
}

DeleteUsersByIdOptions holds the query and header parameters of DeleteUsersById.

func (DeleteUsersByIdOptions) ToHeaders ¶

func (o DeleteUsersByIdOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteUsersByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteUsersByIdResponse ¶

type DeleteUsersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteUsersByIdAnswer
	*DeleteUsersByIdAnswer
}

DeleteUsersByIdResponse is the result of DeleteUsersById.

Answer is the DeleteUsersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteUsersByIdResponse) Answered ¶

func (r DeleteUsersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteUsersByIdResponse) Record ¶

Record is the DeleteUsersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteUsersByIdRolesAnswer ¶

type DeleteUsersByIdRolesAnswer struct {
	Success bool `json:"success"`
}

DeleteUsersByIdRolesAnswer is an object the document declares inline.

type DeleteUsersByIdRolesRequest ¶

type DeleteUsersByIdRolesRequest struct {
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	RoleId        RoleID        `json:"roleId"`
}

DeleteUsersByIdRolesRequest is an object the document declares inline.

type DeleteUsersByIdRolesResponse ¶

type DeleteUsersByIdRolesResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteUsersByIdRolesAnswer
	*DeleteUsersByIdRolesAnswer
}

DeleteUsersByIdRolesResponse is the result of DeleteUsersByIdRoles.

Answer is the DeleteUsersByIdRolesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteUsersByIdRolesResponse) Answered ¶

func (r DeleteUsersByIdRolesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteUsersByIdRolesResponse) Record ¶

Record is the DeleteUsersByIdRolesAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeleteVolumesByNameAnswer ¶

type DeleteVolumesByNameAnswer struct {
	Success bool `json:"success"`
}

DeleteVolumesByNameAnswer is an object the document declares inline.

type DeleteVolumesByNameOptions ¶

type DeleteVolumesByNameOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID

	// Force removal of the volume
	Force *bool
}

DeleteVolumesByNameOptions holds the query and header parameters of DeleteVolumesByName.

func (DeleteVolumesByNameOptions) ToHeaders ¶

func (o DeleteVolumesByNameOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (DeleteVolumesByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type DeleteVolumesByNameResponse ¶

type DeleteVolumesByNameResponse struct {
	HttpResponse *http.Response
	Answer       *DeleteVolumesByNameAnswer
	*DeleteVolumesByNameAnswer
}

DeleteVolumesByNameResponse is the result of DeleteVolumesByName.

Answer is the DeleteVolumesByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (DeleteVolumesByNameResponse) Answered ¶

func (r DeleteVolumesByNameResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (DeleteVolumesByNameResponse) Record ¶

Record is the DeleteVolumesByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type DeployStatus ¶

type DeployStatus string

DeployStatus is the "DeployStatus" enum.

const (
	DeployStatusRunning DeployStatus = "running"
	DeployStatusSuccess DeployStatus = "success"
	DeployStatusFailed  DeployStatus = "failed"
)

Values of DeployStatus.

func (DeployStatus) Known ¶

func (v DeployStatus) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type DiskWarningMode ¶

type DiskWarningMode string

DiskWarningMode is the "DiskWarningMode" enum.

const (
	DiskWarningModePercentage DiskWarningMode = "percentage"
	DiskWarningModeAbsolute   DiskWarningMode = "absolute"
)

Values of DiskWarningMode.

func (DiskWarningMode) Known ¶

func (v DiskWarningMode) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type EnvironmentID ¶

type EnvironmentID int

EnvironmentID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and EnvironmentID(n) convert one value, client.IDs a list.

type EnvironmentProtocol ¶

type EnvironmentProtocol string

EnvironmentProtocol is the "EnvironmentProtocol" enum.

const (
	EnvironmentProtocolHttp  EnvironmentProtocol = "http"
	EnvironmentProtocolHttps EnvironmentProtocol = "https"
)

Values of EnvironmentProtocol.

func (EnvironmentProtocol) Known ¶

func (v EnvironmentProtocol) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type EventScope ¶

type EventScope string

EventScope is the "EventScope" enum.

const (
	EventScopeEnvironment EventScope = "environment"
	EventScopeSystem      EventScope = "system"
)

Values of EventScope.

func (EventScope) Known ¶

func (v EventScope) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type FileType ¶

type FileType string

FileType is the "FileType" enum.

const (
	FileTypeFile      FileType = "file"
	FileTypeDirectory FileType = "directory"
	FileTypeSymlink   FileType = "symlink"
	FileTypeOther     FileType = "other"
)

Values of FileType.

func (FileType) Known ¶

func (v FileType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type GetActivityAnswer ¶

type GetActivityAnswer struct {
	Events []GetActivityAnswerEvents `json:"events,omitzero"`
	Limit  int                       `json:"limit"`
	Offset int                       `json:"offset"`
	Total  int                       `json:"total"`
}

GetActivityAnswer is an object the document declares inline.

type GetActivityAnswerEvents ¶

type GetActivityAnswerEvents struct {
	// what the container did, in Docker's word: create, start, die, kill, stop, restart, destroy, pause, unpause, rename, update, oom, or health_status: healthy and health_status: unhealthy
	Action string `json:"action,omitempty"`

	// what Docker said of the event: the container's labels, and by kind exitCode for a death, signal for a kill and oldName for a rename, each as text
	ActorAttributes map[string]string `json:"actorAttributes,omitzero"`
	ContainerId     string            `json:"containerId,omitempty"`
	ContainerName   string            `json:"containerName,omitempty"`
	CreatedAt       Time              `json:"createdAt,omitzero"`
	EnvironmentIcon string            `json:"environmentIcon,omitempty"`
	EnvironmentId   EnvironmentID     `json:"environmentId,omitempty"`
	EnvironmentName string            `json:"environmentName,omitempty"`
	Id              int               `json:"id"`
	Image           string            `json:"image,omitempty"`
	Timestamp       Time              `json:"timestamp,omitzero"`
}

GetActivityAnswerEvents is an object the document declares inline.

type GetActivityContainersOptions ¶

type GetActivityContainersOptions struct {
	// Filter to a single environment (from GET /api/environments)
	EnvironmentId EnvironmentID
}

GetActivityContainersOptions holds the query and header parameters of GetActivityContainers.

func (GetActivityContainersOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetActivityContainersOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetActivityContainersResponse ¶

type GetActivityContainersResponse struct {
	HttpResponse *http.Response
	Answer       []string
}

GetActivityContainersResponse is the result of GetActivityContainers.

func (GetActivityContainersResponse) Answered ¶

func (r GetActivityContainersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetActivityEventsResponse ¶

type GetActivityEventsResponse struct {
	HttpResponse *http.Response
}

GetActivityEventsResponse is the result of GetActivityEvents.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetActivityEventsResponse) ContentLength ¶

func (r GetActivityEventsResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetActivityEventsResponse) Filename ¶

func (r GetActivityEventsResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetActivityEventsResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetActivityOptions ¶

type GetActivityOptions struct {
	// Filter to a single environment (from GET /api/environments)
	EnvironmentId EnvironmentID

	// Filter by container ID (from GET /api/containers)
	ContainerId string

	// Filter by container name
	ContainerName string

	// Comma-separated event actions to filter by
	Actions string

	// Comma-separated labels to filter by
	Labels string

	// Start of the date range (ISO 8601)
	FromDate string

	// End of the date range (ISO 8601)
	ToDate string

	// Maximum number of events to return
	Limit *int

	// Number of events to skip (pagination)
	Offset *int
}

GetActivityOptions holds the query and header parameters of GetActivity.

func (GetActivityOptions) ToHeaders ¶

func (o GetActivityOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetActivityOptions) ToQuery ¶

func (o GetActivityOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetActivityResponse ¶

type GetActivityResponse struct {
	HttpResponse *http.Response
	Answer       *GetActivityAnswer
	*GetActivityAnswer
}

GetActivityResponse is the result of GetActivity.

Answer is the GetActivityAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetActivityResponse) Answered ¶

func (r GetActivityResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetActivityResponse) Record ¶

Record is the GetActivityAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetActivityStatsAnswer ¶

type GetActivityStatsAnswer struct {
	// how many events of each action the log holds
	ByAction map[string]int `json:"byAction,omitzero"`
	Today    int            `json:"today"`
	Total    int            `json:"total"`
}

GetActivityStatsAnswer is an object the document declares inline.

type GetActivityStatsOptions ¶

type GetActivityStatsOptions struct {
	// Filter to a single environment (from GET /api/environments)
	EnvironmentId EnvironmentID
}

GetActivityStatsOptions holds the query and header parameters of GetActivityStats.

func (GetActivityStatsOptions) ToHeaders ¶

func (o GetActivityStatsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetActivityStatsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetActivityStatsResponse ¶

type GetActivityStatsResponse struct {
	HttpResponse *http.Response
	Answer       *GetActivityStatsAnswer
	*GetActivityStatsAnswer
}

GetActivityStatsResponse is the result of GetActivityStats.

Answer is the GetActivityStatsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetActivityStatsResponse) Answered ¶

func (r GetActivityStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetActivityStatsResponse) Record ¶

Record is the GetActivityStatsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuditAnswer ¶

type GetAuditAnswer struct {
	Logs  []GetAuditAnswerLogs `json:"logs,omitzero"`
	Total int                  `json:"total,omitempty"`
}

GetAuditAnswer is an object the document declares inline.

type GetAuditAnswerLogs ¶

type GetAuditAnswerLogs struct {
	Action     string `json:"action,omitempty"`
	CreatedAt  Time   `json:"createdAt,omitzero"`
	EntityName string `json:"entityName,omitempty"`
	EntityType string `json:"entityType,omitempty"`
	Id         int    `json:"id"`
	Username   string `json:"username,omitempty"`
}

GetAuditAnswerLogs is an object the document declares inline.

type GetAuditEventsResponse ¶

type GetAuditEventsResponse struct {
	HttpResponse *http.Response
}

GetAuditEventsResponse is the result of GetAuditEvents.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetAuditEventsResponse) ContentLength ¶

func (r GetAuditEventsResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetAuditEventsResponse) Filename ¶

func (r GetAuditEventsResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetAuditEventsResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetAuditExportOptions ¶

type GetAuditExportOptions struct {
	// Filter by username
	Username string

	// Filter by entity type
	EntityType string

	// Filter by action
	Action string

	// Filter to a single environment (from GET /api/environments)
	EnvironmentId EnvironmentID

	// Start of the date range (ISO 8601)
	FromDate string

	// End of the date range (ISO 8601)
	ToDate string

	// Output format — json (default), csv or md
	Format string
}

GetAuditExportOptions holds the query and header parameters of GetAuditExport.

func (GetAuditExportOptions) ToHeaders ¶

func (o GetAuditExportOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetAuditExportOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetAuditExportResponse ¶

type GetAuditExportResponse struct {
	HttpResponse *http.Response
}

GetAuditExportResponse is the result of GetAuditExport.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetAuditExportResponse) Bytes ¶

func (r GetAuditExportResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetAuditExportResponse) ContentLength ¶

func (r GetAuditExportResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetAuditExportResponse) Filename ¶

func (r GetAuditExportResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetAuditExportResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetAuditExportResponse) WriteTo ¶

func (r GetAuditExportResponse) WriteTo(w io.Writer) (int64, error)

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetAuditOptions ¶

type GetAuditOptions struct {
	// Comma-separated usernames to filter by
	Usernames string

	// Comma-separated entity types to filter by
	EntityTypes string

	// Comma-separated actions to filter by
	Actions string

	// Legacy single-username filter
	Username string

	// Legacy single entity-type filter
	EntityType string

	// Legacy single-action filter
	Action string

	// Filter to a single environment (from GET /api/environments)
	EnvironmentId EnvironmentID

	// Comma-separated labels to filter by
	Labels string

	// Start of the date range (ISO 8601)
	FromDate string

	// End of the date range (ISO 8601)
	ToDate string

	// Maximum number of entries to return
	Limit *int

	// Number of entries to skip (pagination)
	Offset *int
}

GetAuditOptions holds the query and header parameters of GetAudit.

func (GetAuditOptions) ToHeaders ¶

func (o GetAuditOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetAuditOptions) ToQuery ¶

func (o GetAuditOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetAuditOutsideApiAnswer ¶

type GetAuditOutsideApiAnswer struct {
	Limit  int                            `json:"limit"`
	Logs   []GetAuditOutsideApiAnswerLogs `json:"logs"`
	Offset int                            `json:"offset"`
	Total  int                            `json:"total"`
}

GetAuditOutsideApiAnswer is an object the document declares inline.

type GetAuditOutsideApiAnswerLogs ¶

type GetAuditOutsideApiAnswerLogs struct {
	Action        string         `json:"action"`
	CreatedAt     Time           `json:"createdAt"`
	Description   string         `json:"description,omitempty"`
	Details       map[string]any `json:"details,omitzero"`
	EntityId      string         `json:"entityId,omitempty"`
	EntityName    string         `json:"entityName,omitempty"`
	EntityType    string         `json:"entityType"`
	EnvironmentId EnvironmentID  `json:"environmentId,omitempty"`
	Id            int            `json:"id"`
	IpAddress     string         `json:"ipAddress,omitempty"`
	UserAgent     string         `json:"userAgent,omitempty"`
	UserId        UserID         `json:"userId,omitempty"`
	Username      string         `json:"username"`
}

GetAuditOutsideApiAnswerLogs is an object the document declares inline.

type GetAuditOutsideApiOptions ¶

type GetAuditOutsideApiOptions struct {
	Username      string
	EntityType    string
	Action        string
	EnvironmentId EnvironmentID
	FromDate      string
	ToDate        string
	Limit         *int
	Offset        *int
}

GetAuditOutsideApiOptions holds the query and header parameters of GetAuditOutsideApi.

func (GetAuditOutsideApiOptions) ToHeaders ¶

func (o GetAuditOutsideApiOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetAuditOutsideApiOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetAuditOutsideApiResponse ¶

type GetAuditOutsideApiResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuditOutsideApiAnswer
	*GetAuditOutsideApiAnswer
}

GetAuditOutsideApiResponse is the result of GetAuditOutsideApi.

Answer is the GetAuditOutsideApiAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuditOutsideApiResponse) Answered ¶

func (r GetAuditOutsideApiResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuditOutsideApiResponse) Record ¶

Record is the GetAuditOutsideApiAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuditResponse ¶

type GetAuditResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuditAnswer
	*GetAuditAnswer
}

GetAuditResponse is the result of GetAudit.

Answer is the GetAuditAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuditResponse) Answered ¶

func (r GetAuditResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuditResponse) Record ¶

func (r GetAuditResponse) Record() (GetAuditAnswer, error)

Record is the GetAuditAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuditUsersOutsideApiResponse ¶

type GetAuditUsersOutsideApiResponse struct {
	HttpResponse *http.Response
	Answer       []string
}

GetAuditUsersOutsideApiResponse is the result of GetAuditUsersOutsideApi.

func (GetAuditUsersOutsideApiResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetAuditUsersResponse ¶

type GetAuditUsersResponse struct {
	HttpResponse *http.Response
	Answer       []string
}

GetAuditUsersResponse is the result of GetAuditUsers.

func (GetAuditUsersResponse) Answered ¶

func (r GetAuditUsersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetAuthLdapAnswer ¶

type GetAuthLdapAnswer struct {
	BaseDn    string `json:"baseDn"`
	Enabled   bool   `json:"enabled"`
	Id        int    `json:"id"`
	Name      string `json:"name"`
	ServerUrl string `json:"serverUrl"`
}

GetAuthLdapAnswer is an object the document declares inline.

func (GetAuthLdapAnswer) GetId ¶

func (m GetAuthLdapAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetAuthLdapAnswer) GetName ¶

func (m GetAuthLdapAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetAuthLdapByIdAnswer ¶

type GetAuthLdapByIdAnswer struct {
	BaseDn    string `json:"baseDn"`
	Enabled   bool   `json:"enabled"`
	Id        int    `json:"id"`
	Name      string `json:"name"`
	ServerUrl string `json:"serverUrl"`
}

GetAuthLdapByIdAnswer is an object the document declares inline.

func (GetAuthLdapByIdAnswer) GetId ¶

func (m GetAuthLdapByIdAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetAuthLdapByIdAnswer) GetName ¶

func (m GetAuthLdapByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetAuthLdapByIdResponse ¶

type GetAuthLdapByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuthLdapByIdAnswer
	*GetAuthLdapByIdAnswer
}

GetAuthLdapByIdResponse is the result of GetAuthLdapById.

Answer is the GetAuthLdapByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuthLdapByIdResponse) Answered ¶

func (r GetAuthLdapByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuthLdapByIdResponse) Record ¶

Record is the GetAuthLdapByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuthLdapResponse ¶

type GetAuthLdapResponse struct {
	HttpResponse *http.Response
	Answer       []GetAuthLdapAnswer
}

GetAuthLdapResponse is the result of GetAuthLdap.

func (GetAuthLdapResponse) Answered ¶

func (r GetAuthLdapResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetAuthOidcAnswer ¶

type GetAuthOidcAnswer struct {
	// the claim named for an administrator, with adminValue; null when none is set
	AdminClaim string `json:"adminClaim,omitempty"`
	AdminValue string `json:"adminValue,omitempty"`
	ClientId   string `json:"clientId"`

	// eight asterisks, never the secret
	ClientSecret      string `json:"clientSecret,omitempty"`
	CreatedAt         Time   `json:"createdAt,omitzero"`
	DisplayNameClaim  string `json:"displayNameClaim,omitempty"`
	EmailClaim        string `json:"emailClaim,omitempty"`
	Enabled           bool   `json:"enabled"`
	Id                int    `json:"id"`
	IssuerUrl         string `json:"issuerUrl"`
	Name              string `json:"name"`
	RedirectUri       string `json:"redirectUri,omitempty"`
	RoleMappingsClaim string `json:"roleMappingsClaim,omitempty"`

	// the scopes named, with spaces between: openid profile email unless given
	Scopes        string `json:"scopes,omitempty"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
	UsernameClaim string `json:"usernameClaim,omitempty"`
}

GetAuthOidcAnswer is an object the document declares inline.

func (GetAuthOidcAnswer) GetId ¶

func (m GetAuthOidcAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetAuthOidcAnswer) GetName ¶

func (m GetAuthOidcAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetAuthOidcByIdAnswer ¶

type GetAuthOidcByIdAnswer struct {
	// the claim named for an administrator, with adminValue; null when none is set
	AdminClaim string `json:"adminClaim,omitempty"`
	AdminValue string `json:"adminValue,omitempty"`
	ClientId   string `json:"clientId"`

	// eight asterisks, never the secret
	ClientSecret      string `json:"clientSecret,omitempty"`
	CreatedAt         Time   `json:"createdAt,omitzero"`
	DisplayNameClaim  string `json:"displayNameClaim,omitempty"`
	EmailClaim        string `json:"emailClaim,omitempty"`
	Enabled           bool   `json:"enabled"`
	Id                int    `json:"id"`
	IssuerUrl         string `json:"issuerUrl"`
	Name              string `json:"name"`
	RedirectUri       string `json:"redirectUri,omitempty"`
	RoleMappingsClaim string `json:"roleMappingsClaim,omitempty"`

	// the scopes named, with spaces between: openid profile email unless given
	Scopes        string `json:"scopes,omitempty"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
	UsernameClaim string `json:"usernameClaim,omitempty"`
}

GetAuthOidcByIdAnswer is an object the document declares inline.

func (GetAuthOidcByIdAnswer) GetId ¶

func (m GetAuthOidcByIdAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetAuthOidcByIdAnswer) GetName ¶

func (m GetAuthOidcByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetAuthOidcByIdInitiateOptions ¶

type GetAuthOidcByIdInitiateOptions struct {
	// Post-login destination path to return to (defaults to /)
	Redirect string
}

GetAuthOidcByIdInitiateOptions holds the query and header parameters of GetAuthOidcByIdInitiate.

func (GetAuthOidcByIdInitiateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetAuthOidcByIdInitiateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetAuthOidcByIdInitiateResponse ¶

type GetAuthOidcByIdInitiateResponse struct {
	HttpResponse *http.Response
}

GetAuthOidcByIdInitiateResponse is the result of GetAuthOidcByIdInitiate.

type GetAuthOidcByIdResponse ¶

type GetAuthOidcByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuthOidcByIdAnswer
	*GetAuthOidcByIdAnswer
}

GetAuthOidcByIdResponse is the result of GetAuthOidcById.

Answer is the GetAuthOidcByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuthOidcByIdResponse) Answered ¶

func (r GetAuthOidcByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuthOidcByIdResponse) Record ¶

Record is the GetAuthOidcByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuthOidcCallbackOptions ¶

type GetAuthOidcCallbackOptions struct {
	// Authorization code returned by the IdP
	Code string

	// Opaque state value used to correlate the request and carry the post-login redirect
	State string

	// Error code returned by the IdP when authentication failed
	Error string

	// Human-readable error detail returned by the IdP
	ErrorDescription string
}

GetAuthOidcCallbackOptions holds the query and header parameters of GetAuthOidcCallback.

func (GetAuthOidcCallbackOptions) ToHeaders ¶

func (o GetAuthOidcCallbackOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetAuthOidcCallbackOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetAuthOidcCallbackResponse ¶

type GetAuthOidcCallbackResponse struct {
	HttpResponse *http.Response
}

GetAuthOidcCallbackResponse is the result of GetAuthOidcCallback.

type GetAuthOidcResponse ¶

type GetAuthOidcResponse struct {
	HttpResponse *http.Response
	Answer       []GetAuthOidcAnswer
}

GetAuthOidcResponse is the result of GetAuthOidc.

func (GetAuthOidcResponse) Answered ¶

func (r GetAuthOidcResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetAuthProvidersAnswer ¶

type GetAuthProvidersAnswer struct {
	AutoLoginUrl    string                            `json:"autoLoginUrl,omitempty"`
	DefaultProvider string                            `json:"defaultProvider,omitempty"`
	Providers       []GetAuthProvidersAnswerProviders `json:"providers,omitzero"`
}

GetAuthProvidersAnswer is an object the document declares inline.

type GetAuthProvidersAnswerProviders ¶

type GetAuthProvidersAnswerProviders struct {
	Id          string     `json:"id"`
	InitiateUrl string     `json:"initiateUrl,omitempty"`
	Name        string     `json:"name"`
	Type        SignInType `json:"type"`
}

GetAuthProvidersAnswerProviders is an object the document declares inline.

func (GetAuthProvidersAnswerProviders) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetAuthProvidersAnswerProviders) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetAuthProvidersResponse ¶

type GetAuthProvidersResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuthProvidersAnswer
	*GetAuthProvidersAnswer
}

GetAuthProvidersResponse is the result of GetAuthProviders.

Answer is the GetAuthProvidersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuthProvidersResponse) Answered ¶

func (r GetAuthProvidersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuthProvidersResponse) Record ¶

Record is the GetAuthProvidersAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuthSessionAnswer ¶

type GetAuthSessionAnswer struct {
	AuthEnabled   bool                      `json:"authEnabled"`
	Authenticated bool                      `json:"authenticated"`
	User          *GetAuthSessionAnswerUser `json:"user,omitempty"`
}

GetAuthSessionAnswer is an object the document declares inline.

type GetAuthSessionAnswerUser ¶

type GetAuthSessionAnswerUser struct {
	Avatar      string `json:"avatar,omitempty"`
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Id          UserID `json:"id,omitempty"`
	IsAdmin     bool   `json:"isAdmin"`
	Provider    string `json:"provider,omitempty"`
	Username    string `json:"username,omitempty"`
}

GetAuthSessionAnswerUser is an object the document declares inline.

type GetAuthSessionResponse ¶

type GetAuthSessionResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuthSessionAnswer
	*GetAuthSessionAnswer
}

GetAuthSessionResponse is the result of GetAuthSession.

Answer is the GetAuthSessionAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuthSessionResponse) Answered ¶

func (r GetAuthSessionResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuthSessionResponse) Record ¶

Record is the GetAuthSessionAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuthSettingsAnswer ¶

type GetAuthSettingsAnswer struct {
	AuthEnabled     bool   `json:"authEnabled"`
	CreatedAt       Time   `json:"createdAt,omitzero"`
	DefaultProvider string `json:"defaultProvider,omitempty"`
	Id              int    `json:"id,omitempty"`

	// how long a session lasts, in seconds: from 3600 to 604800 whatever was asked for, or 0 for one that never ends
	SessionTimeout int  `json:"sessionTimeout,omitempty"`
	UpdatedAt      Time `json:"updatedAt,omitzero"`
}

GetAuthSettingsAnswer is an object the document declares inline.

type GetAuthSettingsResponse ¶

type GetAuthSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *GetAuthSettingsAnswer
	*GetAuthSettingsAnswer
}

GetAuthSettingsResponse is the result of GetAuthSettings.

Answer is the GetAuthSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAuthSettingsResponse) Answered ¶

func (r GetAuthSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAuthSettingsResponse) Record ¶

Record is the GetAuthSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAuthTokensAnswer ¶

type GetAuthTokensAnswer struct {
	CreatedAt   Time   `json:"createdAt"`
	ExpiresAt   Time   `json:"expiresAt,omitzero"`
	Id          int    `json:"id"`
	LastUsed    Time   `json:"lastUsed,omitzero"`
	Name        string `json:"name"`
	TokenPrefix string `json:"tokenPrefix"`
}

GetAuthTokensAnswer is an object the document declares inline.

func (GetAuthTokensAnswer) GetId ¶

func (m GetAuthTokensAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetAuthTokensAnswer) GetName ¶

func (m GetAuthTokensAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetAuthTokensResponse ¶

type GetAuthTokensResponse struct {
	HttpResponse *http.Response
	Answer       []GetAuthTokensAnswer
}

GetAuthTokensResponse is the result of GetAuthTokens.

func (GetAuthTokensResponse) Answered ¶

func (r GetAuthTokensResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetAutoUpdateAnswer ¶

type GetAutoUpdateAnswer struct {
	// when the container is checked and updated, as five cron fields; nothing when it was saved without one, and then it never runs
	CronExpression string `json:"cronExpression,omitempty"`
	Enabled        bool   `json:"enabled"`

	// what Dockhand makes of the cron expression: daily, weekly or custom
	ScheduleType string `json:"scheduleType,omitempty"`

	// what a scan of the new image may find before the update is held back: never holds none back
	VulnerabilityCriteria string `json:"vulnerabilityCriteria,omitempty"`
}

GetAutoUpdateAnswer is an object the document declares inline.

type GetAutoUpdateByContainerNameAnswer ¶

type GetAutoUpdateByContainerNameAnswer struct {
	ContainerName         string        `json:"containerName,omitempty"`
	CreatedAt             Time          `json:"createdAt,omitzero"`
	CronExpression        string        `json:"cronExpression,omitempty"`
	Enabled               bool          `json:"enabled"`
	EnvironmentId         EnvironmentID `json:"environmentId,omitempty"`
	Id                    int           `json:"id,omitempty"`
	LastChecked           Time          `json:"lastChecked,omitzero"`
	LastUpdated           Time          `json:"lastUpdated,omitzero"`
	ScheduleType          string        `json:"scheduleType,omitempty"`
	UpdatedAt             Time          `json:"updatedAt,omitzero"`
	VulnerabilityCriteria string        `json:"vulnerabilityCriteria,omitempty"`
}

GetAutoUpdateByContainerNameAnswer is an object the document declares inline.

type GetAutoUpdateByContainerNameOptions ¶

type GetAutoUpdateByContainerNameOptions struct {
	// Environment the container belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetAutoUpdateByContainerNameOptions holds the query and header parameters of GetAutoUpdateByContainerName.

func (GetAutoUpdateByContainerNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetAutoUpdateByContainerNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetAutoUpdateByContainerNameResponse ¶

type GetAutoUpdateByContainerNameResponse struct {
	HttpResponse *http.Response
	Answer       *GetAutoUpdateByContainerNameAnswer
	*GetAutoUpdateByContainerNameAnswer
}

GetAutoUpdateByContainerNameResponse is the result of GetAutoUpdateByContainerName.

Answer is the GetAutoUpdateByContainerNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetAutoUpdateByContainerNameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetAutoUpdateByContainerNameResponse) Record ¶

Record is the GetAutoUpdateByContainerNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetAutoUpdateOptions ¶

type GetAutoUpdateOptions struct {
	// Environment ID to read settings for (from GET /api/environments)
	Env EnvironmentID
}

GetAutoUpdateOptions holds the query and header parameters of GetAutoUpdate.

func (GetAutoUpdateOptions) ToHeaders ¶

func (o GetAutoUpdateOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetAutoUpdateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetAutoUpdateResponse ¶

type GetAutoUpdateResponse struct {
	HttpResponse *http.Response
	Answer       map[string]GetAutoUpdateAnswer
}

GetAutoUpdateResponse is the result of GetAutoUpdate.

func (GetAutoUpdateResponse) Answered ¶

func (r GetAutoUpdateResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetBackupConfigsAnswer ¶ added in v0.2.0

type GetBackupConfigsAnswer struct {
	AllVolumes    bool                `json:"allVolumes"`
	CreatedAt     Time                `json:"createdAt,omitzero"`
	DestinationId BackupDestinationID `json:"destinationId,omitempty"`
	Enabled       bool                `json:"enabled"`

	// the environment the container or stack is on; null for one saved with none, which cannot be run
	EnvironmentId EnvironmentID  `json:"environmentId,omitempty"`
	Id            BackupConfigID `json:"id,omitempty"`
	LastBackupAt  Time           `json:"lastBackupAt,omitzero"`

	// success, warning, skipped or failed; null for one never run
	LastBackupStatus string `json:"lastBackupStatus,omitempty"`

	// more of how it is backed up, as JSON written out as text; null for none
	Options string `json:"options,omitempty"`

	// how many snapshots are kept, as JSON written out as text: keepLast, keepDaily, keepWeekly, keepMonthly, keepYearly; null to keep every one
	Retention string `json:"retention,omitempty"`

	// when it runs by itself, as cron; null or empty for one that only runs when asked
	Schedule string `json:"schedule,omitempty"`

	// the volumes to back up when not all of them, as a JSON list written out as text; null for none
	SelectedVolumes  string `json:"selectedVolumes,omitempty"`
	StopBeforeBackup bool   `json:"stopBeforeBackup"`

	// as a JSON list written out as text; null for none
	Tags       string `json:"tags,omitempty"`
	TargetName string `json:"targetName,omitempty"`

	// container or stack, as it was given: any other word is kept and then backs up nothing
	Type      string `json:"type,omitempty"`
	UpdatedAt Time   `json:"updatedAt,omitzero"`
}

GetBackupConfigsAnswer is an object the document declares inline.

type GetBackupConfigsByIdAnswer ¶ added in v0.2.0

type GetBackupConfigsByIdAnswer struct {
	AllVolumes    bool                `json:"allVolumes"`
	CreatedAt     Time                `json:"createdAt,omitzero"`
	DestinationId BackupDestinationID `json:"destinationId,omitempty"`
	Enabled       bool                `json:"enabled"`

	// the environment the container or stack is on; null for one saved with none, which cannot be run
	EnvironmentId EnvironmentID  `json:"environmentId,omitempty"`
	Id            BackupConfigID `json:"id,omitempty"`
	LastBackupAt  Time           `json:"lastBackupAt,omitzero"`

	// success, warning, skipped or failed; null for one never run
	LastBackupStatus string `json:"lastBackupStatus,omitempty"`

	// more of how it is backed up, as JSON written out as text; null for none
	Options string `json:"options,omitempty"`

	// how many snapshots are kept, as JSON written out as text: keepLast, keepDaily, keepWeekly, keepMonthly, keepYearly; null to keep every one
	Retention string `json:"retention,omitempty"`

	// when it runs by itself, as cron; null or empty for one that only runs when asked
	Schedule string `json:"schedule,omitempty"`

	// the volumes to back up when not all of them, as a JSON list written out as text; null for none
	SelectedVolumes  string `json:"selectedVolumes,omitempty"`
	StopBeforeBackup bool   `json:"stopBeforeBackup"`

	// as a JSON list written out as text; null for none
	Tags       string `json:"tags,omitempty"`
	TargetName string `json:"targetName,omitempty"`

	// container or stack, as it was given: any other word is kept and then backs up nothing
	Type      string `json:"type,omitempty"`
	UpdatedAt Time   `json:"updatedAt,omitzero"`
}

GetBackupConfigsByIdAnswer is an object the document declares inline.

type GetBackupConfigsByIdResponse ¶

type GetBackupConfigsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupConfigsByIdAnswer
	*GetBackupConfigsByIdAnswer
}

GetBackupConfigsByIdResponse is the result of GetBackupConfigsById.

Answer is the GetBackupConfigsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupConfigsByIdResponse) Answered ¶

func (r GetBackupConfigsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupConfigsByIdResponse) Record ¶ added in v0.2.0

Record is the GetBackupConfigsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupConfigsOptions ¶

type GetBackupConfigsOptions struct {
	// Filter by backup config type (e.g. "container", "stack")
	Type string

	// Filter by the backed-up target name (container or stack name)
	Target string

	// Filter by environment id (from GET /api/environments)
	Env EnvironmentID
}

GetBackupConfigsOptions holds the query and header parameters of GetBackupConfigs.

func (GetBackupConfigsOptions) ToHeaders ¶

func (o GetBackupConfigsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetBackupConfigsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupConfigsResponse ¶

type GetBackupConfigsResponse struct {
	HttpResponse *http.Response
	Answer       []GetBackupConfigsAnswer
}

GetBackupConfigsResponse is the result of GetBackupConfigs.

func (GetBackupConfigsResponse) Answered ¶

func (r GetBackupConfigsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetBackupDestinationsAnswer ¶ added in v0.2.0

type GetBackupDestinationsAnswer struct {
	// more that restic is given for a backup; left out of the list
	BackupFlags string `json:"backupFlags,omitempty"`
	CreatedAt   Time   `json:"createdAt,omitzero"`

	// what the store is signed in to with, by the names restic reads them under; sent where one destination is read, made or changed, and left out of the list
	EnvVars map[string]string `json:"envVars,omitzero"`

	// the flags of a backup and of a restore together, as JSON written out as text; null for none. Sent, it is taken as the flags of a backup
	Flags            string              `json:"flags,omitempty"`
	HasCacert        bool                `json:"hasCacert"`
	HasTlsClientCert bool                `json:"hasTlsClientCert"`
	HostPath         string              `json:"hostPath,omitempty"`
	Id               BackupDestinationID `json:"id,omitempty"`
	LastTestAt       Time                `json:"lastTestAt,omitzero"`
	LastTestError    string              `json:"lastTestError,omitempty"`

	// how the last try of it went: success, failed or needs_init; null for one never tried
	LastTestStatus string `json:"lastTestStatus,omitempty"`
	Name           string `json:"name,omitempty"`

	// how the store is looked after by itself, as JSON written out as text: whether and when it is pruned, checked and verified
	Policies string `json:"policies,omitempty"`

	// where the backups are kept, as restic names it: a folder's path, or an address that opens with rest:, s3:, b2:, azure: or gs:
	Repository string `json:"repository,omitempty"`

	// more that restic is given for a restore; left out of the list
	RestoreFlags string `json:"restoreFlags,omitempty"`
	UpdatedAt    Time   `json:"updatedAt,omitzero"`
}

GetBackupDestinationsAnswer is an object the document declares inline.

func (GetBackupDestinationsAnswer) GetId ¶ added in v0.2.0

GetId is the record's Id, for code that handles records of several types alike.

func (GetBackupDestinationsAnswer) GetName ¶ added in v0.2.0

func (m GetBackupDestinationsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetBackupDestinationsByIdAnswer ¶ added in v0.2.0

type GetBackupDestinationsByIdAnswer struct {
	// more that restic is given for a backup; left out of the list
	BackupFlags string `json:"backupFlags,omitempty"`
	CreatedAt   Time   `json:"createdAt,omitzero"`

	// what the store is signed in to with, by the names restic reads them under; sent where one destination is read, made or changed, and left out of the list
	EnvVars map[string]string `json:"envVars,omitzero"`

	// the flags of a backup and of a restore together, as JSON written out as text; null for none. Sent, it is taken as the flags of a backup
	Flags            string              `json:"flags,omitempty"`
	HasCacert        bool                `json:"hasCacert"`
	HasTlsClientCert bool                `json:"hasTlsClientCert"`
	HostPath         string              `json:"hostPath,omitempty"`
	Id               BackupDestinationID `json:"id,omitempty"`
	LastTestAt       Time                `json:"lastTestAt,omitzero"`
	LastTestError    string              `json:"lastTestError,omitempty"`

	// how the last try of it went: success, failed or needs_init; null for one never tried
	LastTestStatus string `json:"lastTestStatus,omitempty"`
	Name           string `json:"name,omitempty"`

	// how the store is looked after by itself, as JSON written out as text: whether and when it is pruned, checked and verified
	Policies string `json:"policies,omitempty"`

	// where the backups are kept, as restic names it: a folder's path, or an address that opens with rest:, s3:, b2:, azure: or gs:
	Repository string `json:"repository,omitempty"`

	// more that restic is given for a restore; left out of the list
	RestoreFlags string `json:"restoreFlags,omitempty"`
	UpdatedAt    Time   `json:"updatedAt,omitzero"`
}

GetBackupDestinationsByIdAnswer is an object the document declares inline.

func (GetBackupDestinationsByIdAnswer) GetId ¶ added in v0.2.0

GetId is the record's Id, for code that handles records of several types alike.

func (GetBackupDestinationsByIdAnswer) GetName ¶ added in v0.2.0

GetName is the record's Name, for code that handles records of several types alike.

type GetBackupDestinationsByIdResponse ¶

type GetBackupDestinationsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupDestinationsByIdAnswer
	*GetBackupDestinationsByIdAnswer
}

GetBackupDestinationsByIdResponse is the result of GetBackupDestinationsById.

Answer is the GetBackupDestinationsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupDestinationsByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupDestinationsByIdResponse) Record ¶ added in v0.2.0

Record is the GetBackupDestinationsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupDestinationsResponse ¶

type GetBackupDestinationsResponse struct {
	HttpResponse *http.Response
	Answer       []GetBackupDestinationsAnswer
}

GetBackupDestinationsResponse is the result of GetBackupDestinations.

func (GetBackupDestinationsResponse) Answered ¶

func (r GetBackupDestinationsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetBackupInstanceAnswer ¶

type GetBackupInstanceAnswer struct {
	InstanceId string `json:"instanceId"`
}

GetBackupInstanceAnswer is an object the document declares inline.

type GetBackupInstanceResponse ¶

type GetBackupInstanceResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupInstanceAnswer
	*GetBackupInstanceAnswer
}

GetBackupInstanceResponse is the result of GetBackupInstance.

Answer is the GetBackupInstanceAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupInstanceResponse) Answered ¶

func (r GetBackupInstanceResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupInstanceResponse) Record ¶

Record is the GetBackupInstanceAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupSnapshotsAnswer ¶ added in v0.2.0

type GetBackupSnapshotsAnswer struct {
	Hostname string   `json:"hostname,omitempty"`
	Id       string   `json:"id,omitempty"`
	Paths    []string `json:"paths,omitzero"`
	ShortId  string   `json:"shortId,omitempty"`

	// what Dockhand marked it with: its own instance, the configuration, the environment, container or stack, and the name
	Tags []string `json:"tags,omitzero"`

	// when it was taken, as restic writes it
	Time string `json:"time,omitempty"`
}

GetBackupSnapshotsAnswer is an object the document declares inline.

type GetBackupSnapshotsByIdBrowseAnswer ¶ added in v0.2.0

type GetBackupSnapshotsByIdBrowseAnswer struct {
	Entries []GetBackupSnapshotsByIdBrowseAnswerEntries `json:"entries,omitzero"`
	Error   string                                      `json:"error,omitempty"`
	Path    string                                      `json:"path,omitempty"`
}

GetBackupSnapshotsByIdBrowseAnswer is an object the document declares inline.

type GetBackupSnapshotsByIdBrowseAnswerEntries ¶ added in v0.2.0

type GetBackupSnapshotsByIdBrowseAnswerEntries struct {
	Atime       Time   `json:"atime,omitzero"`
	Ctime       Time   `json:"ctime,omitzero"`
	Gid         int    `json:"gid,omitempty"`
	Inode       int    `json:"inode,omitempty"`
	Mode        int    `json:"mode,omitempty"`
	Mtime       Time   `json:"mtime,omitzero"`
	Name        string `json:"name,omitempty"`
	Path        string `json:"path,omitempty"`
	Permissions string `json:"permissions,omitempty"`

	// bytes, for a file
	Size int `json:"size,omitempty"`

	// dir or file, in restic's words
	Type string `json:"type,omitempty"`
	Uid  int    `json:"uid,omitempty"`
}

GetBackupSnapshotsByIdBrowseAnswerEntries is an object the document declares inline.

type GetBackupSnapshotsByIdBrowseOptions ¶

type GetBackupSnapshotsByIdBrowseOptions struct {
	// Destination the snapshot lives in
	DestinationId BackupDestinationID

	// Directory path inside the snapshot to list
	Path string

	// Environment context for access checks
	Env EnvironmentID
}

GetBackupSnapshotsByIdBrowseOptions holds the query and header parameters of GetBackupSnapshotsByIdBrowse.

func (GetBackupSnapshotsByIdBrowseOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetBackupSnapshotsByIdBrowseOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupSnapshotsByIdBrowseResponse ¶

type GetBackupSnapshotsByIdBrowseResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupSnapshotsByIdBrowseAnswer
	*GetBackupSnapshotsByIdBrowseAnswer
}

GetBackupSnapshotsByIdBrowseResponse is the result of GetBackupSnapshotsByIdBrowse.

Answer is the GetBackupSnapshotsByIdBrowseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupSnapshotsByIdBrowseResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupSnapshotsByIdBrowseResponse) Record ¶ added in v0.2.0

Record is the GetBackupSnapshotsByIdBrowseAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupSnapshotsByIdDumpOptions ¶

type GetBackupSnapshotsByIdDumpOptions struct {
	// Destination the snapshot lives in
	DestinationId BackupDestinationID

	// Path inside the snapshot (must resolve under /volumes or /metadata)
	Path string

	// Payload kind (e.g. inline preview vs archive)
	Type string

	// When set, stream the file/directory as a tar
	Download string
}

GetBackupSnapshotsByIdDumpOptions holds the query and header parameters of GetBackupSnapshotsByIdDump.

func (GetBackupSnapshotsByIdDumpOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetBackupSnapshotsByIdDumpOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupSnapshotsByIdDumpResponse ¶

type GetBackupSnapshotsByIdDumpResponse struct {
	HttpResponse *http.Response
}

GetBackupSnapshotsByIdDumpResponse is the result of GetBackupSnapshotsByIdDump.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetBackupSnapshotsByIdDumpResponse) Bytes ¶

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetBackupSnapshotsByIdDumpResponse) ContentLength ¶

func (r GetBackupSnapshotsByIdDumpResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetBackupSnapshotsByIdDumpResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetBackupSnapshotsByIdDumpResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetBackupSnapshotsByIdDumpResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetBackupSnapshotsByIdMetadataAnswer ¶ added in v0.2.0

type GetBackupSnapshotsByIdMetadataAnswer struct {
	BackupTime Time `json:"backupTime,omitzero"`

	// for a container: Docker's own record of it as it was, with its variables and labels taken out
	Container     map[string]any `json:"container,omitzero"`
	EnvironmentId EnvironmentID  `json:"environmentId,omitempty"`
	Error         string         `json:"error,omitempty"`
	HasStackFiles bool           `json:"hasStackFiles"`

	// for a stack: the files that were taken with it
	Stack      *GetBackupSnapshotsByIdMetadataAnswerStack    `json:"stack,omitempty"`
	TargetName string                                        `json:"targetName,omitempty"`
	Type       string                                        `json:"type,omitempty"`
	Version    int                                           `json:"version,omitempty"`
	Volumes    []GetBackupSnapshotsByIdMetadataAnswerVolumes `json:"volumes,omitzero"`
}

GetBackupSnapshotsByIdMetadataAnswer is an object the document declares inline.

type GetBackupSnapshotsByIdMetadataAnswerStack ¶ added in v0.2.0

type GetBackupSnapshotsByIdMetadataAnswerStack struct {
	ComposeFileName  string                                              `json:"composeFileName,omitempty"`
	ExcludedBindDirs []string                                            `json:"excludedBindDirs,omitzero"`
	FileList         []GetBackupSnapshotsByIdMetadataAnswerStackFileList `json:"fileList,omitzero"`

	// the names of the stack's secrets, never their values
	SecretKeys []string `json:"secretKeys,omitzero"`
}

GetBackupSnapshotsByIdMetadataAnswerStack is an object the document declares inline.

for a stack: the files that were taken with it

type GetBackupSnapshotsByIdMetadataAnswerStackFileList ¶ added in v0.2.0

type GetBackupSnapshotsByIdMetadataAnswerStackFileList struct {
	Bytes int    `json:"bytes,omitempty"`
	Path  string `json:"path,omitempty"`
}

GetBackupSnapshotsByIdMetadataAnswerStackFileList is an object the document declares inline.

type GetBackupSnapshotsByIdMetadataAnswerVolumes ¶ added in v0.2.0

type GetBackupSnapshotsByIdMetadataAnswerVolumes struct {
	Key    string `json:"key,omitempty"`
	Name   string `json:"name,omitempty"`
	Source string `json:"source,omitempty"`
	Type   string `json:"type,omitempty"`
}

GetBackupSnapshotsByIdMetadataAnswerVolumes is an object the document declares inline.

type GetBackupSnapshotsByIdMetadataOptions ¶

type GetBackupSnapshotsByIdMetadataOptions struct {
	// Destination the snapshot lives in
	DestinationId BackupDestinationID
}

GetBackupSnapshotsByIdMetadataOptions holds the query and header parameters of GetBackupSnapshotsByIdMetadata.

func (GetBackupSnapshotsByIdMetadataOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetBackupSnapshotsByIdMetadataOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupSnapshotsByIdMetadataResponse ¶

type GetBackupSnapshotsByIdMetadataResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupSnapshotsByIdMetadataAnswer
	*GetBackupSnapshotsByIdMetadataAnswer
}

GetBackupSnapshotsByIdMetadataResponse is the result of GetBackupSnapshotsByIdMetadata.

Answer is the GetBackupSnapshotsByIdMetadataAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupSnapshotsByIdMetadataResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupSnapshotsByIdMetadataResponse) Record ¶ added in v0.2.0

Record is the GetBackupSnapshotsByIdMetadataAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupSnapshotsDiffAnswer ¶ added in v0.2.0

type GetBackupSnapshotsDiffAnswer struct {
	Added           []string `json:"added,omitzero"`
	Error           string   `json:"error,omitempty"`
	MetadataChanged []string `json:"metadataChanged,omitzero"`
	Modified        []string `json:"modified,omitzero"`

	// what restic printed, a JSON line for each change
	Raw     string   `json:"raw,omitempty"`
	Removed []string `json:"removed,omitzero"`
}

GetBackupSnapshotsDiffAnswer is an object the document declares inline.

type GetBackupSnapshotsDiffOptions ¶

type GetBackupSnapshotsDiffOptions struct {
	// Destination both snapshots live in
	DestinationId BackupDestinationID

	// The baseline snapshot id
	SnapshotA string

	// The snapshot to compare against the baseline
	SnapshotB string
}

GetBackupSnapshotsDiffOptions holds the query and header parameters of GetBackupSnapshotsDiff.

func (GetBackupSnapshotsDiffOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetBackupSnapshotsDiffOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupSnapshotsDiffResponse ¶

type GetBackupSnapshotsDiffResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupSnapshotsDiffAnswer
	*GetBackupSnapshotsDiffAnswer
}

GetBackupSnapshotsDiffResponse is the result of GetBackupSnapshotsDiff.

Answer is the GetBackupSnapshotsDiffAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupSnapshotsDiffResponse) Answered ¶

func (r GetBackupSnapshotsDiffResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupSnapshotsDiffResponse) Record ¶ added in v0.2.0

Record is the GetBackupSnapshotsDiffAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupSnapshotsOptions ¶

type GetBackupSnapshotsOptions struct {
	// Backup config id (mutually exclusive with destinationId)
	ConfigId BackupConfigID

	// Single destination id (mutually exclusive with configId)
	DestinationId BackupDestinationID

	// With configId, include every destination of the config
	AllDestinations *bool
}

GetBackupSnapshotsOptions holds the query and header parameters of GetBackupSnapshots.

func (GetBackupSnapshotsOptions) ToHeaders ¶

func (o GetBackupSnapshotsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetBackupSnapshotsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupSnapshotsResponse ¶

type GetBackupSnapshotsResponse struct {
	HttpResponse *http.Response
	Answer       []GetBackupSnapshotsAnswer
}

GetBackupSnapshotsResponse is the result of GetBackupSnapshots.

func (GetBackupSnapshotsResponse) Answered ¶

func (r GetBackupSnapshotsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetBackupStackDirListingAnswer ¶ added in v0.2.0

type GetBackupStackDirListingAnswer struct {
	ComposeFile string                                  `json:"composeFile,omitempty"`
	Entries     []GetBackupStackDirListingAnswerEntries `json:"entries,omitzero"`
	HostPath    string                                  `json:"hostPath,omitempty"`

	// candidate or listed for a folder that was found, tar for a stack only its compose file is known of, unknown or helper-failed with the reason
	Kind          string `json:"kind,omitempty"`
	LocalStackDir string `json:"localStackDir,omitempty"`
	Reason        string `json:"reason,omitempty"`
}

GetBackupStackDirListingAnswer is an object the document declares inline.

type GetBackupStackDirListingAnswerEntries ¶ added in v0.2.0

type GetBackupStackDirListingAnswerEntries struct {
	Name string `json:"name,omitempty"`
	Size int    `json:"size,omitempty"`
	Type string `json:"type,omitempty"`
}

GetBackupStackDirListingAnswerEntries is an object the document declares inline.

type GetBackupStackDirListingOptions ¶

type GetBackupStackDirListingOptions struct {
	// Target stack name
	Target string

	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetBackupStackDirListingOptions holds the query and header parameters of GetBackupStackDirListing.

func (GetBackupStackDirListingOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetBackupStackDirListingOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupStackDirListingResponse ¶

type GetBackupStackDirListingResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupStackDirListingAnswer
	*GetBackupStackDirListingAnswer
}

GetBackupStackDirListingResponse is the result of GetBackupStackDirListing.

Answer is the GetBackupStackDirListingAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupStackDirListingResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupStackDirListingResponse) Record ¶ added in v0.2.0

Record is the GetBackupStackDirListingAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetBackupStackPathAnswer ¶ added in v0.2.0

type GetBackupStackPathAnswer struct {
	ComposeFile string                            `json:"composeFile,omitempty"`
	Entries     []GetBackupStackPathAnswerEntries `json:"entries,omitzero"`
	HostPath    string                            `json:"hostPath,omitempty"`

	// candidate or listed for a folder that was found, tar for a stack only its compose file is known of, unknown or helper-failed with the reason
	Kind          string `json:"kind,omitempty"`
	LocalStackDir string `json:"localStackDir,omitempty"`
	Reason        string `json:"reason,omitempty"`
}

GetBackupStackPathAnswer is an object the document declares inline.

type GetBackupStackPathAnswerEntries ¶ added in v0.2.0

type GetBackupStackPathAnswerEntries struct {
	Name string `json:"name,omitempty"`
	Size int    `json:"size,omitempty"`
	Type string `json:"type,omitempty"`
}

GetBackupStackPathAnswerEntries is an object the document declares inline.

type GetBackupStackPathOptions ¶

type GetBackupStackPathOptions struct {
	// Target stack name
	Target string

	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetBackupStackPathOptions holds the query and header parameters of GetBackupStackPath.

func (GetBackupStackPathOptions) ToHeaders ¶

func (o GetBackupStackPathOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetBackupStackPathOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetBackupStackPathResponse ¶

type GetBackupStackPathResponse struct {
	HttpResponse *http.Response
	Answer       *GetBackupStackPathAnswer
	*GetBackupStackPathAnswer
}

GetBackupStackPathResponse is the result of GetBackupStackPath.

Answer is the GetBackupStackPathAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetBackupStackPathResponse) Answered ¶

func (r GetBackupStackPathResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetBackupStackPathResponse) Record ¶ added in v0.2.0

Record is the GetBackupStackPathAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetChangelogAnswer ¶

type GetChangelogAnswer struct {
	Changes []GetChangelogAnswerChanges `json:"changes,omitzero"`
	Date    string                      `json:"date,omitempty"`
	Version string                      `json:"version"`
}

GetChangelogAnswer is an object the document declares inline.

type GetChangelogAnswerChanges ¶

type GetChangelogAnswerChanges struct {
	Text string `json:"text,omitempty"`

	// what kind of change: feature or fix
	Type ChangeType `json:"type,omitempty"`
}

GetChangelogAnswerChanges is an object the document declares inline.

type GetChangelogResponse ¶

type GetChangelogResponse struct {
	HttpResponse *http.Response
	Answer       []GetChangelogAnswer
}

GetChangelogResponse is the result of GetChangelog.

func (GetChangelogResponse) Answered ¶

func (r GetChangelogResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetConfigSetsAnswer ¶

type GetConfigSetsAnswer struct {
	CreatedAt     Time                         `json:"createdAt"`
	Description   string                       `json:"description,omitempty"`
	EnvVars       []GetConfigSetsAnswerEnvVars `json:"envVars,omitzero"`
	Id            ConfigSetID                  `json:"id"`
	Labels        []GetConfigSetsAnswerLabels  `json:"labels,omitzero"`
	Name          string                       `json:"name"`
	NetworkMode   string                       `json:"networkMode"`
	Ports         []GetConfigSetsAnswerPorts   `json:"ports,omitzero"`
	RestartPolicy string                       `json:"restartPolicy"`
	UpdatedAt     Time                         `json:"updatedAt"`
	Volumes       []GetConfigSetsAnswerVolumes `json:"volumes,omitzero"`
}

GetConfigSetsAnswer is an object the document declares inline.

func (GetConfigSetsAnswer) GetId ¶

func (m GetConfigSetsAnswer) GetId() ConfigSetID

GetId is the record's Id, for code that handles records of several types alike.

func (GetConfigSetsAnswer) GetName ¶

func (m GetConfigSetsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetConfigSetsAnswerEnvVars ¶

type GetConfigSetsAnswerEnvVars struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

GetConfigSetsAnswerEnvVars is an object the document declares inline.

type GetConfigSetsAnswerLabels ¶

type GetConfigSetsAnswerLabels struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

GetConfigSetsAnswerLabels is an object the document declares inline.

type GetConfigSetsAnswerPorts ¶

type GetConfigSetsAnswerPorts struct {
	ContainerPort string `json:"containerPort"`
	HostPort      string `json:"hostPort"`
	Protocol      string `json:"protocol"`
}

GetConfigSetsAnswerPorts is an object the document declares inline.

type GetConfigSetsAnswerVolumes ¶

type GetConfigSetsAnswerVolumes struct {
	ContainerPath string `json:"containerPath"`
	HostPath      string `json:"hostPath"`
	Mode          string `json:"mode"`
}

GetConfigSetsAnswerVolumes is an object the document declares inline.

type GetConfigSetsByIdAnswer ¶

type GetConfigSetsByIdAnswer struct {
	CreatedAt     Time                             `json:"createdAt"`
	Description   string                           `json:"description,omitempty"`
	EnvVars       []GetConfigSetsByIdAnswerEnvVars `json:"envVars,omitzero"`
	Id            ConfigSetID                      `json:"id"`
	Labels        []GetConfigSetsByIdAnswerLabels  `json:"labels,omitzero"`
	Name          string                           `json:"name"`
	NetworkMode   string                           `json:"networkMode"`
	Ports         []GetConfigSetsByIdAnswerPorts   `json:"ports,omitzero"`
	RestartPolicy string                           `json:"restartPolicy"`
	UpdatedAt     Time                             `json:"updatedAt"`
	Volumes       []GetConfigSetsByIdAnswerVolumes `json:"volumes,omitzero"`
}

GetConfigSetsByIdAnswer is an object the document declares inline.

func (GetConfigSetsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetConfigSetsByIdAnswer) GetName ¶

func (m GetConfigSetsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetConfigSetsByIdAnswerEnvVars ¶

type GetConfigSetsByIdAnswerEnvVars struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

GetConfigSetsByIdAnswerEnvVars is an object the document declares inline.

type GetConfigSetsByIdAnswerLabels ¶

type GetConfigSetsByIdAnswerLabels struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

GetConfigSetsByIdAnswerLabels is an object the document declares inline.

type GetConfigSetsByIdAnswerPorts ¶

type GetConfigSetsByIdAnswerPorts struct {
	ContainerPort string `json:"containerPort"`
	HostPort      string `json:"hostPort"`
	Protocol      string `json:"protocol"`
}

GetConfigSetsByIdAnswerPorts is an object the document declares inline.

type GetConfigSetsByIdAnswerVolumes ¶

type GetConfigSetsByIdAnswerVolumes struct {
	ContainerPath string `json:"containerPath"`
	HostPath      string `json:"hostPath"`
	Mode          string `json:"mode"`
}

GetConfigSetsByIdAnswerVolumes is an object the document declares inline.

type GetConfigSetsByIdResponse ¶

type GetConfigSetsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetConfigSetsByIdAnswer
	*GetConfigSetsByIdAnswer
}

GetConfigSetsByIdResponse is the result of GetConfigSetsById.

Answer is the GetConfigSetsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetConfigSetsByIdResponse) Answered ¶

func (r GetConfigSetsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetConfigSetsByIdResponse) Record ¶

Record is the GetConfigSetsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetConfigSetsResponse ¶

type GetConfigSetsResponse struct {
	HttpResponse *http.Response
	Answer       []GetConfigSetsAnswer
}

GetConfigSetsResponse is the result of GetConfigSets.

func (GetConfigSetsResponse) Answered ¶

func (r GetConfigSetsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainerIconsByNameOptions ¶

type GetContainerIconsByNameOptions struct {
	// Environment id the container belongs to
	Env EnvironmentID
}

GetContainerIconsByNameOptions holds the query and header parameters of GetContainerIconsByName.

func (GetContainerIconsByNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainerIconsByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainerIconsByNameResponse ¶

type GetContainerIconsByNameResponse struct {
	HttpResponse *http.Response
}

GetContainerIconsByNameResponse is the result of GetContainerIconsByName.

The operation answers image/*, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetContainerIconsByNameResponse) Bytes ¶

func (r GetContainerIconsByNameResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetContainerIconsByNameResponse) ContentLength ¶

func (r GetContainerIconsByNameResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetContainerIconsByNameResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetContainerIconsByNameResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetContainerIconsByNameResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetContainerIconsOptions ¶

type GetContainerIconsOptions struct {
	// Environment id
	Env EnvironmentID
}

GetContainerIconsOptions holds the query and header parameters of GetContainerIcons.

func (GetContainerIconsOptions) ToHeaders ¶

func (o GetContainerIconsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetContainerIconsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainerIconsResponse ¶

type GetContainerIconsResponse struct {
	HttpResponse *http.Response
	Answer       map[string]string
}

GetContainerIconsResponse is the result of GetContainerIcons.

func (GetContainerIconsResponse) Answered ¶

func (r GetContainerIconsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainerTagsByNameAnswer ¶

type GetContainerTagsByNameAnswer struct {
	TagIds []TagID `json:"tagIds"`
}

GetContainerTagsByNameAnswer is an object the document declares inline.

type GetContainerTagsByNameOptions ¶

type GetContainerTagsByNameOptions struct {
	// Environment id
	Env EnvironmentID
}

GetContainerTagsByNameOptions holds the query and header parameters of GetContainerTagsByName.

func (GetContainerTagsByNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainerTagsByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainerTagsByNameResponse ¶

type GetContainerTagsByNameResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainerTagsByNameAnswer
	*GetContainerTagsByNameAnswer
}

GetContainerTagsByNameResponse is the result of GetContainerTagsByName.

Answer is the GetContainerTagsByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainerTagsByNameResponse) Answered ¶

func (r GetContainerTagsByNameResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainerTagsByNameResponse) Record ¶

Record is the GetContainerTagsByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainerTagsOptions ¶

type GetContainerTagsOptions struct {
	// Environment id
	Env EnvironmentID
}

GetContainerTagsOptions holds the query and header parameters of GetContainerTags.

func (GetContainerTagsOptions) ToHeaders ¶

func (o GetContainerTagsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetContainerTagsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainerTagsResponse ¶

type GetContainerTagsResponse struct {
	HttpResponse *http.Response
	Answer       map[string][]int
}

GetContainerTagsResponse is the result of GetContainerTags.

func (GetContainerTagsResponse) Answered ¶

func (r GetContainerTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainersAnswer ¶

type GetContainersAnswer struct {
	Command string `json:"command,omitempty"`

	// when the container was made, in seconds since 1970
	Created int `json:"created,omitempty"`

	// healthy, unhealthy or starting; empty for a container with no health check
	Health ContainerHealth `json:"health,omitempty"`

	// the container's whole id, sixty-four characters
	Id string `json:"id,omitempty"`

	// the image as the container was started with it: a name and tag, or a digest
	Image        string                                 `json:"image,omitempty"`
	ImageId      string                                 `json:"imageId,omitempty"`
	Labels       map[string]string                      `json:"labels,omitzero"`
	Mounts       []GetContainersAnswerMounts            `json:"mounts,omitzero"`
	Name         string                                 `json:"name,omitempty"`
	Networks     map[string]GetContainersAnswerNetworks `json:"networks,omitzero"`
	Ports        []GetContainersAnswerPorts             `json:"ports,omitzero"`
	RestartCount int                                    `json:"restartCount,omitempty"`

	// running, exited, restarting, paused, created or dead
	State ContainerState `json:"state,omitempty"`

	// Docker's own words for the state: Up 2 hours (healthy), Exited (3) 11 seconds ago
	Status string `json:"status,omitempty"`

	// dockhand or hawser for a container that is Dockhand itself or one of its agents, told by its image's name; nothing for any other
	SystemContainer string `json:"systemContainer,omitempty"`
}

GetContainersAnswer is an object the document declares inline.

func (GetContainersAnswer) GetId ¶

func (m GetContainersAnswer) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (GetContainersAnswer) GetName ¶

func (m GetContainersAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetContainersAnswerMounts ¶

type GetContainersAnswerMounts struct {
	Destination string `json:"destination,omitempty"`
	Mode        string `json:"mode,omitempty"`

	// the volume's name; empty for a bind
	Name   string `json:"name,omitempty"`
	Rw     bool   `json:"rw"`
	Source string `json:"source,omitempty"`

	// bind or volume
	Type string `json:"type,omitempty"`
}

GetContainersAnswerMounts is an object the document declares inline.

type GetContainersAnswerNetworks ¶

type GetContainersAnswerNetworks struct {
	// the container's address on the network; empty while it is not running
	IpAddress string `json:"ipAddress,omitempty"`
}

GetContainersAnswerNetworks is an object the document declares inline.

type GetContainersAnswerPorts ¶

type GetContainersAnswerPorts struct {
	// the address on the host the port is published on
	IP          string `json:"IP,omitempty"`
	PrivatePort int    `json:"PrivatePort,omitempty"`
	PublicPort  int    `json:"PublicPort,omitempty"`

	// tcp or udp
	Type string `json:"Type,omitempty"`
}

GetContainersAnswerPorts is an object the document declares inline.

type GetContainersByIdComposeAnswer ¶

type GetContainersByIdComposeAnswer struct {
	Compose        string `json:"compose,omitempty"`
	ComposeFullEnv string `json:"composeFullEnv,omitempty"`
	ServiceName    string `json:"serviceName,omitempty"`
	StackProject   string `json:"stackProject,omitempty"`
}

GetContainersByIdComposeAnswer is an object the document declares inline.

type GetContainersByIdComposeOptions ¶

type GetContainersByIdComposeOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersByIdComposeOptions holds the query and header parameters of GetContainersByIdCompose.

func (GetContainersByIdComposeOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdComposeOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdComposeResponse ¶

type GetContainersByIdComposeResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdComposeAnswer
	*GetContainersByIdComposeAnswer
}

GetContainersByIdComposeResponse is the result of GetContainersByIdCompose.

Answer is the GetContainersByIdComposeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdComposeResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdComposeResponse) Record ¶

Record is the GetContainersByIdComposeAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdFilesAnswer ¶

type GetContainersByIdFilesAnswer struct {
	Entries []GetContainersByIdFilesAnswerEntries `json:"entries,omitzero"`
	Path    string                                `json:"path,omitempty"`
}

GetContainersByIdFilesAnswer is an object the document declares inline.

type GetContainersByIdFilesAnswerEntries ¶

type GetContainersByIdFilesAnswerEntries struct {
	Group string `json:"group,omitempty"`

	// what a symlink points to
	LinkTarget string `json:"linkTarget,omitempty"`

	// when it last changed, in the container's own time and to the minute: 2006-01-02T15:04:00
	Modified string `json:"modified,omitempty"`
	Name     string `json:"name,omitempty"`
	Owner    string `json:"owner,omitempty"`

	// as ls writes them, without the kind: rwxr-xr-x
	Permissions string `json:"permissions,omitempty"`
	Readonly    bool   `json:"readonly"`
	Size        int    `json:"size,omitempty"`

	// file, directory or symlink
	Type FileType `json:"type,omitempty"`
}

GetContainersByIdFilesAnswerEntries is an object the document declares inline.

type GetContainersByIdFilesContentAnswer ¶

type GetContainersByIdFilesContentAnswer struct {
	Content string `json:"content"`
	Path    string `json:"path"`
}

GetContainersByIdFilesContentAnswer is an object the document declares inline.

type GetContainersByIdFilesContentOptions ¶

type GetContainersByIdFilesContentOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Absolute file path inside the container
	Path string
}

GetContainersByIdFilesContentOptions holds the query and header parameters of GetContainersByIdFilesContent.

func (GetContainersByIdFilesContentOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdFilesContentOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdFilesContentResponse ¶

type GetContainersByIdFilesContentResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdFilesContentAnswer
	*GetContainersByIdFilesContentAnswer
}

GetContainersByIdFilesContentResponse is the result of GetContainersByIdFilesContent.

Answer is the GetContainersByIdFilesContentAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdFilesContentResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdFilesContentResponse) Record ¶

Record is the GetContainersByIdFilesContentAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdFilesDownloadOptions ¶

type GetContainersByIdFilesDownloadOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Absolute path inside the container to archive and download
	Path string

	// Archive format, "tar" (default) or "tar.gz"
	Format string
}

GetContainersByIdFilesDownloadOptions holds the query and header parameters of GetContainersByIdFilesDownload.

func (GetContainersByIdFilesDownloadOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdFilesDownloadOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdFilesDownloadResponse ¶

type GetContainersByIdFilesDownloadResponse struct {
	HttpResponse *http.Response
}

GetContainersByIdFilesDownloadResponse is the result of GetContainersByIdFilesDownload.

The operation answers application/x-tar, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetContainersByIdFilesDownloadResponse) Bytes ¶

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetContainersByIdFilesDownloadResponse) ContentLength ¶

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetContainersByIdFilesDownloadResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetContainersByIdFilesDownloadResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetContainersByIdFilesDownloadResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetContainersByIdFilesOptions ¶

type GetContainersByIdFilesOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Absolute directory path inside the container (default "/")
	Path string

	// Use a lightweight `ls` listing instead of a full stat of each entry
	SimpleLs *bool
}

GetContainersByIdFilesOptions holds the query and header parameters of GetContainersByIdFiles.

func (GetContainersByIdFilesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdFilesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdFilesResponse ¶

type GetContainersByIdFilesResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdFilesAnswer
	*GetContainersByIdFilesAnswer
}

GetContainersByIdFilesResponse is the result of GetContainersByIdFiles.

Answer is the GetContainersByIdFilesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdFilesResponse) Answered ¶

func (r GetContainersByIdFilesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdFilesResponse) Record ¶

Record is the GetContainersByIdFilesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdInspectOptions ¶

type GetContainersByIdInspectOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersByIdInspectOptions holds the query and header parameters of GetContainersByIdInspect.

func (GetContainersByIdInspectOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdInspectOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdInspectResponse ¶

type GetContainersByIdInspectResponse struct {
	HttpResponse *http.Response
	Answer       json.RawMessage
}

GetContainersByIdInspectResponse is the result of GetContainersByIdInspect.

func (GetContainersByIdInspectResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainersByIdLogsAnswer ¶

type GetContainersByIdLogsAnswer struct {
	Logs string `json:"logs"`
}

GetContainersByIdLogsAnswer is an object the document declares inline.

type GetContainersByIdLogsOptions ¶

type GetContainersByIdLogsOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Number of trailing log lines to return (default 100)
	Tail *int

	// Only return logs since this time (Unix timestamp or Docker duration, e.g. 10m)
	Since string

	// Only return logs before this time (Unix timestamp or Docker duration)
	Until string
}

GetContainersByIdLogsOptions holds the query and header parameters of GetContainersByIdLogs.

func (GetContainersByIdLogsOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdLogsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdLogsResponse ¶

type GetContainersByIdLogsResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdLogsAnswer
	*GetContainersByIdLogsAnswer
}

GetContainersByIdLogsResponse is the result of GetContainersByIdLogs.

Answer is the GetContainersByIdLogsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdLogsResponse) Answered ¶

func (r GetContainersByIdLogsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdLogsResponse) Record ¶

Record is the GetContainersByIdLogsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdLogsStreamOptions ¶

type GetContainersByIdLogsStreamOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Number of trailing log lines to prime the stream with (default "100")
	Tail string

	// Only stream logs since this time (Unix timestamp or Docker duration, e.g. 10m)
	Since string

	// Only stream logs before this time (Unix timestamp or Docker duration)
	Until string
}

GetContainersByIdLogsStreamOptions holds the query and header parameters of GetContainersByIdLogsStream.

func (GetContainersByIdLogsStreamOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdLogsStreamOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdLogsStreamResponse ¶

type GetContainersByIdLogsStreamResponse struct {
	HttpResponse *http.Response
}

GetContainersByIdLogsStreamResponse is the result of GetContainersByIdLogsStream.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetContainersByIdLogsStreamResponse) ContentLength ¶

func (r GetContainersByIdLogsStreamResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetContainersByIdLogsStreamResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetContainersByIdLogsStreamResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetContainersByIdOptions ¶

type GetContainersByIdOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersByIdOptions holds the query and header parameters of GetContainersById.

func (GetContainersByIdOptions) ToHeaders ¶

func (o GetContainersByIdOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetContainersByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdResponse ¶

type GetContainersByIdResponse struct {
	HttpResponse *http.Response
	Answer       json.RawMessage
}

GetContainersByIdResponse is the result of GetContainersById.

func (GetContainersByIdResponse) Answered ¶

func (r GetContainersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainersByIdShellsAnswer ¶

type GetContainersByIdShellsAnswer struct {
	AllShells    []GetContainersByIdShellsAnswerAllShells `json:"allShells"`
	DefaultShell string                                   `json:"defaultShell,omitempty"`
	Shells       []string                                 `json:"shells"`
}

GetContainersByIdShellsAnswer is an object the document declares inline.

type GetContainersByIdShellsAnswerAllShells ¶

type GetContainersByIdShellsAnswerAllShells struct {
	Available bool   `json:"available"`
	Label     string `json:"label"`
	Path      string `json:"path"`
}

GetContainersByIdShellsAnswerAllShells is an object the document declares inline.

type GetContainersByIdShellsOptions ¶

type GetContainersByIdShellsOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersByIdShellsOptions holds the query and header parameters of GetContainersByIdShells.

func (GetContainersByIdShellsOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdShellsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdShellsResponse ¶

type GetContainersByIdShellsResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdShellsAnswer
	*GetContainersByIdShellsAnswer
}

GetContainersByIdShellsResponse is the result of GetContainersByIdShells.

Answer is the GetContainersByIdShellsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdShellsResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdShellsResponse) Record ¶

Record is the GetContainersByIdShellsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdStatsAnswer ¶

type GetContainersByIdStatsAnswer struct {
	BlockRead     int       `json:"blockRead"`
	BlockWrite    int       `json:"blockWrite"`
	CpuPercent    float64   `json:"cpuPercent"`
	MemoryCache   int       `json:"memoryCache"`
	MemoryLimit   int       `json:"memoryLimit"`
	MemoryPercent float64   `json:"memoryPercent"`
	MemoryRaw     int       `json:"memoryRaw"`
	MemoryUsage   int       `json:"memoryUsage"`
	NetworkRx     int       `json:"networkRx"`
	NetworkTx     int       `json:"networkTx"`
	Timestamp     UnixMilli `json:"timestamp"`
}

GetContainersByIdStatsAnswer is an object the document declares inline.

type GetContainersByIdStatsOptions ¶

type GetContainersByIdStatsOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersByIdStatsOptions holds the query and header parameters of GetContainersByIdStats.

func (GetContainersByIdStatsOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdStatsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdStatsResponse ¶

type GetContainersByIdStatsResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdStatsAnswer
	*GetContainersByIdStatsAnswer
}

GetContainersByIdStatsResponse is the result of GetContainersByIdStats.

Answer is the GetContainersByIdStatsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdStatsResponse) Answered ¶

func (r GetContainersByIdStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdStatsResponse) Record ¶

Record is the GetContainersByIdStatsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdTopAnswer ¶

type GetContainersByIdTopAnswer struct {
	Processes [][]string `json:"Processes"`
	Titles    []string   `json:"Titles"`
	Source    string     `json:"source"`
}

GetContainersByIdTopAnswer is an object the document declares inline.

type GetContainersByIdTopOptions ¶

type GetContainersByIdTopOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersByIdTopOptions holds the query and header parameters of GetContainersByIdTop.

func (GetContainersByIdTopOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdTopOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdTopResponse ¶

type GetContainersByIdTopResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdTopAnswer
	*GetContainersByIdTopAnswer
}

GetContainersByIdTopResponse is the result of GetContainersByIdTop.

Answer is the GetContainersByIdTopAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdTopResponse) Answered ¶

func (r GetContainersByIdTopResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdTopResponse) Record ¶

Record is the GetContainersByIdTopAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersByIdVersionNotesAnswer ¶

type GetContainersByIdVersionNotesAnswer struct {
	ChangelogUrl string                                     `json:"changelogUrl,omitempty"`
	Notes        []GetContainersByIdVersionNotesAnswerNotes `json:"notes"`
	RateLimited  bool                                       `json:"rateLimited"`
	Source       string                                     `json:"source,omitempty"`
}

GetContainersByIdVersionNotesAnswer is an object the document declares inline.

type GetContainersByIdVersionNotesAnswerNotes ¶

type GetContainersByIdVersionNotesAnswerNotes struct {
	Body        string `json:"body,omitempty"`
	GithubTag   string `json:"githubTag,omitempty"`
	Name        string `json:"name,omitempty"`
	PublishedAt Time   `json:"publishedAt,omitzero"`
	Url         string `json:"url"`
	Version     string `json:"version"`
}

GetContainersByIdVersionNotesAnswerNotes is an object the document declares inline.

type GetContainersByIdVersionNotesOptions ¶

type GetContainersByIdVersionNotesOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Comma-separated version tags to fetch notes for (target + skipped), e.g. "16.3-alpine,16.4-alpine"
	Versions string
}

GetContainersByIdVersionNotesOptions holds the query and header parameters of GetContainersByIdVersionNotes.

func (GetContainersByIdVersionNotesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersByIdVersionNotesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersByIdVersionNotesResponse ¶

type GetContainersByIdVersionNotesResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersByIdVersionNotesAnswer
	*GetContainersByIdVersionNotesAnswer
}

GetContainersByIdVersionNotesResponse is the result of GetContainersByIdVersionNotes.

Answer is the GetContainersByIdVersionNotesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersByIdVersionNotesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersByIdVersionNotesResponse) Record ¶

Record is the GetContainersByIdVersionNotesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersCheckUpdatesAnswer ¶

type GetContainersCheckUpdatesAnswer struct {
	EnvironmentId  EnvironmentID                                   `json:"environmentId"`
	PendingUpdates []GetContainersCheckUpdatesAnswerPendingUpdates `json:"pendingUpdates"`
}

GetContainersCheckUpdatesAnswer is an object the document declares inline.

type GetContainersCheckUpdatesAnswerPendingUpdates ¶

type GetContainersCheckUpdatesAnswerPendingUpdates struct {
	CheckedAt     Time   `json:"checkedAt,omitzero"`
	ContainerId   string `json:"containerId"`
	ContainerName string `json:"containerName"`
	CurrentImage  string `json:"currentImage"`
}

GetContainersCheckUpdatesAnswerPendingUpdates is an object the document declares inline.

type GetContainersCheckUpdatesOptions ¶

type GetContainersCheckUpdatesOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersCheckUpdatesOptions holds the query and header parameters of GetContainersCheckUpdates.

func (GetContainersCheckUpdatesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersCheckUpdatesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersCheckUpdatesResponse ¶

type GetContainersCheckUpdatesResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersCheckUpdatesAnswer
	*GetContainersCheckUpdatesAnswer
}

GetContainersCheckUpdatesResponse is the result of GetContainersCheckUpdates.

Answer is the GetContainersCheckUpdatesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersCheckUpdatesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersCheckUpdatesResponse) Record ¶

Record is the GetContainersCheckUpdatesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersOptions ¶

type GetContainersOptions struct {
	// Environment id — an empty array is returned if omitted (from GET /api/environments)
	Env EnvironmentID

	// Include stopped containers (default true; pass "false" to only show running ones)
	All *bool
}

GetContainersOptions holds the query and header parameters of GetContainers.

func (GetContainersOptions) ToHeaders ¶

func (o GetContainersOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetContainersOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersPendingUpdatesAnswer ¶

type GetContainersPendingUpdatesAnswer struct {
	EnvironmentId  EnvironmentID                                     `json:"environmentId"`
	PendingUpdates []GetContainersPendingUpdatesAnswerPendingUpdates `json:"pendingUpdates"`
}

GetContainersPendingUpdatesAnswer is an object the document declares inline.

type GetContainersPendingUpdatesAnswerPendingUpdates ¶

type GetContainersPendingUpdatesAnswerPendingUpdates struct {
	CheckedAt      Time   `json:"checkedAt"`
	ContainerId    string `json:"containerId"`
	ContainerName  string `json:"containerName"`
	CurrentImage   string `json:"currentImage"`
	HasImageUpdate bool   `json:"hasImageUpdate"`

	// a newer version tag of the image, when Dockhand is set to look for them and found one
	NewerVersion *GetContainersPendingUpdatesAnswerPendingUpdatesNewerVersion `json:"newerVersion,omitempty"`
}

GetContainersPendingUpdatesAnswerPendingUpdates is an object the document declares inline.

type GetContainersPendingUpdatesAnswerPendingUpdatesNewerVersion ¶

type GetContainersPendingUpdatesAnswerPendingUpdatesNewerVersion struct {
	// how far a step it is from the tag in use: patch, minor or major
	Bump   string `json:"bump,omitempty"`
	Digest string `json:"digest,omitempty"`

	// the version tags between the one in use and the newest, the newest among them
	Skipped []string `json:"skipped,omitzero"`

	// the newest version tag the registry has for the image
	Tag string `json:"tag,omitempty"`
}

GetContainersPendingUpdatesAnswerPendingUpdatesNewerVersion is an object the document declares inline.

a newer version tag of the image, when Dockhand is set to look for them and found one

type GetContainersPendingUpdatesOptions ¶

type GetContainersPendingUpdatesOptions struct {
	// The target environment ID (required) (from GET /api/environments)
	Env EnvironmentID
}

GetContainersPendingUpdatesOptions holds the query and header parameters of GetContainersPendingUpdates.

func (GetContainersPendingUpdatesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersPendingUpdatesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersPendingUpdatesResponse ¶

type GetContainersPendingUpdatesResponse struct {
	HttpResponse *http.Response
	Answer       *GetContainersPendingUpdatesAnswer
	*GetContainersPendingUpdatesAnswer
}

GetContainersPendingUpdatesResponse is the result of GetContainersPendingUpdates.

Answer is the GetContainersPendingUpdatesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetContainersPendingUpdatesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetContainersPendingUpdatesResponse) Record ¶

Record is the GetContainersPendingUpdatesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetContainersResponse ¶

type GetContainersResponse struct {
	HttpResponse *http.Response
	Answer       []GetContainersAnswer
}

GetContainersResponse is the result of GetContainers.

func (GetContainersResponse) Answered ¶

func (r GetContainersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainersSizesAnswer ¶

type GetContainersSizesAnswer struct {
	// what its whole filesystem takes, image included, in bytes
	SizeRootFs int `json:"sizeRootFs,omitempty"`

	// what the container has written over its image, in bytes
	SizeRw int `json:"sizeRw,omitempty"`
}

GetContainersSizesAnswer is an object the document declares inline.

type GetContainersSizesOptions ¶

type GetContainersSizesOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

GetContainersSizesOptions holds the query and header parameters of GetContainersSizes.

func (GetContainersSizesOptions) ToHeaders ¶

func (o GetContainersSizesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetContainersSizesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersSizesResponse ¶

type GetContainersSizesResponse struct {
	HttpResponse *http.Response
	Answer       map[string]GetContainersSizesAnswer
}

GetContainersSizesResponse is the result of GetContainersSizes.

func (GetContainersSizesResponse) Answered ¶

func (r GetContainersSizesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainersStatsAnswer ¶

type GetContainersStatsAnswer struct {
	// bytes read from disk since it started
	BlockRead  int `json:"blockRead,omitempty"`
	BlockWrite int `json:"blockWrite,omitempty"`

	// the share of the host's processors it is using, where 100 is one whole processor
	CpuPercent  float64 `json:"cpuPercent,omitempty"`
	Id          string  `json:"id,omitempty"`
	MemoryCache int     `json:"memoryCache,omitempty"`

	// the most memory it may hold, in bytes: the host's own when it has no limit
	MemoryLimit   int     `json:"memoryLimit,omitempty"`
	MemoryPercent float64 `json:"memoryPercent,omitempty"`

	// the memory it holds with the file cache counted, in bytes
	MemoryRaw int `json:"memoryRaw,omitempty"`

	// the memory it holds, less what is only file cache, in bytes
	MemoryUsage int    `json:"memoryUsage,omitempty"`
	Name        string `json:"name,omitempty"`

	// bytes received since it started
	NetworkRx int `json:"networkRx,omitempty"`
	NetworkTx int `json:"networkTx,omitempty"`
}

GetContainersStatsAnswer is an object the document declares inline.

func (GetContainersStatsAnswer) GetId ¶

func (m GetContainersStatsAnswer) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (GetContainersStatsAnswer) GetName ¶

func (m GetContainersStatsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetContainersStatsOptions ¶

type GetContainersStatsOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Return raw Docker stats for the single container with this name instead of the aggregate list
	Debug string
}

GetContainersStatsOptions holds the query and header parameters of GetContainersStats.

func (GetContainersStatsOptions) ToHeaders ¶

func (o GetContainersStatsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetContainersStatsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersStatsResponse ¶

type GetContainersStatsResponse struct {
	HttpResponse *http.Response
	Answer       []GetContainersStatsAnswer
}

GetContainersStatsResponse is the result of GetContainersStats.

func (GetContainersStatsResponse) Answered ¶

func (r GetContainersStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetContainersStatsStreamOptions ¶

type GetContainersStatsStreamOptions struct {
	// Environment id — an immediate "done" event is sent if omitted or no environments are configured (from GET /api/environments)
	Env EnvironmentID
}

GetContainersStatsStreamOptions holds the query and header parameters of GetContainersStatsStream.

func (GetContainersStatsStreamOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetContainersStatsStreamOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetContainersStatsStreamResponse ¶

type GetContainersStatsStreamResponse struct {
	HttpResponse *http.Response
}

GetContainersStatsStreamResponse is the result of GetContainersStatsStream.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetContainersStatsStreamResponse) ContentLength ¶

func (r GetContainersStatsStreamResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetContainersStatsStreamResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetContainersStatsStreamResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetDashboardPreferencesAnswer ¶

type GetDashboardPreferencesAnswer struct {
	GridLayout []map[string]any `json:"gridLayout,omitzero"`
	Locked     bool             `json:"locked"`
	ViewMode   string           `json:"viewMode"`
}

GetDashboardPreferencesAnswer is an object the document declares inline.

type GetDashboardPreferencesResponse ¶

type GetDashboardPreferencesResponse struct {
	HttpResponse *http.Response
	Answer       *GetDashboardPreferencesAnswer
	*GetDashboardPreferencesAnswer
}

GetDashboardPreferencesResponse is the result of GetDashboardPreferences.

Answer is the GetDashboardPreferencesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetDashboardPreferencesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetDashboardPreferencesResponse) Record ¶

Record is the GetDashboardPreferencesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetDashboardStatsAnswer ¶

type GetDashboardStatsAnswer struct {
	Containers map[string]any `json:"containers,omitzero"`
	Events     map[string]any `json:"events,omitzero"`
	Id         EnvironmentID  `json:"id"`
	Images     map[string]any `json:"images,omitzero"`
	Metrics    map[string]any `json:"metrics,omitzero"`
	Name       string         `json:"name"`
	Networks   map[string]any `json:"networks,omitzero"`
	Online     bool           `json:"online"`
	Stacks     map[string]any `json:"stacks,omitzero"`
	Volumes    map[string]any `json:"volumes,omitzero"`
}

GetDashboardStatsAnswer is an object the document declares inline.

func (GetDashboardStatsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetDashboardStatsAnswer) GetName ¶

func (m GetDashboardStatsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetDashboardStatsResponse ¶

type GetDashboardStatsResponse struct {
	HttpResponse *http.Response
	Answer       []GetDashboardStatsAnswer
}

GetDashboardStatsResponse is the result of GetDashboardStats.

func (GetDashboardStatsResponse) Answered ¶

func (r GetDashboardStatsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetDashboardStatsStreamResponse ¶

type GetDashboardStatsStreamResponse struct {
	HttpResponse *http.Response
}

GetDashboardStatsStreamResponse is the result of GetDashboardStatsStream.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetDashboardStatsStreamResponse) ContentLength ¶

func (r GetDashboardStatsStreamResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetDashboardStatsStreamResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetDashboardStatsStreamResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetDebugMemoryAnswer ¶

type GetDebugMemoryAnswer struct {
	GcAvailable bool           `json:"gcAvailable"`
	GcForced    bool           `json:"gcForced"`
	Growth      map[string]any `json:"growth"`
	Process     map[string]any `json:"process"`
	RssTracker  map[string]any `json:"rssTracker,omitzero"`
	System      map[string]any `json:"system"`
	Timestamp   Time           `json:"timestamp"`
	Uptime      map[string]any `json:"uptime"`
	V8Heap      map[string]any `json:"v8Heap"`
}

GetDebugMemoryAnswer is an object the document declares inline.

type GetDebugMemoryOptions ¶

type GetDebugMemoryOptions struct {
	// Force garbage collection before reporting when true (requires Node started with --expose-gc)
	Gc *bool
}

GetDebugMemoryOptions holds the query and header parameters of GetDebugMemory.

func (GetDebugMemoryOptions) ToHeaders ¶

func (o GetDebugMemoryOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetDebugMemoryOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetDebugMemoryResponse ¶

type GetDebugMemoryResponse struct {
	HttpResponse *http.Response
	Answer       *GetDebugMemoryAnswer
	*GetDebugMemoryAnswer
}

GetDebugMemoryResponse is the result of GetDebugMemory.

Answer is the GetDebugMemoryAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetDebugMemoryResponse) Answered ¶

func (r GetDebugMemoryResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetDebugMemoryResponse) Record ¶

Record is the GetDebugMemoryAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetDependenciesAnswer ¶

type GetDependenciesAnswer struct {
	License    string `json:"license,omitempty"`
	Name       string `json:"name"`
	Repository string `json:"repository,omitempty"`
	Version    string `json:"version"`
}

GetDependenciesAnswer is an object the document declares inline.

type GetDependenciesResponse ¶

type GetDependenciesResponse struct {
	HttpResponse *http.Response
	Answer       []GetDependenciesAnswer
}

GetDependenciesResponse is the result of GetDependencies.

func (GetDependenciesResponse) Answered ¶

func (r GetDependenciesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetDocsResponse ¶

type GetDocsResponse struct {
	HttpResponse *http.Response
	Answer       json.RawMessage
}

GetDocsResponse is the result of GetDocs.

func (GetDocsResponse) Answered ¶

func (r GetDocsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetEnvironmentsAnswer ¶

type GetEnvironmentsAnswer struct {
	CollectActivity bool `json:"collectActivity"`
	CollectMetrics  bool `json:"collectMetrics"`

	// how the host is reached: socket, direct, hawser-standard or hawser-edge
	ConnectionType ConnectionType `json:"connectionType"`
	CreatedAt      Time           `json:"createdAt,omitzero"`

	// an agent's token is kept for the host; the token itself is never sent
	HasHawserToken bool `json:"hasHawserToken"`

	// a TLS key is kept for the host; the key itself is never sent
	HasTlsKey       bool   `json:"hasTlsKey"`
	HawserAgentId   string `json:"hawserAgentId,omitempty"`
	HawserAgentName string `json:"hawserAgentName,omitempty"`

	// when an agent that calls in was last heard from; empty for every other connection
	HawserLastSeen   Time   `json:"hawserLastSeen,omitzero"`
	HawserVersion    string `json:"hawserVersion,omitempty"`
	HighlightChanges bool   `json:"highlightChanges"`

	// the host or its agent, for every connection but a socket
	Host              string              `json:"host,omitempty"`
	Icon              string              `json:"icon,omitempty"`
	Id                EnvironmentID       `json:"id"`
	ImagePruneEnabled bool                `json:"imagePruneEnabled"`
	Labels            []string            `json:"labels,omitzero"`
	Name              string              `json:"name"`
	Port              int                 `json:"port,omitempty"`
	Protocol          EnvironmentProtocol `json:"protocol,omitempty"`
	PublicIp          string              `json:"publicIp,omitempty"`

	// the Docker socket, for a socket connection; sent for the others too, and means nothing there
	SocketPath            string `json:"socketPath,omitempty"`
	Timezone              string `json:"timezone,omitempty"`
	TlsCa                 string `json:"tlsCa,omitempty"`
	TlsCert               string `json:"tlsCert,omitempty"`
	TlsSkipVerify         bool   `json:"tlsSkipVerify"`
	UpdateCheckAutoUpdate bool   `json:"updateCheckAutoUpdate"`
	UpdateCheckEnabled    bool   `json:"updateCheckEnabled"`
	UpdatedAt             Time   `json:"updatedAt,omitzero"`
}

GetEnvironmentsAnswer is an object the document declares inline.

func (GetEnvironmentsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetEnvironmentsAnswer) GetName ¶

func (m GetEnvironmentsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetEnvironmentsByIdAnswer ¶

type GetEnvironmentsByIdAnswer struct {
	CollectActivity bool `json:"collectActivity"`
	CollectMetrics  bool `json:"collectMetrics"`

	// how the host is reached: socket, direct, hawser-standard or hawser-edge
	ConnectionType ConnectionType `json:"connectionType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`

	// an agent's token is kept for the host; the token itself is never sent
	HasHawserToken bool `json:"hasHawserToken"`

	// a TLS key is kept for the host; the key itself is never sent
	HasTlsKey       bool   `json:"hasTlsKey"`
	HawserAgentId   string `json:"hawserAgentId,omitempty"`
	HawserAgentName string `json:"hawserAgentName,omitempty"`

	// when an agent that calls in was last heard from; empty for every other connection
	HawserLastSeen   Time   `json:"hawserLastSeen,omitzero"`
	HawserVersion    string `json:"hawserVersion,omitempty"`
	HighlightChanges bool   `json:"highlightChanges"`

	// the host or its agent, for every connection but a socket
	Host     string              `json:"host,omitempty"`
	Icon     string              `json:"icon,omitempty"`
	Id       EnvironmentID       `json:"id,omitempty"`
	Labels   []string            `json:"labels,omitzero"`
	Name     string              `json:"name,omitempty"`
	Port     int                 `json:"port,omitempty"`
	Protocol EnvironmentProtocol `json:"protocol,omitempty"`
	PublicIp string              `json:"publicIp,omitempty"`

	// the Docker socket, for a socket connection; sent for the others too, and means nothing there
	SocketPath    string `json:"socketPath,omitempty"`
	TlsCa         string `json:"tlsCa,omitempty"`
	TlsCert       string `json:"tlsCert,omitempty"`
	TlsSkipVerify bool   `json:"tlsSkipVerify"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
}

GetEnvironmentsByIdAnswer is an object the document declares inline.

func (GetEnvironmentsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetEnvironmentsByIdAnswer) GetName ¶

func (m GetEnvironmentsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetEnvironmentsByIdDiskWarningAnswer ¶

type GetEnvironmentsByIdDiskWarningAnswer struct {
	Enabled             bool            `json:"enabled"`
	Mode                DiskWarningMode `json:"mode"`
	PercentageSupported bool            `json:"percentageSupported"`
	StorageDriver       string          `json:"storageDriver,omitempty"`
	Threshold           int             `json:"threshold"`
	ThresholdGb         int             `json:"thresholdGb"`
}

GetEnvironmentsByIdDiskWarningAnswer is an object the document declares inline.

type GetEnvironmentsByIdDiskWarningResponse ¶

type GetEnvironmentsByIdDiskWarningResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdDiskWarningAnswer
	*GetEnvironmentsByIdDiskWarningAnswer
}

GetEnvironmentsByIdDiskWarningResponse is the result of GetEnvironmentsByIdDiskWarning.

Answer is the GetEnvironmentsByIdDiskWarningAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdDiskWarningResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdDiskWarningResponse) Record ¶

Record is the GetEnvironmentsByIdDiskWarningAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsByIdIconResponse ¶

type GetEnvironmentsByIdIconResponse struct {
	HttpResponse *http.Response
}

GetEnvironmentsByIdIconResponse is the result of GetEnvironmentsByIdIcon.

The operation answers image/*, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetEnvironmentsByIdIconResponse) Bytes ¶

func (r GetEnvironmentsByIdIconResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetEnvironmentsByIdIconResponse) ContentLength ¶

func (r GetEnvironmentsByIdIconResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetEnvironmentsByIdIconResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetEnvironmentsByIdIconResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetEnvironmentsByIdIconResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetEnvironmentsByIdImagePruneAnswer ¶

type GetEnvironmentsByIdImagePruneAnswer struct {
	Settings *GetEnvironmentsByIdImagePruneAnswerSettings `json:"settings"`
}

GetEnvironmentsByIdImagePruneAnswer is an object the document declares inline.

type GetEnvironmentsByIdImagePruneAnswerSettings ¶

type GetEnvironmentsByIdImagePruneAnswerSettings struct {
	CronExpression string `json:"cronExpression"`
	Enabled        bool   `json:"enabled"`
	PruneMode      string `json:"pruneMode"`
}

GetEnvironmentsByIdImagePruneAnswerSettings is an object the document declares inline.

type GetEnvironmentsByIdImagePruneResponse ¶

type GetEnvironmentsByIdImagePruneResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdImagePruneAnswer
	*GetEnvironmentsByIdImagePruneAnswer
}

GetEnvironmentsByIdImagePruneResponse is the result of GetEnvironmentsByIdImagePrune.

Answer is the GetEnvironmentsByIdImagePruneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdImagePruneResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdImagePruneResponse) Record ¶

Record is the GetEnvironmentsByIdImagePruneAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsByIdNotificationsAnswer ¶

type GetEnvironmentsByIdNotificationsAnswer struct {
	// whether the channel itself is switched on: a link that is on sends nothing through a channel that is off
	ChannelEnabled bool           `json:"channelEnabled"`
	ChannelName    string         `json:"channelName,omitempty"`
	ChannelType    string         `json:"channelType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`
	Enabled        bool           `json:"enabled"`
	EnvironmentId  EnvironmentID  `json:"environmentId,omitempty"`
	EventTypes     []string       `json:"eventTypes,omitzero"`
	Id             int            `json:"id"`
	NotificationId NotificationID `json:"notificationId"`
	UpdatedAt      Time           `json:"updatedAt,omitzero"`
}

GetEnvironmentsByIdNotificationsAnswer is an object the document declares inline.

type GetEnvironmentsByIdNotificationsByNotificationIdAnswer ¶

type GetEnvironmentsByIdNotificationsByNotificationIdAnswer struct {
	// whether the channel itself is switched on: a link that is on sends nothing through a channel that is off
	ChannelEnabled bool           `json:"channelEnabled"`
	ChannelName    string         `json:"channelName,omitempty"`
	ChannelType    string         `json:"channelType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`
	Enabled        bool           `json:"enabled"`
	EnvironmentId  EnvironmentID  `json:"environmentId,omitempty"`
	EventTypes     []string       `json:"eventTypes,omitzero"`
	Id             int            `json:"id"`
	NotificationId NotificationID `json:"notificationId"`
	UpdatedAt      Time           `json:"updatedAt,omitzero"`
}

GetEnvironmentsByIdNotificationsByNotificationIdAnswer is an object the document declares inline.

type GetEnvironmentsByIdNotificationsByNotificationIdResponse ¶

type GetEnvironmentsByIdNotificationsByNotificationIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdNotificationsByNotificationIdAnswer
	*GetEnvironmentsByIdNotificationsByNotificationIdAnswer
}

GetEnvironmentsByIdNotificationsByNotificationIdResponse is the result of GetEnvironmentsByIdNotificationsByNotificationId.

Answer is the GetEnvironmentsByIdNotificationsByNotificationIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdNotificationsByNotificationIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdNotificationsByNotificationIdResponse) Record ¶

Record is the GetEnvironmentsByIdNotificationsByNotificationIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsByIdNotificationsResponse ¶

type GetEnvironmentsByIdNotificationsResponse struct {
	HttpResponse *http.Response
	Answer       []GetEnvironmentsByIdNotificationsAnswer
}

GetEnvironmentsByIdNotificationsResponse is the result of GetEnvironmentsByIdNotifications.

func (GetEnvironmentsByIdNotificationsResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetEnvironmentsByIdRemoteStacksDirAnswer ¶

type GetEnvironmentsByIdRemoteStacksDirAnswer struct {
	RemoteStacksDir string `json:"remoteStacksDir,omitempty"`
}

GetEnvironmentsByIdRemoteStacksDirAnswer is an object the document declares inline.

type GetEnvironmentsByIdRemoteStacksDirResponse ¶

type GetEnvironmentsByIdRemoteStacksDirResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdRemoteStacksDirAnswer
	*GetEnvironmentsByIdRemoteStacksDirAnswer
}

GetEnvironmentsByIdRemoteStacksDirResponse is the result of GetEnvironmentsByIdRemoteStacksDir.

Answer is the GetEnvironmentsByIdRemoteStacksDirAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdRemoteStacksDirResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdRemoteStacksDirResponse) Record ¶

Record is the GetEnvironmentsByIdRemoteStacksDirAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsByIdResponse ¶

type GetEnvironmentsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdAnswer
	*GetEnvironmentsByIdAnswer
}

GetEnvironmentsByIdResponse is the result of GetEnvironmentsById.

Answer is the GetEnvironmentsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdResponse) Answered ¶

func (r GetEnvironmentsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdResponse) Record ¶

Record is the GetEnvironmentsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsByIdTimezoneAnswer ¶

type GetEnvironmentsByIdTimezoneAnswer struct {
	Timezone string `json:"timezone"`
}

GetEnvironmentsByIdTimezoneAnswer is an object the document declares inline.

type GetEnvironmentsByIdTimezoneResponse ¶

type GetEnvironmentsByIdTimezoneResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdTimezoneAnswer
	*GetEnvironmentsByIdTimezoneAnswer
}

GetEnvironmentsByIdTimezoneResponse is the result of GetEnvironmentsByIdTimezone.

Answer is the GetEnvironmentsByIdTimezoneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdTimezoneResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdTimezoneResponse) Record ¶

Record is the GetEnvironmentsByIdTimezoneAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsByIdUpdateCheckAnswer ¶

type GetEnvironmentsByIdUpdateCheckAnswer struct {
	Settings *GetEnvironmentsByIdUpdateCheckAnswerSettings `json:"settings"`
}

GetEnvironmentsByIdUpdateCheckAnswer is an object the document declares inline.

type GetEnvironmentsByIdUpdateCheckAnswerSettings ¶

type GetEnvironmentsByIdUpdateCheckAnswerSettings struct {
	AutoUpdate            bool   `json:"autoUpdate"`
	Cron                  string `json:"cron"`
	Enabled               bool   `json:"enabled"`
	VulnerabilityCriteria string `json:"vulnerabilityCriteria"`
}

GetEnvironmentsByIdUpdateCheckAnswerSettings is an object the document declares inline.

type GetEnvironmentsByIdUpdateCheckResponse ¶

type GetEnvironmentsByIdUpdateCheckResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsByIdUpdateCheckAnswer
	*GetEnvironmentsByIdUpdateCheckAnswer
}

GetEnvironmentsByIdUpdateCheckResponse is the result of GetEnvironmentsByIdUpdateCheck.

Answer is the GetEnvironmentsByIdUpdateCheckAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsByIdUpdateCheckResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsByIdUpdateCheckResponse) Record ¶

Record is the GetEnvironmentsByIdUpdateCheckAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsDetectSocketAnswer ¶

type GetEnvironmentsDetectSocketAnswer struct {
	Homedir string                                     `json:"homedir"`
	Sockets []GetEnvironmentsDetectSocketAnswerSockets `json:"sockets"`
}

GetEnvironmentsDetectSocketAnswer is an object the document declares inline.

type GetEnvironmentsDetectSocketAnswerSockets ¶

type GetEnvironmentsDetectSocketAnswerSockets struct {
	Exists bool   `json:"exists"`
	Name   string `json:"name"`
	Path   string `json:"path"`
}

GetEnvironmentsDetectSocketAnswerSockets is an object the document declares inline.

type GetEnvironmentsDetectSocketResponse ¶

type GetEnvironmentsDetectSocketResponse struct {
	HttpResponse *http.Response
	Answer       *GetEnvironmentsDetectSocketAnswer
	*GetEnvironmentsDetectSocketAnswer
}

GetEnvironmentsDetectSocketResponse is the result of GetEnvironmentsDetectSocket.

Answer is the GetEnvironmentsDetectSocketAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetEnvironmentsDetectSocketResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetEnvironmentsDetectSocketResponse) Record ¶

Record is the GetEnvironmentsDetectSocketAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetEnvironmentsResponse ¶

type GetEnvironmentsResponse struct {
	HttpResponse *http.Response
	Answer       []GetEnvironmentsAnswer
}

GetEnvironmentsResponse is the result of GetEnvironments.

func (GetEnvironmentsResponse) Answered ¶

func (r GetEnvironmentsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetEventsOptions ¶

type GetEventsOptions struct {
	// Environment id — without it, an "info" SSE message is sent and the stream ends (from GET /api/environments)
	Env EnvironmentID
}

GetEventsOptions holds the query and header parameters of GetEvents.

func (GetEventsOptions) ToHeaders ¶

func (o GetEventsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetEventsOptions) ToQuery ¶

func (o GetEventsOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetEventsResponse ¶

type GetEventsResponse struct {
	HttpResponse *http.Response
}

GetEventsResponse is the result of GetEvents.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetEventsResponse) ContentLength ¶

func (r GetEventsResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetEventsResponse) Filename ¶

func (r GetEventsResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetEventsResponse) Reader ¶

func (r GetEventsResponse) Reader() (io.ReadCloser, string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetGitCredentialsAnswer ¶

type GetGitCredentialsAnswer struct {
	AuthType    GitAuthType     `json:"authType"`
	CreatedAt   Time            `json:"createdAt,omitzero"`
	HasPassword bool            `json:"hasPassword"`
	HasSshKey   bool            `json:"hasSshKey"`
	Id          GitCredentialID `json:"id"`
	Name        string          `json:"name"`
	UpdatedAt   Time            `json:"updatedAt,omitzero"`
	Username    string          `json:"username,omitempty"`
}

GetGitCredentialsAnswer is an object the document declares inline.

func (GetGitCredentialsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetGitCredentialsAnswer) GetName ¶

func (m GetGitCredentialsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetGitCredentialsByIdAnswer ¶

type GetGitCredentialsByIdAnswer struct {
	AuthType    GitAuthType     `json:"authType"`
	CreatedAt   Time            `json:"createdAt,omitzero"`
	HasPassword bool            `json:"hasPassword"`
	HasSshKey   bool            `json:"hasSshKey"`
	Id          GitCredentialID `json:"id"`
	Name        string          `json:"name"`
	UpdatedAt   Time            `json:"updatedAt,omitzero"`
	Username    string          `json:"username,omitempty"`
}

GetGitCredentialsByIdAnswer is an object the document declares inline.

func (GetGitCredentialsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetGitCredentialsByIdAnswer) GetName ¶

func (m GetGitCredentialsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetGitCredentialsByIdResponse ¶

type GetGitCredentialsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitCredentialsByIdAnswer
	*GetGitCredentialsByIdAnswer
}

GetGitCredentialsByIdResponse is the result of GetGitCredentialsById.

Answer is the GetGitCredentialsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitCredentialsByIdResponse) Answered ¶

func (r GetGitCredentialsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitCredentialsByIdResponse) Record ¶

Record is the GetGitCredentialsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetGitCredentialsResponse ¶

type GetGitCredentialsResponse struct {
	HttpResponse *http.Response
	Answer       []GetGitCredentialsAnswer
}

GetGitCredentialsResponse is the result of GetGitCredentials.

func (GetGitCredentialsResponse) Answered ¶

func (r GetGitCredentialsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetGitRepositoriesAnswer ¶

type GetGitRepositoriesAnswer struct {
	AutoUpdate         bool   `json:"autoUpdate"`
	AutoUpdateCron     string `json:"autoUpdateCron,omitempty"`
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`
	Branch             string `json:"branch"`

	// left from when a repository was itself deployed: always compose.yaml, and nothing sets it
	ComposePath string `json:"composePath,omitempty"`
	CreatedAt   Time   `json:"createdAt,omitzero"`

	// that credential's kind: none, password or ssh
	CredentialAuthType string          `json:"credentialAuthType,omitempty"`
	CredentialId       GitCredentialID `json:"credentialId,omitempty"`

	// the name of the credential it is fetched with; null for none
	CredentialName string `json:"credentialName,omitempty"`

	// left from when a repository was itself deployed: always null, and nothing sets it
	EnvironmentId EnvironmentID   `json:"environmentId,omitempty"`
	Id            GitRepositoryID `json:"id"`

	// the commit the repository's own copy is at, shortened
	LastCommit string `json:"lastCommit,omitempty"`

	// when the repository's own copy was last fetched, which no git stack uses
	LastSync  Time   `json:"lastSync,omitzero"`
	Name      string `json:"name"`
	SyncError string `json:"syncError,omitempty"`

	// pending for a copy never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`
	UpdatedAt  Time   `json:"updatedAt,omitzero"`
	Url        string `json:"url"`

	// always false: nothing in the API switches a repository's own webhook on
	WebhookEnabled bool   `json:"webhookEnabled"`
	WebhookSecret  string `json:"webhookSecret,omitempty"`
}

GetGitRepositoriesAnswer is an object the document declares inline.

func (GetGitRepositoriesAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetGitRepositoriesAnswer) GetName ¶

func (m GetGitRepositoriesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetGitRepositoriesByIdAnswer ¶

type GetGitRepositoriesByIdAnswer struct {
	AutoUpdate         bool   `json:"autoUpdate"`
	AutoUpdateCron     string `json:"autoUpdateCron,omitempty"`
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`
	Branch             string `json:"branch"`

	// left from when a repository was itself deployed: always compose.yaml, and nothing sets it
	ComposePath  string          `json:"composePath,omitempty"`
	CreatedAt    Time            `json:"createdAt,omitzero"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`

	// left from when a repository was itself deployed: always null, and nothing sets it
	EnvironmentId EnvironmentID   `json:"environmentId,omitempty"`
	Id            GitRepositoryID `json:"id"`

	// the commit the repository's own copy is at, shortened
	LastCommit string `json:"lastCommit,omitempty"`

	// when the repository's own copy was last fetched, which no git stack uses
	LastSync  Time   `json:"lastSync,omitzero"`
	Name      string `json:"name"`
	SyncError string `json:"syncError,omitempty"`

	// pending for a copy never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`
	UpdatedAt  Time   `json:"updatedAt,omitzero"`
	Url        string `json:"url"`

	// always false: nothing in the API switches a repository's own webhook on
	WebhookEnabled bool   `json:"webhookEnabled"`
	WebhookSecret  string `json:"webhookSecret,omitempty"`
}

GetGitRepositoriesByIdAnswer is an object the document declares inline.

func (GetGitRepositoriesByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetGitRepositoriesByIdAnswer) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetGitRepositoriesByIdResponse ¶

type GetGitRepositoriesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitRepositoriesByIdAnswer
	*GetGitRepositoriesByIdAnswer
}

GetGitRepositoriesByIdResponse is the result of GetGitRepositoriesById.

Answer is the GetGitRepositoriesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitRepositoriesByIdResponse) Answered ¶

func (r GetGitRepositoriesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitRepositoriesByIdResponse) Record ¶

Record is the GetGitRepositoriesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetGitRepositoriesByIdSyncAnswer ¶

type GetGitRepositoriesByIdSyncAnswer struct {
	// the commit the repository's own copy is at; none for one never fetched
	CurrentCommit string `json:"currentCommit,omitempty"`
	Error         string `json:"error,omitempty"`
	HasUpdates    bool   `json:"hasUpdates"`

	// the newest commit on the branch; unknown for a copy never fetched
	LatestCommit string `json:"latestCommit,omitempty"`
}

GetGitRepositoriesByIdSyncAnswer is an object the document declares inline.

type GetGitRepositoriesByIdSyncResponse ¶

type GetGitRepositoriesByIdSyncResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitRepositoriesByIdSyncAnswer
	*GetGitRepositoriesByIdSyncAnswer
}

GetGitRepositoriesByIdSyncResponse is the result of GetGitRepositoriesByIdSync.

Answer is the GetGitRepositoriesByIdSyncAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitRepositoriesByIdSyncResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitRepositoriesByIdSyncResponse) Record ¶

Record is the GetGitRepositoriesByIdSyncAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetGitRepositoriesResponse ¶

type GetGitRepositoriesResponse struct {
	HttpResponse *http.Response
	Answer       []GetGitRepositoriesAnswer
}

GetGitRepositoriesResponse is the result of GetGitRepositories.

func (GetGitRepositoriesResponse) Answered ¶

func (r GetGitRepositoriesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetGitStacksAnswer ¶

type GetGitStacksAnswer struct {
	// whether the stack is fetched and, when something changed, deployed on a schedule
	AutoUpdate     bool   `json:"autoUpdate"`
	AutoUpdateCron string `json:"autoUpdateCron,omitempty"`

	// a word for the schedule, as the web interface offers them: the cron beside it is what the schedule goes by
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`

	// the branch this stack follows; null for the repository's own
	Branch        string `json:"branch,omitempty"`
	BuildOnDeploy bool   `json:"buildOnDeploy"`

	// the compose file's path in the repository
	ComposePath string `json:"composePath,omitempty"`

	// the folder of the repository that is copied beside the compose file; null for the folder the compose file is in
	ContextDir string `json:"contextDir,omitempty"`
	CreatedAt  Time   `json:"createdAt,omitzero"`

	// one more .env file in the repository to fill the compose file in from; null for none
	EnvFilePath string `json:"envFilePath,omitempty"`

	// the environment the stack is deployed on; null for one made with none
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ForceRedeploy bool          `json:"forceRedeploy"`
	Id            GitStackID    `json:"id,omitempty"`

	// the commit last fetched, shortened
	LastCommit   string `json:"lastCommit,omitempty"`
	LastSync     Time   `json:"lastSync,omitzero"`
	NoBuildCache bool   `json:"noBuildCache"`

	// the repository the stack is deployed from
	Repository   *GetGitStacksAnswerRepository `json:"repository,omitempty"`
	RepositoryId GitRepositoryID               `json:"repositoryId,omitempty"`
	RepullImages bool                          `json:"repullImages"`
	StackName    string                        `json:"stackName,omitempty"`
	SyncError    string                        `json:"syncError,omitempty"`

	// pending for a stack never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`

	// the files last copied from the repository, each with a hash, as JSON in a text; absent in the list
	SyncedFiles    string `json:"syncedFiles,omitempty"`
	UpdatedAt      Time   `json:"updatedAt,omitzero"`
	WebhookEnabled bool   `json:"webhookEnabled"`

	// the webhook's secret, sent back whole as it was given; null for none
	WebhookSecret string `json:"webhookSecret,omitempty"`
}

GetGitStacksAnswer is an object the document declares inline.

type GetGitStacksAnswerRepository ¶

type GetGitStacksAnswerRepository struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Id           GitRepositoryID `json:"id,omitempty"`
	Name         string          `json:"name,omitempty"`
	Url          string          `json:"url,omitempty"`
}

GetGitStacksAnswerRepository is an object the document declares inline.

the repository the stack is deployed from

func (GetGitStacksAnswerRepository) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetGitStacksAnswerRepository) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetGitStacksByIdAnswer ¶

type GetGitStacksByIdAnswer struct {
	// whether the stack is fetched and, when something changed, deployed on a schedule
	AutoUpdate     bool   `json:"autoUpdate"`
	AutoUpdateCron string `json:"autoUpdateCron,omitempty"`

	// a word for the schedule, as the web interface offers them: the cron beside it is what the schedule goes by
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`

	// the branch this stack follows; null for the repository's own
	Branch        string `json:"branch,omitempty"`
	BuildOnDeploy bool   `json:"buildOnDeploy"`

	// the compose file's path in the repository
	ComposePath string `json:"composePath,omitempty"`

	// the folder of the repository that is copied beside the compose file; null for the folder the compose file is in
	ContextDir string `json:"contextDir,omitempty"`
	CreatedAt  Time   `json:"createdAt,omitzero"`

	// one more .env file in the repository to fill the compose file in from; null for none
	EnvFilePath string `json:"envFilePath,omitempty"`

	// the environment the stack is deployed on; null for one made with none
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ForceRedeploy bool          `json:"forceRedeploy"`
	Id            GitStackID    `json:"id,omitempty"`

	// the commit last fetched, shortened
	LastCommit   string `json:"lastCommit,omitempty"`
	LastSync     Time   `json:"lastSync,omitzero"`
	NoBuildCache bool   `json:"noBuildCache"`

	// the repository the stack is deployed from
	Repository   *GetGitStacksByIdAnswerRepository `json:"repository,omitempty"`
	RepositoryId GitRepositoryID                   `json:"repositoryId,omitempty"`
	RepullImages bool                              `json:"repullImages"`
	StackName    string                            `json:"stackName,omitempty"`
	SyncError    string                            `json:"syncError,omitempty"`

	// pending for a stack never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`

	// the files last copied from the repository, each with a hash, as JSON in a text; absent in the list
	SyncedFiles    string `json:"syncedFiles,omitempty"`
	UpdatedAt      Time   `json:"updatedAt,omitzero"`
	WebhookEnabled bool   `json:"webhookEnabled"`

	// the webhook's secret, sent back whole as it was given; null for none
	WebhookSecret string `json:"webhookSecret,omitempty"`
}

GetGitStacksByIdAnswer is an object the document declares inline.

type GetGitStacksByIdAnswerRepository ¶

type GetGitStacksByIdAnswerRepository struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Id           GitRepositoryID `json:"id,omitempty"`
	Name         string          `json:"name,omitempty"`
	Url          string          `json:"url,omitempty"`
}

GetGitStacksByIdAnswerRepository is an object the document declares inline.

the repository the stack is deployed from

func (GetGitStacksByIdAnswerRepository) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetGitStacksByIdAnswerRepository) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetGitStacksByIdEnvFilesAnswer ¶

type GetGitStacksByIdEnvFilesAnswer struct {
	Files []string `json:"files"`
}

GetGitStacksByIdEnvFilesAnswer is an object the document declares inline.

type GetGitStacksByIdEnvFilesResponse ¶

type GetGitStacksByIdEnvFilesResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitStacksByIdEnvFilesAnswer
	*GetGitStacksByIdEnvFilesAnswer
}

GetGitStacksByIdEnvFilesResponse is the result of GetGitStacksByIdEnvFiles.

Answer is the GetGitStacksByIdEnvFilesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitStacksByIdEnvFilesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitStacksByIdEnvFilesResponse) Record ¶

Record is the GetGitStacksByIdEnvFilesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetGitStacksByIdResponse ¶

type GetGitStacksByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitStacksByIdAnswer
	*GetGitStacksByIdAnswer
}

GetGitStacksByIdResponse is the result of GetGitStacksById.

Answer is the GetGitStacksByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitStacksByIdResponse) Answered ¶

func (r GetGitStacksByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitStacksByIdResponse) Record ¶

Record is the GetGitStacksByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetGitStacksByIdWebhookAnswer ¶

type GetGitStacksByIdWebhookAnswer struct {
	Error string `json:"error,omitempty"`

	// what compose printed, or that nothing had changed and nothing was deployed
	Output  string `json:"output,omitempty"`
	Skipped bool   `json:"skipped"`
	Success bool   `json:"success"`
}

GetGitStacksByIdWebhookAnswer is an object the document declares inline.

type GetGitStacksByIdWebhookOptions ¶

type GetGitStacksByIdWebhookOptions struct {
	// Webhook secret; required only if the stack has a webhook secret configured
	Secret string
}

GetGitStacksByIdWebhookOptions holds the query and header parameters of GetGitStacksByIdWebhook.

func (GetGitStacksByIdWebhookOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetGitStacksByIdWebhookOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetGitStacksByIdWebhookResponse ¶

type GetGitStacksByIdWebhookResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitStacksByIdWebhookAnswer
	*GetGitStacksByIdWebhookAnswer
}

GetGitStacksByIdWebhookResponse is the result of GetGitStacksByIdWebhook.

Answer is the GetGitStacksByIdWebhookAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitStacksByIdWebhookResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitStacksByIdWebhookResponse) Record ¶

Record is the GetGitStacksByIdWebhookAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetGitStacksOptions ¶

type GetGitStacksOptions struct {
	// Filter to a single environment id
	Env EnvironmentID
}

GetGitStacksOptions holds the query and header parameters of GetGitStacks.

func (GetGitStacksOptions) ToHeaders ¶

func (o GetGitStacksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetGitStacksOptions) ToQuery ¶

func (o GetGitStacksOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetGitStacksResponse ¶

type GetGitStacksResponse struct {
	HttpResponse *http.Response
	Answer       []GetGitStacksAnswer
}

GetGitStacksResponse is the result of GetGitStacks.

func (GetGitStacksResponse) Answered ¶

func (r GetGitStacksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetGitWebhookByIdAnswer ¶

type GetGitWebhookByIdAnswer struct {
	Error   string `json:"error,omitempty"`
	Success bool   `json:"success"`
}

GetGitWebhookByIdAnswer is an object the document declares inline.

type GetGitWebhookByIdOptions ¶

type GetGitWebhookByIdOptions struct {
	// Webhook secret; required only if the repository has a webhook secret configured
	Secret string
}

GetGitWebhookByIdOptions holds the query and header parameters of GetGitWebhookById.

func (GetGitWebhookByIdOptions) ToHeaders ¶

func (o GetGitWebhookByIdOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetGitWebhookByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetGitWebhookByIdResponse ¶

type GetGitWebhookByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetGitWebhookByIdAnswer
	*GetGitWebhookByIdAnswer
}

GetGitWebhookByIdResponse is the result of GetGitWebhookById.

Answer is the GetGitWebhookByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetGitWebhookByIdResponse) Answered ¶

func (r GetGitWebhookByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetGitWebhookByIdResponse) Record ¶

Record is the GetGitWebhookByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetHawserConnectAnswer ¶

type GetHawserConnectAnswer struct {
	ActiveConnections int                                 `json:"activeConnections"`
	Connections       []GetHawserConnectAnswerConnections `json:"connections"`
	Message           string                              `json:"message"`
	Protocol          string                              `json:"protocol"`
	Status            string                              `json:"status"`
}

GetHawserConnectAnswer is an object the document declares inline.

type GetHawserConnectAnswerConnections ¶

type GetHawserConnectAnswerConnections struct {
	AgentId       string        `json:"agentId,omitempty"`
	AgentName     string        `json:"agentName,omitempty"`
	AgentVersion  string        `json:"agentVersion,omitempty"`
	Capabilities  []string      `json:"capabilities,omitzero"`
	ConnectedAt   Time          `json:"connectedAt,omitzero"`
	DockerVersion string        `json:"dockerVersion,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId"`
	Hostname      string        `json:"hostname,omitempty"`
	LastHeartbeat Time          `json:"lastHeartbeat,omitzero"`
}

GetHawserConnectAnswerConnections is an object the document declares inline.

type GetHawserConnectResponse ¶

type GetHawserConnectResponse struct {
	HttpResponse *http.Response
	Answer       *GetHawserConnectAnswer
	*GetHawserConnectAnswer
}

GetHawserConnectResponse is the result of GetHawserConnect.

Answer is the GetHawserConnectAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetHawserConnectResponse) Answered ¶

func (r GetHawserConnectResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetHawserConnectResponse) Record ¶

Record is the GetHawserConnectAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetHawserTokensAnswer ¶

type GetHawserTokensAnswer struct {
	CreatedAt     Time          `json:"createdAt"`
	EnvironmentId EnvironmentID `json:"environmentId"`
	ExpiresAt     Time          `json:"expiresAt,omitzero"`
	Id            int           `json:"id"`
	IsActive      bool          `json:"isActive"`
	LastUsed      Time          `json:"lastUsed,omitzero"`
	Name          string        `json:"name"`
	TokenPrefix   string        `json:"tokenPrefix"`
}

GetHawserTokensAnswer is an object the document declares inline.

func (GetHawserTokensAnswer) GetId ¶

func (m GetHawserTokensAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetHawserTokensAnswer) GetName ¶

func (m GetHawserTokensAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetHawserTokensResponse ¶

type GetHawserTokensResponse struct {
	HttpResponse *http.Response
	Answer       []GetHawserTokensAnswer
}

GetHawserTokensResponse is the result of GetHawserTokens.

func (GetHawserTokensResponse) Answered ¶

func (r GetHawserTokensResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetHealthAnswer ¶

type GetHealthAnswer struct {
	Status    string `json:"status"`
	Timestamp Time   `json:"timestamp"`
}

GetHealthAnswer is an object the document declares inline.

type GetHealthDatabaseAnswer ¶

type GetHealthDatabaseAnswer struct {
	AppliedMigrations int `json:"appliedMigrations"`

	// where the database is: a file's path for SQLite
	Connection        string `json:"connection,omitempty"`
	Database          string `json:"database"`
	Healthy           bool   `json:"healthy"`
	MigrationsTable   bool   `json:"migrationsTable"`
	PendingMigrations int    `json:"pendingMigrations"`

	// the newest migration applied
	SchemaVersion string                         `json:"schemaVersion,omitempty"`
	Tables        *GetHealthDatabaseAnswerTables `json:"tables"`
	Timestamp     Time                           `json:"timestamp"`
}

GetHealthDatabaseAnswer is an object the document declares inline.

type GetHealthDatabaseAnswerTables ¶

type GetHealthDatabaseAnswerTables struct {
	Expected int      `json:"expected,omitempty"`
	Found    int      `json:"found,omitempty"`
	Missing  []string `json:"missing,omitzero"`
}

GetHealthDatabaseAnswerTables is an object the document declares inline.

type GetHealthDatabaseResponse ¶

type GetHealthDatabaseResponse struct {
	HttpResponse *http.Response
	Answer       *GetHealthDatabaseAnswer
	*GetHealthDatabaseAnswer
}

GetHealthDatabaseResponse is the result of GetHealthDatabase.

Answer is the GetHealthDatabaseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetHealthDatabaseResponse) Answered ¶

func (r GetHealthDatabaseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetHealthDatabaseResponse) Record ¶

Record is the GetHealthDatabaseAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetHealthResponse ¶

type GetHealthResponse struct {
	HttpResponse *http.Response
	Answer       *GetHealthAnswer
	*GetHealthAnswer
}

GetHealthResponse is the result of GetHealth.

Answer is the GetHealthAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetHealthResponse) Answered ¶

func (r GetHealthResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetHealthResponse) Record ¶

func (r GetHealthResponse) Record() (GetHealthAnswer, error)

Record is the GetHealthAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetHostAnswer ¶

type GetHostAnswer struct {
	Arch                    string         `json:"arch"`
	Cpus                    int            `json:"cpus"`
	DockerContainers        int            `json:"dockerContainers"`
	DockerContainersRunning int            `json:"dockerContainersRunning"`
	DockerImages            int            `json:"dockerImages"`
	DockerVersion           string         `json:"dockerVersion,omitempty"`
	Environment             map[string]any `json:"environment,omitzero"`
	FreeMemory              int            `json:"freeMemory"`
	Hostname                string         `json:"hostname"`
	IpAddress               string         `json:"ipAddress"`
	Platform                string         `json:"platform"`
	TotalMemory             int            `json:"totalMemory"`

	// how long the host has been up, in seconds
	Uptime float64 `json:"uptime"`
}

GetHostAnswer is an object the document declares inline.

type GetHostOptions ¶

type GetHostOptions struct {
	// ID of the environment to describe (basic local info is returned when omitted) (from GET /api/environments)
	Env EnvironmentID
}

GetHostOptions holds the query and header parameters of GetHost.

func (GetHostOptions) ToHeaders ¶

func (o GetHostOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetHostOptions) ToQuery ¶

func (o GetHostOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetHostResponse ¶

type GetHostResponse struct {
	HttpResponse *http.Response
	Answer       *GetHostAnswer
	*GetHostAnswer
}

GetHostResponse is the result of GetHost.

Answer is the GetHostAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetHostResponse) Answered ¶

func (r GetHostResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetHostResponse) Record ¶

func (r GetHostResponse) Record() (GetHostAnswer, error)

Record is the GetHostAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetIconsSelfhstByRefResponse ¶

type GetIconsSelfhstByRefResponse struct {
	HttpResponse *http.Response
}

GetIconsSelfhstByRefResponse is the result of GetIconsSelfhstByRef.

The operation answers image/*, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetIconsSelfhstByRefResponse) Bytes ¶

func (r GetIconsSelfhstByRefResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetIconsSelfhstByRefResponse) ContentLength ¶

func (r GetIconsSelfhstByRefResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetIconsSelfhstByRefResponse) Filename ¶

func (r GetIconsSelfhstByRefResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetIconsSelfhstByRefResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetIconsSelfhstByRefResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetIconsSelfhstManifestAnswer ¶

type GetIconsSelfhstManifestAnswer struct {
	Category  string `json:"Category,omitempty"`
	CreatedAt Time   `json:"CreatedAt,omitzero"`
	Dark      string `json:"Dark,omitempty"`

	// Yes when it has a form for a light background
	Light string `json:"Light,omitempty"`
	Name  string `json:"Name,omitempty"`
	PNG   string `json:"PNG,omitempty"`

	// what the icon is asked for by
	Reference string `json:"Reference,omitempty"`

	// Yes when it comes as SVG, and No
	SVG string `json:"SVG,omitempty"`

	// its tags, with commas between
	Tags string `json:"Tags,omitempty"`
	WebP string `json:"WebP,omitempty"`
}

GetIconsSelfhstManifestAnswer is an object the document declares inline.

type GetIconsSelfhstManifestResponse ¶

type GetIconsSelfhstManifestResponse struct {
	HttpResponse *http.Response
	Answer       []GetIconsSelfhstManifestAnswer
}

GetIconsSelfhstManifestResponse is the result of GetIconsSelfhstManifest.

func (GetIconsSelfhstManifestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetImagesAnswer ¶

type GetImagesAnswer struct {
	// how many containers on the host were made from it, running or not
	Containers int `json:"containers,omitempty"`

	// when the image was built, in seconds since 1970
	Created int `json:"created,omitempty"`

	// the image's whole id: sha256: and sixty-four characters
	Id     string            `json:"id,omitempty"`
	Labels map[string]string `json:"labels,omitzero"`

	// the image by the digest it was pulled as, for each repository it came from
	RepoDigests []string `json:"repoDigests,omitzero"`

	// every name and tag the image goes by on the host; none for an image left behind by a newer one of the same name
	RepoTags []string `json:"repoTags,omitzero"`

	// bytes
	Size int `json:"size,omitempty"`

	// the same again
	Tags        []string `json:"tags,omitzero"`
	VirtualSize int      `json:"virtualSize,omitempty"`
}

GetImagesAnswer is an object the document declares inline.

type GetImagesByIdExportOptions ¶

type GetImagesByIdExportOptions struct {
	// ID of the environment the image belongs to (from GET /api/environments)
	Env EnvironmentID

	// Which of the image's tags to name the download after (defaults to its first tag)
	Tag string

	// Gzip the tar stream and serve it as .tar.gz (default false)
	Compress *bool
}

GetImagesByIdExportOptions holds the query and header parameters of GetImagesByIdExport.

func (GetImagesByIdExportOptions) ToHeaders ¶

func (o GetImagesByIdExportOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetImagesByIdExportOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetImagesByIdExportResponse ¶

type GetImagesByIdExportResponse struct {
	HttpResponse *http.Response
}

GetImagesByIdExportResponse is the result of GetImagesByIdExport.

The operation answers application/x-tar, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetImagesByIdExportResponse) Bytes ¶

func (r GetImagesByIdExportResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetImagesByIdExportResponse) ContentLength ¶

func (r GetImagesByIdExportResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetImagesByIdExportResponse) Filename ¶

func (r GetImagesByIdExportResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetImagesByIdExportResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetImagesByIdExportResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetImagesByIdHistoryAnswer ¶

type GetImagesByIdHistoryAnswer struct {
	Comment   string `json:"Comment,omitempty"`
	Created   int    `json:"Created,omitempty"`
	CreatedBy string `json:"CreatedBy,omitempty"`
	Id        string `json:"Id,omitempty"`
	Size      int    `json:"Size,omitempty"`

	// the names and tags that point at this layer; none for a layer beneath the top one
	Tags []string `json:"Tags,omitzero"`
}

GetImagesByIdHistoryAnswer is an object the document declares inline.

type GetImagesByIdHistoryOptions ¶

type GetImagesByIdHistoryOptions struct {
	// ID of the environment the image belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetImagesByIdHistoryOptions holds the query and header parameters of GetImagesByIdHistory.

func (GetImagesByIdHistoryOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetImagesByIdHistoryOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetImagesByIdHistoryResponse ¶

type GetImagesByIdHistoryResponse struct {
	HttpResponse *http.Response
	Answer       []GetImagesByIdHistoryAnswer
}

GetImagesByIdHistoryResponse is the result of GetImagesByIdHistory.

func (GetImagesByIdHistoryResponse) Answered ¶

func (r GetImagesByIdHistoryResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetImagesOptions ¶

type GetImagesOptions struct {
	// ID of the environment whose images to list (from GET /api/environments)
	Env EnvironmentID
}

GetImagesOptions holds the query and header parameters of GetImages.

func (GetImagesOptions) ToHeaders ¶

func (o GetImagesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetImagesOptions) ToQuery ¶

func (o GetImagesOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetImagesResponse ¶

type GetImagesResponse struct {
	HttpResponse *http.Response
	Answer       []GetImagesAnswer
}

GetImagesResponse is the result of GetImages.

func (GetImagesResponse) Answered ¶

func (r GetImagesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetImagesScanAnswer ¶

type GetImagesScanAnswer struct {
	Found bool `json:"found"`

	// the latest scan kept of the image, by the scanner asked for or by whichever ran last; absent when none is kept
	Result *GetImagesScanAnswerResult `json:"result,omitempty"`
}

GetImagesScanAnswer is an object the document declares inline.

type GetImagesScanAnswerResult ¶

type GetImagesScanAnswerResult struct {
	CreatedAt     Time          `json:"createdAt,omitzero"`
	CriticalCount int           `json:"criticalCount,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`

	// why the scan failed; null for one that did not
	Error           string `json:"error,omitempty"`
	HighCount       int    `json:"highCount,omitempty"`
	Id              int    `json:"id,omitempty"`
	ImageId         string `json:"imageId,omitempty"`
	ImageName       string `json:"imageName,omitempty"`
	LowCount        int    `json:"lowCount,omitempty"`
	MediumCount     int    `json:"mediumCount,omitempty"`
	NegligibleCount int    `json:"negligibleCount,omitempty"`

	// how long the scan took, in milliseconds
	ScanDuration int  `json:"scanDuration,omitempty"`
	ScannedAt    Time `json:"scannedAt,omitzero"`

	// grype or trivy
	Scanner         Scanner                                    `json:"scanner,omitempty"`
	UnknownCount    int                                        `json:"unknownCount,omitempty"`
	Vulnerabilities []GetImagesScanAnswerResultVulnerabilities `json:"vulnerabilities,omitzero"`
}

GetImagesScanAnswerResult is an object the document declares inline.

the latest scan kept of the image, by the scanner asked for or by whichever ran last; absent when none is kept

type GetImagesScanAnswerResultVulnerabilities ¶

type GetImagesScanAnswerResultVulnerabilities struct {
	Description string `json:"description,omitempty"`

	// the version it is put right in; absent when none is known
	FixedVersion string `json:"fixedVersion,omitempty"`

	// the CVE, or the scanner's own id for what it found
	Id      string  `json:"id,omitempty"`
	Link    string  `json:"link,omitempty"`
	Package string  `json:"package,omitempty"`
	Scanner Scanner `json:"scanner,omitempty"`

	// critical, high, medium, low, negligible or unknown
	Severity Severity `json:"severity,omitempty"`

	// the version of the package the image has
	Version string `json:"version,omitempty"`
}

GetImagesScanAnswerResultVulnerabilities is an object the document declares inline.

type GetImagesScanExportOptions ¶

type GetImagesScanExportOptions struct {
	// Image SHA/ID to export (falls back to the "image" param when omitted) (from GET /api/images)
	ImageId string

	// Image name/ID used as a fallback when imageId is not given
	Image string

	// Output format — json (default), csv, or sarif
	Format string

	// the environment the image is on
	Env EnvironmentID
}

GetImagesScanExportOptions holds the query and header parameters of GetImagesScanExport.

func (GetImagesScanExportOptions) ToHeaders ¶

func (o GetImagesScanExportOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetImagesScanExportOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetImagesScanExportResponse ¶

type GetImagesScanExportResponse struct {
	HttpResponse *http.Response
}

GetImagesScanExportResponse is the result of GetImagesScanExport.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetImagesScanExportResponse) Bytes ¶

func (r GetImagesScanExportResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetImagesScanExportResponse) ContentLength ¶

func (r GetImagesScanExportResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetImagesScanExportResponse) Filename ¶

func (r GetImagesScanExportResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetImagesScanExportResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetImagesScanExportResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetImagesScanOptions ¶

type GetImagesScanOptions struct {
	// ID of the environment the image belongs to (from GET /api/environments)
	Env EnvironmentID

	// Image name or ID to look up cached results for
	Image string

	// Restrict the lookup to a specific scanner (e.g. grype or trivy)
	Scanner Scanner
}

GetImagesScanOptions holds the query and header parameters of GetImagesScan.

func (GetImagesScanOptions) ToHeaders ¶

func (o GetImagesScanOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetImagesScanOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetImagesScanResponse ¶

type GetImagesScanResponse struct {
	HttpResponse *http.Response
	Answer       *GetImagesScanAnswer
	*GetImagesScanAnswer
}

GetImagesScanResponse is the result of GetImagesScan.

Answer is the GetImagesScanAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetImagesScanResponse) Answered ¶

func (r GetImagesScanResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetImagesScanResponse) Record ¶

Record is the GetImagesScanAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetJobsByIdAnswer ¶

type GetJobsByIdAnswer struct {
	Id     string                   `json:"id"`
	Lines  []GetJobsByIdAnswerLines `json:"lines"`
	Result map[string]any           `json:"result,omitzero"`
	Status JobStatus                `json:"status"`
}

GetJobsByIdAnswer is an object the document declares inline.

type GetJobsByIdAnswerLines ¶

type GetJobsByIdAnswerLines struct {
	Data  map[string]any `json:"data,omitzero"`
	Event string         `json:"event,omitempty"`
}

GetJobsByIdAnswerLines is an object the document declares inline.

type GetJobsByIdResponse ¶

type GetJobsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetJobsByIdAnswer
	*GetJobsByIdAnswer
}

GetJobsByIdResponse is the result of GetJobsById.

Answer is the GetJobsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetJobsByIdResponse) Answered ¶

func (r GetJobsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetJobsByIdResponse) Record ¶

Record is the GetJobsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetLabelsAnswer ¶

type GetLabelsAnswer struct {
	// the colour of each label that has one, by the label's name
	Colors map[string]string       `json:"colors,omitzero"`
	Labels []GetLabelsAnswerLabels `json:"labels"`
}

GetLabelsAnswer is an object the document declares inline.

type GetLabelsAnswerLabels ¶

type GetLabelsAnswerLabels struct {
	Color        string                              `json:"color,omitempty"`
	Count        int                                 `json:"count"`
	Environments []GetLabelsAnswerLabelsEnvironments `json:"environments"`
	Label        string                              `json:"label"`
}

GetLabelsAnswerLabels is an object the document declares inline.

type GetLabelsAnswerLabelsEnvironments ¶

type GetLabelsAnswerLabelsEnvironments struct {
	EnvId   EnvironmentID `json:"envId"`
	EnvName string        `json:"envName"`
}

GetLabelsAnswerLabelsEnvironments is an object the document declares inline.

type GetLabelsResponse ¶

type GetLabelsResponse struct {
	HttpResponse *http.Response
	Answer       *GetLabelsAnswer
	*GetLabelsAnswer
}

GetLabelsResponse is the result of GetLabels.

Answer is the GetLabelsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetLabelsResponse) Answered ¶

func (r GetLabelsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetLabelsResponse) Record ¶

func (r GetLabelsResponse) Record() (GetLabelsAnswer, error)

Record is the GetLabelsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetLegalLicenseAnswer ¶

type GetLegalLicenseAnswer struct {
	Content string `json:"content"`
}

GetLegalLicenseAnswer is an object the document declares inline.

type GetLegalLicenseOptions ¶

type GetLegalLicenseOptions struct {
	// Set to "text" to return the raw license as text/plain instead of JSON
	Format string
}

GetLegalLicenseOptions holds the query and header parameters of GetLegalLicense.

func (GetLegalLicenseOptions) ToHeaders ¶

func (o GetLegalLicenseOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetLegalLicenseOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetLegalLicenseResponse ¶

type GetLegalLicenseResponse struct {
	HttpResponse *http.Response
	Answer       *GetLegalLicenseAnswer
	*GetLegalLicenseAnswer
}

GetLegalLicenseResponse is the result of GetLegalLicense.

Answer is the GetLegalLicenseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetLegalLicenseResponse) Answered ¶

func (r GetLegalLicenseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetLegalLicenseResponse) Record ¶

Record is the GetLegalLicenseAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetLegalPrivacyAnswer ¶

type GetLegalPrivacyAnswer struct {
	Content string `json:"content"`
}

GetLegalPrivacyAnswer is an object the document declares inline.

type GetLegalPrivacyOptions ¶

type GetLegalPrivacyOptions struct {
	// Set to "text" to return the raw privacy policy as text/plain instead of JSON
	Format string
}

GetLegalPrivacyOptions holds the query and header parameters of GetLegalPrivacy.

func (GetLegalPrivacyOptions) ToHeaders ¶

func (o GetLegalPrivacyOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetLegalPrivacyOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetLegalPrivacyResponse ¶

type GetLegalPrivacyResponse struct {
	HttpResponse *http.Response
	Answer       *GetLegalPrivacyAnswer
	*GetLegalPrivacyAnswer
}

GetLegalPrivacyResponse is the result of GetLegalPrivacy.

Answer is the GetLegalPrivacyAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetLegalPrivacyResponse) Answered ¶

func (r GetLegalPrivacyResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetLegalPrivacyResponse) Record ¶

Record is the GetLegalPrivacyAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetLicenseAnswer ¶

type GetLicenseAnswer struct {
	// whether a licence is in use
	Active bool `json:"active"`

	// the host name a licence is bound to, which is this server's own
	Hostname string `json:"hostname,omitempty"`
	Valid    bool   `json:"valid"`
}

GetLicenseAnswer is an object the document declares inline.

type GetLicenseResponse ¶

type GetLicenseResponse struct {
	HttpResponse *http.Response
	Answer       *GetLicenseAnswer
	*GetLicenseAnswer
}

GetLicenseResponse is the result of GetLicense.

Answer is the GetLicenseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetLicenseResponse) Answered ¶

func (r GetLicenseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetLicenseResponse) Record ¶

Record is the GetLicenseAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetLogsMergedOptions ¶

type GetLogsMergedOptions struct {
	// Comma-separated container IDs to merge logs from
	Containers string

	// Number of lines to tail per container (default 100)
	Tail string

	// Only return logs since this timestamp (Docker since format)
	Since string

	// Only return logs until this timestamp (Docker until format)
	Until string

	// Environment the containers belong to (from GET /api/environments)
	Env EnvironmentID
}

GetLogsMergedOptions holds the query and header parameters of GetLogsMerged.

func (GetLogsMergedOptions) ToHeaders ¶

func (o GetLogsMergedOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetLogsMergedOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetLogsMergedResponse ¶

type GetLogsMergedResponse struct {
	HttpResponse *http.Response
}

GetLogsMergedResponse is the result of GetLogsMerged.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetLogsMergedResponse) ContentLength ¶

func (r GetLogsMergedResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetLogsMergedResponse) Filename ¶

func (r GetLogsMergedResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetLogsMergedResponse) Reader ¶

func (r GetLogsMergedResponse) Reader() (io.ReadCloser, string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetMetricsResponse ¶

type GetMetricsResponse struct {
	HttpResponse *http.Response
}

GetMetricsResponse is the result of GetMetrics.

The operation answers text/plain, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetMetricsResponse) Bytes ¶

func (r GetMetricsResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetMetricsResponse) ContentLength ¶

func (r GetMetricsResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetMetricsResponse) Filename ¶

func (r GetMetricsResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetMetricsResponse) Reader ¶

func (r GetMetricsResponse) Reader() (io.ReadCloser, string)

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetMetricsResponse) WriteTo ¶

func (r GetMetricsResponse) WriteTo(w io.Writer) (int64, error)

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetNetworksAnswer ¶

type GetNetworksAnswer struct {
	// the containers on the network, by their whole id
	Containers map[string]GetNetworksAnswerContainers `json:"containers,omitzero"`

	// bridge for a network of the host's own, host and null for the two Docker always has, overlay for one a swarm shares
	Driver string `json:"driver,omitempty"`

	// the network's whole id, sixty-four characters
	Id string `json:"id,omitempty"`

	// whether the network is cut off from everything outside the host
	Internal bool                   `json:"internal"`
	Ipam     *GetNetworksAnswerIpam `json:"ipam,omitempty"`
	Name     string                 `json:"name,omitempty"`
	Scope    string                 `json:"scope,omitempty"`
}

GetNetworksAnswer is an object the document declares inline.

func (GetNetworksAnswer) GetId ¶

func (m GetNetworksAnswer) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (GetNetworksAnswer) GetName ¶

func (m GetNetworksAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetNetworksAnswerContainers ¶

type GetNetworksAnswerContainers struct {
	// the container's address on the network; empty while it is not running
	Ipv4Address string `json:"ipv4Address,omitempty"`
	Name        string `json:"name,omitempty"`
}

GetNetworksAnswerContainers is an object the document declares inline.

type GetNetworksAnswerIpam ¶

type GetNetworksAnswerIpam struct {
	Config []GetNetworksAnswerIpamConfig `json:"config,omitzero"`
	Driver string                        `json:"driver,omitempty"`
}

GetNetworksAnswerIpam is an object the document declares inline.

type GetNetworksAnswerIpamConfig ¶

type GetNetworksAnswerIpamConfig struct {
	Gateway string `json:"gateway,omitempty"`
	Subnet  string `json:"subnet,omitempty"`
}

GetNetworksAnswerIpamConfig is an object the document declares inline.

type GetNetworksByIdAnswer ¶

type GetNetworksByIdAnswer struct {
	Attachable bool `json:"Attachable"`

	// the running containers on the network, by their whole id
	Containers map[string]GetNetworksByIdAnswerContainers `json:"Containers,omitzero"`

	// when the network was made, as 2006-01-02T15:04:05.999999999Z
	Created    string                     `json:"Created,omitempty"`
	Driver     string                     `json:"Driver,omitempty"`
	EnableIPv4 bool                       `json:"EnableIPv4"`
	EnableIPv6 bool                       `json:"EnableIPv6"`
	IPAM       *GetNetworksByIdAnswerIPAM `json:"IPAM,omitempty"`
	Id         string                     `json:"Id"`
	Ingress    bool                       `json:"Ingress"`
	Internal   bool                       `json:"Internal"`
	Labels     map[string]string          `json:"Labels,omitzero"`
	Name       string                     `json:"Name"`
	Options    map[string]string          `json:"Options,omitzero"`
	Scope      string                     `json:"Scope,omitempty"`
}

GetNetworksByIdAnswer is an object the document declares inline.

func (GetNetworksByIdAnswer) GetId ¶

func (m GetNetworksByIdAnswer) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (GetNetworksByIdAnswer) GetName ¶

func (m GetNetworksByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetNetworksByIdAnswerContainers ¶

type GetNetworksByIdAnswerContainers struct {
	EndpointID string `json:"EndpointID,omitempty"`

	// the container's address on the network with the size of the range after it: 172.19.0.2/16
	IPv4Address string `json:"IPv4Address,omitempty"`
	IPv6Address string `json:"IPv6Address,omitempty"`
	MacAddress  string `json:"MacAddress,omitempty"`
	Name        string `json:"Name,omitempty"`
}

GetNetworksByIdAnswerContainers is an object the document declares inline.

type GetNetworksByIdAnswerIPAM ¶

type GetNetworksByIdAnswerIPAM struct {
	Config []GetNetworksByIdAnswerIPAMConfig `json:"Config,omitzero"`
	Driver string                            `json:"Driver,omitempty"`
}

GetNetworksByIdAnswerIPAM is an object the document declares inline.

type GetNetworksByIdAnswerIPAMConfig ¶

type GetNetworksByIdAnswerIPAMConfig struct {
	Gateway string `json:"Gateway,omitempty"`
	Subnet  string `json:"Subnet,omitempty"`
}

GetNetworksByIdAnswerIPAMConfig is an object the document declares inline.

type GetNetworksByIdInspectAnswer ¶

type GetNetworksByIdInspectAnswer struct {
	Attachable bool `json:"Attachable"`

	// the running containers on the network, by their whole id
	Containers map[string]GetNetworksByIdInspectAnswerContainers `json:"Containers,omitzero"`

	// when the network was made, as 2006-01-02T15:04:05.999999999Z
	Created    string                            `json:"Created,omitempty"`
	Driver     string                            `json:"Driver,omitempty"`
	EnableIPv4 bool                              `json:"EnableIPv4"`
	EnableIPv6 bool                              `json:"EnableIPv6"`
	IPAM       *GetNetworksByIdInspectAnswerIPAM `json:"IPAM,omitempty"`
	Id         string                            `json:"Id"`
	Ingress    bool                              `json:"Ingress"`
	Internal   bool                              `json:"Internal"`
	Labels     map[string]string                 `json:"Labels,omitzero"`
	Name       string                            `json:"Name"`
	Options    map[string]string                 `json:"Options,omitzero"`
	Scope      string                            `json:"Scope,omitempty"`
}

GetNetworksByIdInspectAnswer is an object the document declares inline.

func (GetNetworksByIdInspectAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetNetworksByIdInspectAnswer) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetNetworksByIdInspectAnswerContainers ¶

type GetNetworksByIdInspectAnswerContainers struct {
	EndpointID string `json:"EndpointID,omitempty"`

	// the container's address on the network with the size of the range after it: 172.19.0.2/16
	IPv4Address string `json:"IPv4Address,omitempty"`
	IPv6Address string `json:"IPv6Address,omitempty"`
	MacAddress  string `json:"MacAddress,omitempty"`
	Name        string `json:"Name,omitempty"`
}

GetNetworksByIdInspectAnswerContainers is an object the document declares inline.

type GetNetworksByIdInspectAnswerIPAM ¶

type GetNetworksByIdInspectAnswerIPAM struct {
	Config []GetNetworksByIdInspectAnswerIPAMConfig `json:"Config,omitzero"`
	Driver string                                   `json:"Driver,omitempty"`
}

GetNetworksByIdInspectAnswerIPAM is an object the document declares inline.

type GetNetworksByIdInspectAnswerIPAMConfig ¶

type GetNetworksByIdInspectAnswerIPAMConfig struct {
	Gateway string `json:"Gateway,omitempty"`
	Subnet  string `json:"Subnet,omitempty"`
}

GetNetworksByIdInspectAnswerIPAMConfig is an object the document declares inline.

type GetNetworksByIdInspectOptions ¶

type GetNetworksByIdInspectOptions struct {
	// Environment the network belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetNetworksByIdInspectOptions holds the query and header parameters of GetNetworksByIdInspect.

func (GetNetworksByIdInspectOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetNetworksByIdInspectOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetNetworksByIdInspectResponse ¶

type GetNetworksByIdInspectResponse struct {
	HttpResponse *http.Response
	Answer       *GetNetworksByIdInspectAnswer
	*GetNetworksByIdInspectAnswer
}

GetNetworksByIdInspectResponse is the result of GetNetworksByIdInspect.

Answer is the GetNetworksByIdInspectAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetNetworksByIdInspectResponse) Answered ¶

func (r GetNetworksByIdInspectResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetNetworksByIdInspectResponse) Record ¶

Record is the GetNetworksByIdInspectAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetNetworksByIdOptions ¶

type GetNetworksByIdOptions struct {
	// Environment the network belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetNetworksByIdOptions holds the query and header parameters of GetNetworksById.

func (GetNetworksByIdOptions) ToHeaders ¶

func (o GetNetworksByIdOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetNetworksByIdOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetNetworksByIdResponse ¶

type GetNetworksByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetNetworksByIdAnswer
	*GetNetworksByIdAnswer
}

GetNetworksByIdResponse is the result of GetNetworksById.

Answer is the GetNetworksByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetNetworksByIdResponse) Answered ¶

func (r GetNetworksByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetNetworksByIdResponse) Record ¶

Record is the GetNetworksByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetNetworksOptions ¶

type GetNetworksOptions struct {
	// Environment ID to list networks from (from GET /api/environments)
	Env EnvironmentID
}

GetNetworksOptions holds the query and header parameters of GetNetworks.

func (GetNetworksOptions) ToHeaders ¶

func (o GetNetworksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetNetworksOptions) ToQuery ¶

func (o GetNetworksOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetNetworksResponse ¶

type GetNetworksResponse struct {
	HttpResponse *http.Response
	Answer       []GetNetworksAnswer
}

GetNetworksResponse is the result of GetNetworks.

func (GetNetworksResponse) Answered ¶

func (r GetNetworksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetNotificationsAnswer ¶

type GetNotificationsAnswer struct {
	Config     *GetNotificationsAnswerConfig `json:"config,omitempty"`
	CreatedAt  Time                          `json:"createdAt,omitzero"`
	Enabled    bool                          `json:"enabled"`
	EventTypes []string                      `json:"eventTypes,omitzero"`
	Id         NotificationID                `json:"id"`
	Name       string                        `json:"name"`
	Type       NotificationType              `json:"type"`
	UpdatedAt  Time                          `json:"updatedAt,omitzero"`
}

GetNotificationsAnswer is an object the document declares inline.

func (GetNotificationsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetNotificationsAnswer) GetName ¶

func (m GetNotificationsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetNotificationsAnswerConfig ¶

type GetNotificationsAnswerConfig struct {
	FromEmail string `json:"from_email,omitempty"`
	FromName  string `json:"from_name,omitempty"`
	Host      string `json:"host,omitempty"`

	// for mail: eight asterisks where a password is kept, never the password
	Password string   `json:"password,omitempty"`
	Port     int      `json:"port,omitempty"`
	Secure   bool     `json:"secure"`
	ToEmails []string `json:"to_emails,omitzero"`

	// for a channel that is not mail: the addresses it sends to, in full, with whatever token or login each carries
	Urls     []string `json:"urls,omitzero"`
	Username string   `json:"username,omitempty"`
}

GetNotificationsAnswerConfig is an object the document declares inline.

type GetNotificationsByIdAnswer ¶

type GetNotificationsByIdAnswer struct {
	Config     *GetNotificationsByIdAnswerConfig `json:"config,omitempty"`
	CreatedAt  Time                              `json:"createdAt,omitzero"`
	Enabled    bool                              `json:"enabled"`
	EventTypes []string                          `json:"eventTypes,omitzero"`
	Id         NotificationID                    `json:"id"`
	Name       string                            `json:"name"`
	Type       NotificationType                  `json:"type"`
	UpdatedAt  Time                              `json:"updatedAt,omitzero"`
}

GetNotificationsByIdAnswer is an object the document declares inline.

func (GetNotificationsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetNotificationsByIdAnswer) GetName ¶

func (m GetNotificationsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetNotificationsByIdAnswerConfig ¶

type GetNotificationsByIdAnswerConfig struct {
	FromEmail string `json:"from_email,omitempty"`
	FromName  string `json:"from_name,omitempty"`
	Host      string `json:"host,omitempty"`

	// for mail: eight asterisks where a password is kept, never the password
	Password string   `json:"password,omitempty"`
	Port     int      `json:"port,omitempty"`
	Secure   bool     `json:"secure"`
	ToEmails []string `json:"to_emails,omitzero"`

	// for a channel that is not mail: the addresses it sends to, in full, with whatever token or login each carries
	Urls     []string `json:"urls,omitzero"`
	Username string   `json:"username,omitempty"`
}

GetNotificationsByIdAnswerConfig is an object the document declares inline.

type GetNotificationsByIdResponse ¶

type GetNotificationsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetNotificationsByIdAnswer
	*GetNotificationsByIdAnswer
}

GetNotificationsByIdResponse is the result of GetNotificationsById.

Answer is the GetNotificationsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetNotificationsByIdResponse) Answered ¶

func (r GetNotificationsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetNotificationsByIdResponse) Record ¶

Record is the GetNotificationsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetNotificationsResponse ¶

type GetNotificationsResponse struct {
	HttpResponse *http.Response
	Answer       []GetNotificationsAnswer
}

GetNotificationsResponse is the result of GetNotifications.

func (GetNotificationsResponse) Answered ¶

func (r GetNotificationsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetNotificationsTriggerTestAnswer ¶

type GetNotificationsTriggerTestAnswer struct {
	Categories *GetNotificationsTriggerTestAnswerCategories  `json:"categories,omitempty"`
	EventTypes []GetNotificationsTriggerTestAnswerEventTypes `json:"eventTypes,omitzero"`
}

GetNotificationsTriggerTestAnswer is an object the document declares inline.

type GetNotificationsTriggerTestAnswerCategories ¶

type GetNotificationsTriggerTestAnswerCategories struct {
	AutoUpdate []string `json:"autoUpdate,omitzero"`
	Container  []string `json:"container,omitzero"`
	GitStack   []string `json:"gitStack,omitzero"`
	Security   []string `json:"security,omitzero"`
	Stack      []string `json:"stack,omitzero"`
	System     []string `json:"system,omitzero"`
}

GetNotificationsTriggerTestAnswerCategories is an object the document declares inline.

type GetNotificationsTriggerTestAnswerEventTypes ¶

type GetNotificationsTriggerTestAnswerEventTypes struct {
	Description string `json:"description,omitempty"`

	// container, auto_update, git_stack, stack, security or system
	Group string `json:"group,omitempty"`
	Id    string `json:"id"`
	Label string `json:"label,omitempty"`

	// environment for what happens on a host, which a channel is told of through its link to that environment, or system
	Scope EventScope `json:"scope,omitempty"`
}

GetNotificationsTriggerTestAnswerEventTypes is an object the document declares inline.

type GetNotificationsTriggerTestResponse ¶

type GetNotificationsTriggerTestResponse struct {
	HttpResponse *http.Response
	Answer       *GetNotificationsTriggerTestAnswer
	*GetNotificationsTriggerTestAnswer
}

GetNotificationsTriggerTestResponse is the result of GetNotificationsTriggerTest.

Answer is the GetNotificationsTriggerTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetNotificationsTriggerTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetNotificationsTriggerTestResponse) Record ¶

Record is the GetNotificationsTriggerTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetPreferencesEnvironmentOrderAnswer ¶

type GetPreferencesEnvironmentOrderAnswer struct {
	Order []int `json:"order,omitzero"`
}

GetPreferencesEnvironmentOrderAnswer is an object the document declares inline.

type GetPreferencesEnvironmentOrderResponse ¶

type GetPreferencesEnvironmentOrderResponse struct {
	HttpResponse *http.Response
	Answer       *GetPreferencesEnvironmentOrderAnswer
	*GetPreferencesEnvironmentOrderAnswer
}

GetPreferencesEnvironmentOrderResponse is the result of GetPreferencesEnvironmentOrder.

Answer is the GetPreferencesEnvironmentOrderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetPreferencesEnvironmentOrderResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetPreferencesEnvironmentOrderResponse) Record ¶

Record is the GetPreferencesEnvironmentOrderAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetPreferencesFavoriteGroupsAnswer ¶

type GetPreferencesFavoriteGroupsAnswer struct {
	// everything kept for the environment's log view, in order: a container's name as a text, and a group as a record of its name and its containers
	Groups []any `json:"groups,omitzero"`
}

GetPreferencesFavoriteGroupsAnswer is an object the document declares inline.

type GetPreferencesFavoriteGroupsOptions ¶

type GetPreferencesFavoriteGroupsOptions struct {
	// Environment ID (from GET /api/environments)
	Env EnvironmentID
}

GetPreferencesFavoriteGroupsOptions holds the query and header parameters of GetPreferencesFavoriteGroups.

func (GetPreferencesFavoriteGroupsOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetPreferencesFavoriteGroupsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetPreferencesFavoriteGroupsResponse ¶

type GetPreferencesFavoriteGroupsResponse struct {
	HttpResponse *http.Response
	Answer       *GetPreferencesFavoriteGroupsAnswer
	*GetPreferencesFavoriteGroupsAnswer
}

GetPreferencesFavoriteGroupsResponse is the result of GetPreferencesFavoriteGroups.

Answer is the GetPreferencesFavoriteGroupsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetPreferencesFavoriteGroupsResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetPreferencesFavoriteGroupsResponse) Record ¶

Record is the GetPreferencesFavoriteGroupsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetPreferencesFavoritesAnswer ¶

type GetPreferencesFavoritesAnswer struct {
	// everything kept for the environment's log view, in order: a container's name as a text, and a group as a record of its name and its containers
	Favorites []any `json:"favorites,omitzero"`
}

GetPreferencesFavoritesAnswer is an object the document declares inline.

type GetPreferencesFavoritesOptions ¶

type GetPreferencesFavoritesOptions struct {
	// Environment ID (from GET /api/environments)
	Env EnvironmentID
}

GetPreferencesFavoritesOptions holds the query and header parameters of GetPreferencesFavorites.

func (GetPreferencesFavoritesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetPreferencesFavoritesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetPreferencesFavoritesResponse ¶

type GetPreferencesFavoritesResponse struct {
	HttpResponse *http.Response
	Answer       *GetPreferencesFavoritesAnswer
	*GetPreferencesFavoritesAnswer
}

GetPreferencesFavoritesResponse is the result of GetPreferencesFavorites.

Answer is the GetPreferencesFavoritesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetPreferencesFavoritesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetPreferencesFavoritesResponse) Record ¶

Record is the GetPreferencesFavoritesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetPreferencesGridAnswer ¶

type GetPreferencesGridAnswer struct {
	// the columns saved for each grid, by the grid's id
	Preferences map[string]GetPreferencesGridAnswerPreferences `json:"preferences,omitzero"`
}

GetPreferencesGridAnswer is an object the document declares inline.

type GetPreferencesGridAnswerPreferences ¶

type GetPreferencesGridAnswerPreferences struct {
	Columns []GetPreferencesGridAnswerPreferencesColumns `json:"columns,omitzero"`
}

GetPreferencesGridAnswerPreferences is an object the document declares inline.

type GetPreferencesGridAnswerPreferencesColumns ¶

type GetPreferencesGridAnswerPreferencesColumns struct {
	Id      string `json:"id,omitempty"`
	Visible bool   `json:"visible"`
}

GetPreferencesGridAnswerPreferencesColumns is an object the document declares inline.

type GetPreferencesGridResponse ¶

type GetPreferencesGridResponse struct {
	HttpResponse *http.Response
	Answer       *GetPreferencesGridAnswer
	*GetPreferencesGridAnswer
}

GetPreferencesGridResponse is the result of GetPreferencesGrid.

Answer is the GetPreferencesGridAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetPreferencesGridResponse) Answered ¶

func (r GetPreferencesGridResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetPreferencesGridResponse) Record ¶

Record is the GetPreferencesGridAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetPreferencesSidebarAnswer ¶

type GetPreferencesSidebarAnswer struct {
	Preferences *GetPreferencesSidebarAnswerPreferences `json:"preferences,omitempty"`
}

GetPreferencesSidebarAnswer is an object the document declares inline.

type GetPreferencesSidebarAnswerPreferences ¶

type GetPreferencesSidebarAnswerPreferences struct {
	Hidden []string `json:"hidden,omitzero"`
	Order  []string `json:"order,omitzero"`
}

GetPreferencesSidebarAnswerPreferences is an object the document declares inline.

type GetPreferencesSidebarResponse ¶

type GetPreferencesSidebarResponse struct {
	HttpResponse *http.Response
	Answer       *GetPreferencesSidebarAnswer
	*GetPreferencesSidebarAnswer
}

GetPreferencesSidebarResponse is the result of GetPreferencesSidebar.

Answer is the GetPreferencesSidebarAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetPreferencesSidebarResponse) Answered ¶

func (r GetPreferencesSidebarResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetPreferencesSidebarResponse) Record ¶

Record is the GetPreferencesSidebarAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetPreferencesTagOrderAnswer ¶

type GetPreferencesTagOrderAnswer struct {
	Order []int `json:"order,omitzero"`
}

GetPreferencesTagOrderAnswer is an object the document declares inline.

type GetPreferencesTagOrderResponse ¶

type GetPreferencesTagOrderResponse struct {
	HttpResponse *http.Response
	Answer       *GetPreferencesTagOrderAnswer
	*GetPreferencesTagOrderAnswer
}

GetPreferencesTagOrderResponse is the result of GetPreferencesTagOrder.

Answer is the GetPreferencesTagOrderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetPreferencesTagOrderResponse) Answered ¶

func (r GetPreferencesTagOrderResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetPreferencesTagOrderResponse) Record ¶

Record is the GetPreferencesTagOrderAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetProfileAnswer ¶

type GetProfileAnswer struct {
	Avatar      string `json:"avatar,omitempty"`
	CreatedAt   Time   `json:"createdAt"`
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Id          int    `json:"id"`
	IsAdmin     bool   `json:"isAdmin"`
	LastLogin   Time   `json:"lastLogin,omitzero"`
	MfaEnabled  bool   `json:"mfaEnabled"`
	Provider    string `json:"provider"`
	UpdatedAt   Time   `json:"updatedAt"`
	Username    string `json:"username"`
}

GetProfileAnswer is an object the document declares inline.

type GetProfilePreferencesResponse ¶

type GetProfilePreferencesResponse struct {
	HttpResponse *http.Response
	Answer       json.RawMessage
}

GetProfilePreferencesResponse is the result of GetProfilePreferences.

func (GetProfilePreferencesResponse) Answered ¶

func (r GetProfilePreferencesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetProfileResponse ¶

type GetProfileResponse struct {
	HttpResponse *http.Response
	Answer       *GetProfileAnswer
	*GetProfileAnswer
}

GetProfileResponse is the result of GetProfile.

Answer is the GetProfileAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetProfileResponse) Answered ¶

func (r GetProfileResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetProfileResponse) Record ¶

Record is the GetProfileAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetRegistriesAnswer ¶

type GetRegistriesAnswer struct {
	CreatedAt      Time       `json:"createdAt,omitzero"`
	HasCredentials bool       `json:"hasCredentials"`
	Id             RegistryID `json:"id"`
	IsDefault      bool       `json:"isDefault"`
	Name           string     `json:"name"`
	UpdatedAt      Time       `json:"updatedAt,omitzero"`
	Url            string     `json:"url"`

	// the user name it signs in to the registry with; null for one with no credentials
	Username string `json:"username,omitempty"`
}

GetRegistriesAnswer is an object the document declares inline.

func (GetRegistriesAnswer) GetId ¶

func (m GetRegistriesAnswer) GetId() RegistryID

GetId is the record's Id, for code that handles records of several types alike.

func (GetRegistriesAnswer) GetName ¶

func (m GetRegistriesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetRegistriesByIdAnswer ¶

type GetRegistriesByIdAnswer struct {
	CreatedAt      Time       `json:"createdAt,omitzero"`
	HasCredentials bool       `json:"hasCredentials"`
	Id             RegistryID `json:"id"`
	IsDefault      bool       `json:"isDefault"`
	Name           string     `json:"name"`
	UpdatedAt      Time       `json:"updatedAt,omitzero"`
	Url            string     `json:"url"`

	// the user name it signs in to the registry with; null for one with no credentials
	Username string `json:"username,omitempty"`
}

GetRegistriesByIdAnswer is an object the document declares inline.

func (GetRegistriesByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetRegistriesByIdAnswer) GetName ¶

func (m GetRegistriesByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetRegistriesByIdResponse ¶

type GetRegistriesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetRegistriesByIdAnswer
	*GetRegistriesByIdAnswer
}

GetRegistriesByIdResponse is the result of GetRegistriesById.

Answer is the GetRegistriesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetRegistriesByIdResponse) Answered ¶

func (r GetRegistriesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetRegistriesByIdResponse) Record ¶

Record is the GetRegistriesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetRegistriesResponse ¶

type GetRegistriesResponse struct {
	HttpResponse *http.Response
	Answer       []GetRegistriesAnswer
}

GetRegistriesResponse is the result of GetRegistries.

func (GetRegistriesResponse) Answered ¶

func (r GetRegistriesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetRegistryCatalogAnswer ¶

type GetRegistryCatalogAnswer struct {
	Pagination   *GetRegistryCatalogAnswerPagination    `json:"pagination"`
	Repositories []GetRegistryCatalogAnswerRepositories `json:"repositories"`
}

GetRegistryCatalogAnswer is an object the document declares inline.

type GetRegistryCatalogAnswerPagination ¶

type GetRegistryCatalogAnswerPagination struct {
	HasMore  bool   `json:"hasMore"`
	NextLast string `json:"nextLast,omitempty"`
	PageSize int    `json:"pageSize"`
}

GetRegistryCatalogAnswerPagination is an object the document declares inline.

type GetRegistryCatalogAnswerRepositories ¶

type GetRegistryCatalogAnswerRepositories struct {
	Description string `json:"description,omitempty"`
	IsAutomated bool   `json:"is_automated"`
	IsOfficial  bool   `json:"is_official"`
	Name        string `json:"name"`
	StarCount   int    `json:"star_count,omitempty"`
}

GetRegistryCatalogAnswerRepositories is an object the document declares inline.

type GetRegistryCatalogOptions ¶

type GetRegistryCatalogOptions struct {
	// ID of the configured registry to query (from GET /api/registries)
	Registry RegistryID

	// Opaque pagination cursor from a previous page's nextLast
	Last string
}

GetRegistryCatalogOptions holds the query and header parameters of GetRegistryCatalog.

func (GetRegistryCatalogOptions) ToHeaders ¶

func (o GetRegistryCatalogOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetRegistryCatalogOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetRegistryCatalogResponse ¶

type GetRegistryCatalogResponse struct {
	HttpResponse *http.Response
	Answer       *GetRegistryCatalogAnswer
	*GetRegistryCatalogAnswer
}

GetRegistryCatalogResponse is the result of GetRegistryCatalog.

Answer is the GetRegistryCatalogAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetRegistryCatalogResponse) Answered ¶

func (r GetRegistryCatalogResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetRegistryCatalogResponse) Record ¶

Record is the GetRegistryCatalogAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetRegistrySearchAnswer ¶

type GetRegistrySearchAnswer struct {
	Description string `json:"description,omitempty"`
	IsAutomated bool   `json:"is_automated"`
	IsOfficial  bool   `json:"is_official"`
	Name        string `json:"name"`
	StarCount   int    `json:"star_count,omitempty"`
}

GetRegistrySearchAnswer is an object the document declares inline.

type GetRegistrySearchOptions ¶

type GetRegistrySearchOptions struct {
	// Search term / image name
	Term string

	// Maximum number of results (default 25)
	Limit *int

	// ID of the configured registry to search; omit to search Docker Hub (from GET /api/registries)
	Registry RegistryID
}

GetRegistrySearchOptions holds the query and header parameters of GetRegistrySearch.

func (GetRegistrySearchOptions) ToHeaders ¶

func (o GetRegistrySearchOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetRegistrySearchOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetRegistrySearchResponse ¶

type GetRegistrySearchResponse struct {
	HttpResponse *http.Response
	Answer       []GetRegistrySearchAnswer
}

GetRegistrySearchResponse is the result of GetRegistrySearch.

func (GetRegistrySearchResponse) Answered ¶

func (r GetRegistrySearchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetRegistryTagInfoAnswer ¶

type GetRegistryTagInfoAnswer struct {
	LastUpdated Time    `json:"lastUpdated,omitzero"`
	Reason      string  `json:"reason,omitempty"`
	Size        float64 `json:"size,omitempty"`
}

GetRegistryTagInfoAnswer is an object the document declares inline.

type GetRegistryTagInfoOptions ¶

type GetRegistryTagInfoOptions struct {
	// Registry ID; omitted or Docker Hub registries return a graceful "not supported" result instead of a manifest fetch (from GET /api/registries)
	Registry RegistryID

	// Image repository/name
	Image string

	// Tag name or digest
	Tag string
}

GetRegistryTagInfoOptions holds the query and header parameters of GetRegistryTagInfo.

func (GetRegistryTagInfoOptions) ToHeaders ¶

func (o GetRegistryTagInfoOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetRegistryTagInfoOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetRegistryTagInfoResponse ¶

type GetRegistryTagInfoResponse struct {
	HttpResponse *http.Response
	Answer       *GetRegistryTagInfoAnswer
	*GetRegistryTagInfoAnswer
}

GetRegistryTagInfoResponse is the result of GetRegistryTagInfo.

Answer is the GetRegistryTagInfoAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetRegistryTagInfoResponse) Answered ¶

func (r GetRegistryTagInfoResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetRegistryTagInfoResponse) Record ¶

Record is the GetRegistryTagInfoAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetRegistryTagsAnswer ¶

type GetRegistryTagsAnswer struct {
	HasNext  bool                        `json:"hasNext"`
	HasPrev  bool                        `json:"hasPrev"`
	Page     int                         `json:"page"`
	PageSize int                         `json:"pageSize"`
	Tags     []GetRegistryTagsAnswerTags `json:"tags"`
	Total    int                         `json:"total"`
}

GetRegistryTagsAnswer is an object the document declares inline.

type GetRegistryTagsAnswerTags ¶

type GetRegistryTagsAnswerTags struct {
	Digest      string `json:"digest,omitempty"`
	LastUpdated Time   `json:"lastUpdated,omitzero"`
	Name        string `json:"name"`
	Size        int    `json:"size,omitempty"`
}

GetRegistryTagsAnswerTags is an object the document declares inline.

type GetRegistryTagsOptions ¶

type GetRegistryTagsOptions struct {
	// ID of the configured registry; omit to query Docker Hub (from GET /api/registries)
	Registry RegistryID

	// Repository/image name
	Image string

	// Page number for Docker Hub pagination (default 1)
	Page *int

	// Page size for Docker Hub pagination (default 20)
	PageSize *int
}

GetRegistryTagsOptions holds the query and header parameters of GetRegistryTags.

func (GetRegistryTagsOptions) ToHeaders ¶

func (o GetRegistryTagsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetRegistryTagsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetRegistryTagsResponse ¶

type GetRegistryTagsResponse struct {
	HttpResponse *http.Response
	Answer       *GetRegistryTagsAnswer
	*GetRegistryTagsAnswer
}

GetRegistryTagsResponse is the result of GetRegistryTags.

Answer is the GetRegistryTagsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetRegistryTagsResponse) Answered ¶

func (r GetRegistryTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetRegistryTagsResponse) Record ¶

Record is the GetRegistryTagsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetRolesAnswer ¶

type GetRolesAnswer struct {
	Description string         `json:"description,omitempty"`
	Id          RoleID         `json:"id"`
	IsSystem    bool           `json:"isSystem"`
	Name        string         `json:"name"`
	Permissions map[string]any `json:"permissions,omitzero"`
}

GetRolesAnswer is an object the document declares inline.

func (GetRolesAnswer) GetId ¶

func (m GetRolesAnswer) GetId() RoleID

GetId is the record's Id, for code that handles records of several types alike.

func (GetRolesAnswer) GetName ¶

func (m GetRolesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetRolesByIdAnswer ¶

type GetRolesByIdAnswer struct {
	Description string         `json:"description,omitempty"`
	Id          RoleID         `json:"id"`
	IsSystem    bool           `json:"isSystem"`
	Name        string         `json:"name"`
	Permissions map[string]any `json:"permissions,omitzero"`
}

GetRolesByIdAnswer is an object the document declares inline.

func (GetRolesByIdAnswer) GetId ¶

func (m GetRolesByIdAnswer) GetId() RoleID

GetId is the record's Id, for code that handles records of several types alike.

func (GetRolesByIdAnswer) GetName ¶

func (m GetRolesByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetRolesByIdResponse ¶

type GetRolesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetRolesByIdAnswer
	*GetRolesByIdAnswer
}

GetRolesByIdResponse is the result of GetRolesById.

Answer is the GetRolesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetRolesByIdResponse) Answered ¶

func (r GetRolesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetRolesByIdResponse) Record ¶

Record is the GetRolesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetRolesResponse ¶

type GetRolesResponse struct {
	HttpResponse *http.Response
	Answer       []GetRolesAnswer
}

GetRolesResponse is the result of GetRoles.

func (GetRolesResponse) Answered ¶

func (r GetRolesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetSchedulesAnswer ¶

type GetSchedulesAnswer struct {
	Schedules []GetSchedulesAnswerSchedules `json:"schedules"`
}

GetSchedulesAnswer is an object the document declares inline.

type GetSchedulesAnswerSchedules ¶

type GetSchedulesAnswerSchedules struct {
	CronExpression string `json:"cronExpression,omitempty"`

	// what the schedule does, in words; null for a container's update
	Description     string        `json:"description,omitempty"`
	Enabled         bool          `json:"enabled"`
	EntityName      string        `json:"entityName"`
	EnvironmentId   EnvironmentID `json:"environmentId,omitempty"`
	EnvironmentName string        `json:"environmentName,omitempty"`
	Id              int           `json:"id"`
	IsSystem        bool          `json:"isSystem"`

	// its latest run, with what it logged; null for one that has never run
	LastExecution *GetSchedulesAnswerSchedulesLastExecution `json:"lastExecution,omitempty"`
	Name          string                                    `json:"name"`
	NextRun       Time                                      `json:"nextRun,omitzero"`

	// for an image prune: dangling or all
	PruneMode string `json:"pruneMode,omitempty"`

	// its latest few runs, the latest first
	RecentExecutions []GetSchedulesAnswerSchedulesRecentExecutions `json:"recentExecutions,omitzero"`

	// how its time was given: daily, weekly or custom
	ScheduleType string       `json:"scheduleType,omitempty"`
	Type         ScheduleType `json:"type"`
}

GetSchedulesAnswerSchedules is an object the document declares inline.

func (GetSchedulesAnswerSchedules) GetId ¶

func (m GetSchedulesAnswerSchedules) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (GetSchedulesAnswerSchedules) GetName ¶

func (m GetSchedulesAnswerSchedules) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetSchedulesAnswerSchedulesLastExecution ¶

type GetSchedulesAnswerSchedulesLastExecution struct {
	CompletedAt Time `json:"completedAt,omitzero"`
	CreatedAt   Time `json:"createdAt,omitzero"`

	// what the run did, by its kind: what a prune removed, what a check found, why an update was skipped
	Details map[string]any `json:"details,omitzero"`

	// how long it took, in milliseconds
	Duration int `json:"duration,omitempty"`

	// what the run was of: a container, an environment, a stack or a system job, by name
	EntityName    string        `json:"entityName,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ErrorMessage  string        `json:"errorMessage,omitempty"`
	Id            int           `json:"id,omitempty"`

	// what the run logged, where one run is read; null in a list of runs
	Logs string `json:"logs,omitempty"`

	// the schedule's number among those of its type; 0 for a run that belongs to no schedule, as a stack brought up by hand
	ScheduleId   int    `json:"scheduleId,omitempty"`
	ScheduleType string `json:"scheduleType,omitempty"`
	StartedAt    Time   `json:"startedAt,omitzero"`

	// queued, running, success, warning, failed or skipped
	Status      RunStatus `json:"status,omitempty"`
	TriggeredAt Time      `json:"triggeredAt,omitzero"`

	// cron, manual or webhook
	TriggeredBy string `json:"triggeredBy,omitempty"`
}

GetSchedulesAnswerSchedulesLastExecution is an object the document declares inline.

its latest run, with what it logged; null for one that has never run

type GetSchedulesAnswerSchedulesRecentExecutions ¶

type GetSchedulesAnswerSchedulesRecentExecutions struct {
	CompletedAt Time `json:"completedAt,omitzero"`
	CreatedAt   Time `json:"createdAt,omitzero"`

	// what the run did, by its kind: what a prune removed, what a check found, why an update was skipped
	Details map[string]any `json:"details,omitzero"`

	// how long it took, in milliseconds
	Duration int `json:"duration,omitempty"`

	// what the run was of: a container, an environment, a stack or a system job, by name
	EntityName    string        `json:"entityName,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ErrorMessage  string        `json:"errorMessage,omitempty"`
	Id            int           `json:"id,omitempty"`

	// what the run logged, where one run is read; null in a list of runs
	Logs string `json:"logs,omitempty"`

	// the schedule's number among those of its type; 0 for a run that belongs to no schedule, as a stack brought up by hand
	ScheduleId   int    `json:"scheduleId,omitempty"`
	ScheduleType string `json:"scheduleType,omitempty"`
	StartedAt    Time   `json:"startedAt,omitzero"`

	// queued, running, success, warning, failed or skipped
	Status      RunStatus `json:"status,omitempty"`
	TriggeredAt Time      `json:"triggeredAt,omitzero"`

	// cron, manual or webhook
	TriggeredBy string `json:"triggeredBy,omitempty"`
}

GetSchedulesAnswerSchedulesRecentExecutions is an object the document declares inline.

type GetSchedulesExecutionsAnswer ¶

type GetSchedulesExecutionsAnswer struct {
	Executions []GetSchedulesExecutionsAnswerExecutions `json:"executions"`
	Limit      int                                      `json:"limit"`
	Offset     int                                      `json:"offset"`
	Total      int                                      `json:"total"`
}

GetSchedulesExecutionsAnswer is an object the document declares inline.

type GetSchedulesExecutionsAnswerExecutions ¶

type GetSchedulesExecutionsAnswerExecutions struct {
	CompletedAt Time `json:"completedAt,omitzero"`
	CreatedAt   Time `json:"createdAt,omitzero"`

	// what the run did, by its kind: what a prune removed, what a check found, why an update was skipped
	Details map[string]any `json:"details,omitzero"`

	// how long it took, in milliseconds
	Duration int `json:"duration,omitempty"`

	// what the run was of: a container, an environment, a stack or a system job, by name
	EntityName    string        `json:"entityName,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ErrorMessage  string        `json:"errorMessage,omitempty"`
	Id            int           `json:"id,omitempty"`

	// what the run logged, where one run is read; null in a list of runs
	Logs string `json:"logs,omitempty"`

	// the schedule's number among those of its type; 0 for a run that belongs to no schedule, as a stack brought up by hand
	ScheduleId   int    `json:"scheduleId,omitempty"`
	ScheduleType string `json:"scheduleType,omitempty"`
	StartedAt    Time   `json:"startedAt,omitzero"`

	// queued, running, success, warning, failed or skipped
	Status      RunStatus `json:"status,omitempty"`
	TriggeredAt Time      `json:"triggeredAt,omitzero"`

	// cron, manual or webhook
	TriggeredBy string `json:"triggeredBy,omitempty"`
}

GetSchedulesExecutionsAnswerExecutions is an object the document declares inline.

type GetSchedulesExecutionsByIdAnswer ¶

type GetSchedulesExecutionsByIdAnswer struct {
	CompletedAt Time `json:"completedAt,omitzero"`
	CreatedAt   Time `json:"createdAt,omitzero"`

	// what the run did, by its kind: what a prune removed, what a check found, why an update was skipped
	Details map[string]any `json:"details,omitzero"`

	// how long it took, in milliseconds
	Duration int `json:"duration,omitempty"`

	// what the run was of: a container, an environment, a stack or a system job, by name
	EntityName    string        `json:"entityName,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ErrorMessage  string        `json:"errorMessage,omitempty"`
	Id            int           `json:"id,omitempty"`

	// what the run logged, where one run is read; null in a list of runs
	Logs string `json:"logs,omitempty"`

	// the schedule's number among those of its type; 0 for a run that belongs to no schedule, as a stack brought up by hand
	ScheduleId   int    `json:"scheduleId,omitempty"`
	ScheduleType string `json:"scheduleType,omitempty"`
	StartedAt    Time   `json:"startedAt,omitzero"`

	// queued, running, success, warning, failed or skipped
	Status      RunStatus `json:"status,omitempty"`
	TriggeredAt Time      `json:"triggeredAt,omitzero"`

	// cron, manual or webhook
	TriggeredBy string `json:"triggeredBy,omitempty"`
}

GetSchedulesExecutionsByIdAnswer is an object the document declares inline.

type GetSchedulesExecutionsByIdResponse ¶

type GetSchedulesExecutionsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetSchedulesExecutionsByIdAnswer
	*GetSchedulesExecutionsByIdAnswer
}

GetSchedulesExecutionsByIdResponse is the result of GetSchedulesExecutionsById.

Answer is the GetSchedulesExecutionsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSchedulesExecutionsByIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSchedulesExecutionsByIdResponse) Record ¶

Record is the GetSchedulesExecutionsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSchedulesExecutionsOptions ¶

type GetSchedulesExecutionsOptions struct {
	// Filter by schedule type (container_update, git_stack_sync, ...)
	ScheduleType string

	// Filter by the numeric id of the schedule (from GET /api/schedules)
	ScheduleId *int

	// Filter by environment id ("null" for global/system schedules) (from GET /api/environments)
	EnvironmentId EnvironmentID

	// Filter by execution status (queued/running/success/warning/failed/skipped)
	Status RunStatus

	// Comma-separated list of statuses (alternative to status)
	Statuses string

	// Filter by trigger (cron/webhook/manual)
	TriggeredBy string

	// ISO date lower bound
	FromDate string

	// ISO date upper bound
	ToDate string

	// Page size (default 50)
	Limit *int

	// Page offset (default 0)
	Offset *int
}

GetSchedulesExecutionsOptions holds the query and header parameters of GetSchedulesExecutions.

func (GetSchedulesExecutionsOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetSchedulesExecutionsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetSchedulesExecutionsResponse ¶

type GetSchedulesExecutionsResponse struct {
	HttpResponse *http.Response
	Answer       *GetSchedulesExecutionsAnswer
	*GetSchedulesExecutionsAnswer
}

GetSchedulesExecutionsResponse is the result of GetSchedulesExecutions.

Answer is the GetSchedulesExecutionsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSchedulesExecutionsResponse) Answered ¶

func (r GetSchedulesExecutionsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSchedulesExecutionsResponse) Record ¶

Record is the GetSchedulesExecutionsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSchedulesResponse ¶

type GetSchedulesResponse struct {
	HttpResponse *http.Response
	Answer       *GetSchedulesAnswer
	*GetSchedulesAnswer
}

GetSchedulesResponse is the result of GetSchedules.

Answer is the GetSchedulesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSchedulesResponse) Answered ¶

func (r GetSchedulesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSchedulesResponse) Record ¶

Record is the GetSchedulesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSchedulesSettingsAnswer ¶

type GetSchedulesSettingsAnswer struct {
	HideSystemJobs bool `json:"hideSystemJobs"`
}

GetSchedulesSettingsAnswer is an object the document declares inline.

type GetSchedulesSettingsResponse ¶

type GetSchedulesSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *GetSchedulesSettingsAnswer
	*GetSchedulesSettingsAnswer
}

GetSchedulesSettingsResponse is the result of GetSchedulesSettings.

Answer is the GetSchedulesSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSchedulesSettingsResponse) Answered ¶

func (r GetSchedulesSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSchedulesSettingsResponse) Record ¶

Record is the GetSchedulesSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSchedulesStreamResponse ¶

type GetSchedulesStreamResponse struct {
	HttpResponse *http.Response
}

GetSchedulesStreamResponse is the result of GetSchedulesStream.

The operation answers text/event-stream, left open in HttpResponse.Body: Reader hands it over for the caller to read event by event and close; it has no end to copy to.

func (GetSchedulesStreamResponse) ContentLength ¶

func (r GetSchedulesStreamResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetSchedulesStreamResponse) Filename ¶

func (r GetSchedulesStreamResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetSchedulesStreamResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

type GetSecretProvidersAnswer ¶

type GetSecretProvidersAnswer struct {
	// when it was made, as the server writes it
	CreatedAt Time               `json:"createdAt,omitzero"`
	Id        SecretProviderID   `json:"id"`
	Name      string             `json:"name"`
	Type      SecretProviderType `json:"type"`

	// when it was last changed, which is written another way once it has been
	UpdatedAt Time `json:"updatedAt,omitzero"`
}

GetSecretProvidersAnswer is an object the document declares inline.

func (GetSecretProvidersAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetSecretProvidersAnswer) GetName ¶

func (m GetSecretProvidersAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetSecretProvidersByIdAnswer ¶

type GetSecretProvidersByIdAnswer struct {
	Config map[string]any `json:"config"`

	// when it was made, as the server writes it
	CreatedAt   Time                                      `json:"createdAt,omitzero"`
	Id          SecretProviderID                          `json:"id"`
	Name        string                                    `json:"name"`
	StacksUsing []GetSecretProvidersByIdAnswerStacksUsing `json:"stacksUsing"`
	Type        SecretProviderType                        `json:"type"`

	// when it was last changed, which is written another way once it has been
	UpdatedAt Time `json:"updatedAt,omitzero"`
}

GetSecretProvidersByIdAnswer is an object the document declares inline.

func (GetSecretProvidersByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetSecretProvidersByIdAnswer) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetSecretProvidersByIdAnswerStacksUsing ¶

type GetSecretProvidersByIdAnswerStacksUsing struct {
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	StackName     string        `json:"stackName"`
}

GetSecretProvidersByIdAnswerStacksUsing is an object the document declares inline.

type GetSecretProvidersByIdResponse ¶

type GetSecretProvidersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetSecretProvidersByIdAnswer
	*GetSecretProvidersByIdAnswer
}

GetSecretProvidersByIdResponse is the result of GetSecretProvidersById.

Answer is the GetSecretProvidersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSecretProvidersByIdResponse) Answered ¶

func (r GetSecretProvidersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSecretProvidersByIdResponse) Record ¶

Record is the GetSecretProvidersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSecretProvidersDefaultAnswer ¶

type GetSecretProvidersDefaultAnswer struct {
	ProviderId SecretProviderID `json:"providerId,omitempty"`
}

GetSecretProvidersDefaultAnswer is an object the document declares inline.

type GetSecretProvidersDefaultResponse ¶

type GetSecretProvidersDefaultResponse struct {
	HttpResponse *http.Response
	Answer       *GetSecretProvidersDefaultAnswer
	*GetSecretProvidersDefaultAnswer
}

GetSecretProvidersDefaultResponse is the result of GetSecretProvidersDefault.

Answer is the GetSecretProvidersDefaultAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSecretProvidersDefaultResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSecretProvidersDefaultResponse) Record ¶

Record is the GetSecretProvidersDefaultAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSecretProvidersResponse ¶

type GetSecretProvidersResponse struct {
	HttpResponse *http.Response
	Answer       []GetSecretProvidersAnswer
}

GetSecretProvidersResponse is the result of GetSecretProviders.

func (GetSecretProvidersResponse) Answered ¶

func (r GetSecretProvidersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetSelfUpdateCheckAnswer ¶

type GetSelfUpdateCheckAnswer struct {
	ContainerName    string `json:"containerName,omitempty"`
	CurrentDigest    string `json:"currentDigest,omitempty"`
	CurrentImage     string `json:"currentImage,omitempty"`
	Error            string `json:"error,omitempty"`
	IsComposeManaged bool   `json:"isComposeManaged"`
	IsLocalImage     bool   `json:"isLocalImage"`
	LatestVersion    string `json:"latestVersion,omitempty"`
	NewDigest        string `json:"newDigest,omitempty"`
	NewImage         string `json:"newImage,omitempty"`
	UpdateAvailable  bool   `json:"updateAvailable"`
}

GetSelfUpdateCheckAnswer is an object the document declares inline.

type GetSelfUpdateCheckResponse ¶

type GetSelfUpdateCheckResponse struct {
	HttpResponse *http.Response
	Answer       *GetSelfUpdateCheckAnswer
	*GetSelfUpdateCheckAnswer
}

GetSelfUpdateCheckResponse is the result of GetSelfUpdateCheck.

Answer is the GetSelfUpdateCheckAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSelfUpdateCheckResponse) Answered ¶

func (r GetSelfUpdateCheckResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSelfUpdateCheckResponse) Record ¶

Record is the GetSelfUpdateCheckAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSelfUpdateProgressAnswer ¶

type GetSelfUpdateProgressAnswer struct {
	ExitCode int    `json:"exitCode,omitempty"`
	Logs     string `json:"logs"`
	Status   string `json:"status"`
}

GetSelfUpdateProgressAnswer is an object the document declares inline.

type GetSelfUpdateProgressOptions ¶

type GetSelfUpdateProgressOptions struct {
	// Updater container id (from POST /api/self-update)
	Id string
}

GetSelfUpdateProgressOptions holds the query and header parameters of GetSelfUpdateProgress.

func (GetSelfUpdateProgressOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetSelfUpdateProgressOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetSelfUpdateProgressResponse ¶

type GetSelfUpdateProgressResponse struct {
	HttpResponse *http.Response
	Answer       *GetSelfUpdateProgressAnswer
	*GetSelfUpdateProgressAnswer
}

GetSelfUpdateProgressResponse is the result of GetSelfUpdateProgress.

Answer is the GetSelfUpdateProgressAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSelfUpdateProgressResponse) Answered ¶

func (r GetSelfUpdateProgressResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSelfUpdateProgressResponse) Record ¶

Record is the GetSelfUpdateProgressAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSettingsGeneralAnswer ¶

type GetSettingsGeneralAnswer struct {
	ActionIconSize            string   `json:"actionIconSize,omitempty"`
	AnimateIcons              bool     `json:"animateIcons"`
	ColoredActionButtons      bool     `json:"coloredActionButtons"`
	CompactPorts              bool     `json:"compactPorts"`
	ConfirmDestructive        bool     `json:"confirmDestructive"`
	DarkTheme                 string   `json:"darkTheme,omitempty"`
	DateFormat                string   `json:"dateFormat,omitempty"`
	DefaultBackupImage        string   `json:"defaultBackupImage,omitempty"`
	DefaultComposeTemplate    string   `json:"defaultComposeTemplate,omitempty"`
	DefaultGrypeArgs          string   `json:"defaultGrypeArgs,omitempty"`
	DefaultGrypeImage         string   `json:"defaultGrypeImage,omitempty"`
	DefaultScannerDns         []string `json:"defaultScannerDns,omitzero"`
	DefaultScannerNetworkMode string   `json:"defaultScannerNetworkMode,omitempty"`
	DefaultTimezone           string   `json:"defaultTimezone,omitempty"`
	DefaultTrivyArgs          string   `json:"defaultTrivyArgs,omitempty"`
	DefaultTrivyImage         string   `json:"defaultTrivyImage,omitempty"`
	DeployLogReconcileCron    string   `json:"deployLogReconcileCron,omitempty"`
	DeployLogReconcileEnabled bool     `json:"deployLogReconcileEnabled"`
	DownloadFormat            string   `json:"downloadFormat,omitempty"`
	EditorFont                string   `json:"editorFont,omitempty"`
	EditorIndentGuides        bool     `json:"editorIndentGuides"`
	EditorTheme               string   `json:"editorTheme,omitempty"`
	EventCleanupCron          string   `json:"eventCleanupCron,omitempty"`
	EventCleanupEnabled       bool     `json:"eventCleanupEnabled"`
	EventCollectionMode       string   `json:"eventCollectionMode,omitempty"`
	EventPollInterval         int      `json:"eventPollInterval,omitempty"`
	EventRetentionDays        int      `json:"eventRetentionDays,omitempty"`

	// paths, as the list the server takes and answers
	ExternalStackPaths        []string `json:"externalStackPaths,omitzero"`
	Font                      string   `json:"font,omitempty"`
	FontSize                  string   `json:"fontSize,omitempty"`
	FormatLogTimestamps       bool     `json:"formatLogTimestamps"`
	GridFontSize              string   `json:"gridFontSize,omitempty"`
	HighlightUpdates          bool     `json:"highlightUpdates"`
	HonorProxyLabels          bool     `json:"honorProxyLabels"`
	LabelFilterMode           string   `json:"labelFilterMode,omitempty"`
	LightTheme                string   `json:"lightTheme,omitempty"`
	LogBufferSizeKb           int      `json:"logBufferSizeKb,omitempty"`
	LogMaxLines               int      `json:"logMaxLines,omitempty"`
	MetricsCollectionInterval int      `json:"metricsCollectionInterval,omitempty"`
	PrimaryStackLocation      string   `json:"primaryStackLocation,omitempty"`
	ProtectScannerImages      bool     `json:"protectScannerImages"`
	ScanRetentionCron         string   `json:"scanRetentionCron,omitempty"`
	ScanRetentionEnabled      bool     `json:"scanRetentionEnabled"`
	ScanRetentionGraceDays    int      `json:"scanRetentionGraceDays,omitempty"`
	ScanRetentionKeep         int      `json:"scanRetentionKeep,omitempty"`
	ScannerCleanupCron        string   `json:"scannerCleanupCron,omitempty"`
	ScannerCleanupEnabled     bool     `json:"scannerCleanupEnabled"`
	ScheduleCleanupCron       string   `json:"scheduleCleanupCron,omitempty"`
	ScheduleCleanupEnabled    bool     `json:"scheduleCleanupEnabled"`
	ScheduleRetentionDays     int      `json:"scheduleRetentionDays,omitempty"`
	ShowExposedPorts          bool     `json:"showExposedPorts"`
	ShowGitCommitHash         bool     `json:"showGitCommitHash"`
	ShowImageChangelogLinks   bool     `json:"showImageChangelogLinks"`
	ShowStoppedContainers     bool     `json:"showStoppedContainers"`
	ShowWhatsNew              bool     `json:"showWhatsNew"`
	StackLogOperations        []string `json:"stackLogOperations,omitzero"`
	TerminalFont              string   `json:"terminalFont,omitempty"`
	TimeFormat                string   `json:"timeFormat,omitempty"`
	UseSelfhstIcons           bool     `json:"useSelfhstIcons"`
}

GetSettingsGeneralAnswer is an object the document declares inline.

type GetSettingsGeneralResponse ¶

type GetSettingsGeneralResponse struct {
	HttpResponse *http.Response
	Answer       *GetSettingsGeneralAnswer
	*GetSettingsGeneralAnswer
}

GetSettingsGeneralResponse is the result of GetSettingsGeneral.

Answer is the GetSettingsGeneralAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSettingsGeneralResponse) Answered ¶

func (r GetSettingsGeneralResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSettingsGeneralResponse) Record ¶

Record is the GetSettingsGeneralAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSettingsNavigationAnswer ¶

type GetSettingsNavigationAnswer struct {
	Effective *GetSettingsNavigationAnswerEffective `json:"effective,omitempty"`
	Global    *GetSettingsNavigationAnswerGlobal    `json:"global,omitempty"`
	User      *GetSettingsNavigationAnswerUser      `json:"user,omitempty"`
}

GetSettingsNavigationAnswer is an object the document declares inline.

type GetSettingsNavigationAnswerEffective ¶

type GetSettingsNavigationAnswerEffective struct {
	EnvClickPage string `json:"envClickPage"`
	LandingPage  string `json:"landingPage"`
}

GetSettingsNavigationAnswerEffective is an object the document declares inline.

type GetSettingsNavigationAnswerGlobal ¶

type GetSettingsNavigationAnswerGlobal struct {
	EnvClickPage string `json:"envClickPage,omitempty"`
	LandingPage  string `json:"landingPage,omitempty"`
}

GetSettingsNavigationAnswerGlobal is an object the document declares inline.

type GetSettingsNavigationAnswerUser ¶

type GetSettingsNavigationAnswerUser struct {
	EnvClickPage string `json:"envClickPage,omitempty"`
	LandingPage  string `json:"landingPage,omitempty"`
}

GetSettingsNavigationAnswerUser is an object the document declares inline.

type GetSettingsNavigationResponse ¶

type GetSettingsNavigationResponse struct {
	HttpResponse *http.Response
	Answer       *GetSettingsNavigationAnswer
	*GetSettingsNavigationAnswer
}

GetSettingsNavigationResponse is the result of GetSettingsNavigation.

Answer is the GetSettingsNavigationAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSettingsNavigationResponse) Answered ¶

func (r GetSettingsNavigationResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSettingsNavigationResponse) Record ¶

Record is the GetSettingsNavigationAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSettingsScannerAnswer ¶

type GetSettingsScannerAnswer struct {
	// whether the environment has each scanner's image; absent when settingsOnly is asked
	Availability *GetSettingsScannerAnswerAvailability `json:"availability,omitempty"`
	Defaults     *GetSettingsScannerAnswerDefaults     `json:"defaults,omitempty"`

	// with checkNewerVersions: the newest release of each scanner
	NewerVersions *GetSettingsScannerAnswerNewerVersions `json:"newerVersions,omitempty"`
	Settings      *GetSettingsScannerAnswerSettings      `json:"settings,omitempty"`

	// with checkUpdates: whether the registry has a newer image under the same tag
	Updates *GetSettingsScannerAnswerUpdates `json:"updates,omitempty"`

	// the version each scanner says it is, where Dockhand could tell; null where it could not or the image is not there
	Versions *GetSettingsScannerAnswerVersions `json:"versions,omitempty"`
}

GetSettingsScannerAnswer is an object the document declares inline.

type GetSettingsScannerAnswerAvailability ¶

type GetSettingsScannerAnswerAvailability struct {
	Grype bool `json:"grype"`
	Trivy bool `json:"trivy"`
}

GetSettingsScannerAnswerAvailability is an object the document declares inline.

whether the environment has each scanner's image; absent when settingsOnly is asked

type GetSettingsScannerAnswerDefaults ¶

type GetSettingsScannerAnswerDefaults struct {
	Dns []string `json:"dns,omitzero"`

	// what grype is run with, {image} standing for the image
	GrypeArgs string `json:"grypeArgs,omitempty"`

	// the image grype is run from, which is the same for every environment
	GrypeImage  string `json:"grypeImage,omitempty"`
	NetworkMode string `json:"networkMode,omitempty"`

	// what trivy is run with, {image} standing for the image
	TrivyArgs string `json:"trivyArgs,omitempty"`

	// the image trivy is run from, which is the same for every environment
	TrivyImage string `json:"trivyImage,omitempty"`
}

GetSettingsScannerAnswerDefaults is an object the document declares inline.

type GetSettingsScannerAnswerNewerVersions ¶

type GetSettingsScannerAnswerNewerVersions struct {
	Grype *GetSettingsScannerAnswerNewerVersionsGrype `json:"grype,omitempty"`
	Trivy *GetSettingsScannerAnswerNewerVersionsTrivy `json:"trivy,omitempty"`
}

GetSettingsScannerAnswerNewerVersions is an object the document declares inline.

with checkNewerVersions: the newest release of each scanner

type GetSettingsScannerAnswerNewerVersionsGrype ¶

type GetSettingsScannerAnswerNewerVersionsGrype struct {
	Current string `json:"current,omitempty"`

	// the newest release there is; null when it could not be told
	Latest string `json:"latest,omitempty"`
}

GetSettingsScannerAnswerNewerVersionsGrype is an object the document declares inline.

type GetSettingsScannerAnswerNewerVersionsTrivy ¶

type GetSettingsScannerAnswerNewerVersionsTrivy struct {
	Current string `json:"current,omitempty"`

	// the newest release there is; null when it could not be told
	Latest string `json:"latest,omitempty"`
}

GetSettingsScannerAnswerNewerVersionsTrivy is an object the document declares inline.

type GetSettingsScannerAnswerSettings ¶

type GetSettingsScannerAnswerSettings struct {
	// what grype is run with, {image} standing for the image
	GrypeArgs string `json:"grypeArgs,omitempty"`

	// the image grype is run from, which is the same for every environment
	GrypeImage string `json:"grypeImage,omitempty"`

	// what the environment's images are scanned with: none, grype, trivy or both
	Scanner Scanner `json:"scanner,omitempty"`

	// what trivy is run with, {image} standing for the image
	TrivyArgs string `json:"trivyArgs,omitempty"`

	// the image trivy is run from, which is the same for every environment
	TrivyImage string `json:"trivyImage,omitempty"`
}

GetSettingsScannerAnswerSettings is an object the document declares inline.

type GetSettingsScannerAnswerUpdates ¶

type GetSettingsScannerAnswerUpdates struct {
	Grype *GetSettingsScannerAnswerUpdatesGrype `json:"grype,omitempty"`
	Trivy *GetSettingsScannerAnswerUpdatesTrivy `json:"trivy,omitempty"`
}

GetSettingsScannerAnswerUpdates is an object the document declares inline.

with checkUpdates: whether the registry has a newer image under the same tag

type GetSettingsScannerAnswerUpdatesGrype ¶

type GetSettingsScannerAnswerUpdatesGrype struct {
	HasUpdate    bool   `json:"hasUpdate"`
	LocalDigest  string `json:"localDigest,omitempty"`
	RemoteDigest string `json:"remoteDigest,omitempty"`
}

GetSettingsScannerAnswerUpdatesGrype is an object the document declares inline.

type GetSettingsScannerAnswerUpdatesTrivy ¶

type GetSettingsScannerAnswerUpdatesTrivy struct {
	HasUpdate    bool   `json:"hasUpdate"`
	LocalDigest  string `json:"localDigest,omitempty"`
	RemoteDigest string `json:"remoteDigest,omitempty"`
}

GetSettingsScannerAnswerUpdatesTrivy is an object the document declares inline.

type GetSettingsScannerAnswerVersions ¶

type GetSettingsScannerAnswerVersions struct {
	Grype string `json:"grype,omitempty"`
	Trivy string `json:"trivy,omitempty"`
}

GetSettingsScannerAnswerVersions is an object the document declares inline.

the version each scanner says it is, where Dockhand could tell; null where it could not or the image is not there

type GetSettingsScannerOptions ¶

type GetSettingsScannerOptions struct {
	// Environment id to read scanner settings for (falls back to global defaults) (from GET /api/environments)
	Env EnvironmentID

	// When true, also check the scanner images for available updates (slower)
	CheckUpdates *bool

	// When true, also ask the registry whether a newer scanner RELEASE exists (slower)
	CheckNewerVersions *bool

	// When true, return only settings + defaults and skip the Docker availability/version checks
	SettingsOnly *bool
}

GetSettingsScannerOptions holds the query and header parameters of GetSettingsScanner.

func (GetSettingsScannerOptions) ToHeaders ¶

func (o GetSettingsScannerOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetSettingsScannerOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetSettingsScannerResponse ¶

type GetSettingsScannerResponse struct {
	HttpResponse *http.Response
	Answer       *GetSettingsScannerAnswer
	*GetSettingsScannerAnswer
}

GetSettingsScannerResponse is the result of GetSettingsScanner.

Answer is the GetSettingsScannerAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSettingsScannerResponse) Answered ¶

func (r GetSettingsScannerResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSettingsScannerResponse) Record ¶

Record is the GetSettingsScannerAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSettingsSemverAnswer ¶

type GetSettingsSemverAnswer struct {
	Enabled           bool   `json:"enabled"`
	IncludePrerelease bool   `json:"includePrerelease"`
	MatchFlavor       bool   `json:"matchFlavor"`
	MaxBump           string `json:"maxBump"`
}

GetSettingsSemverAnswer is an object the document declares inline.

type GetSettingsSemverResponse ¶

type GetSettingsSemverResponse struct {
	HttpResponse *http.Response
	Answer       *GetSettingsSemverAnswer
	*GetSettingsSemverAnswer
}

GetSettingsSemverResponse is the result of GetSettingsSemver.

Answer is the GetSettingsSemverAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSettingsSemverResponse) Answered ¶

func (r GetSettingsSemverResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSettingsSemverResponse) Record ¶

Record is the GetSettingsSemverAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSettingsThemeResponse ¶

type GetSettingsThemeResponse struct {
	HttpResponse *http.Response
	Answer       json.RawMessage
}

GetSettingsThemeResponse is the result of GetSettingsTheme.

func (GetSettingsThemeResponse) Answered ¶

func (r GetSettingsThemeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetStackTagsOptions ¶

type GetStackTagsOptions struct {
	// Environment id
	Env EnvironmentID
}

GetStackTagsOptions holds the query and header parameters of GetStackTags.

func (GetStackTagsOptions) ToHeaders ¶

func (o GetStackTagsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStackTagsOptions) ToQuery ¶

func (o GetStackTagsOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetStackTagsResponse ¶

type GetStackTagsResponse struct {
	HttpResponse *http.Response
	Answer       map[string][]int
}

GetStackTagsResponse is the result of GetStackTags.

func (GetStackTagsResponse) Answered ¶

func (r GetStackTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetStacksAnswer ¶

type GetStacksAnswer struct {
	ContainerDetails []GetStacksAnswerContainerDetails `json:"containerDetails,omitzero"`

	// the whole ids of the stack's containers
	Containers []string `json:"containers,omitzero"`

	// the icon the stack was given; absent for one given none
	Icon              string `json:"icon,omitempty"`
	Name              string `json:"name,omitempty"`
	NewerVersionCount int    `json:"newerVersionCount,omitempty"`

	// running, partial (some of its containers are not running) or stopped
	Status           StackStatus `json:"status,omitempty"`
	UpdateCount      int         `json:"updateCount,omitempty"`
	UpdatesAvailable bool        `json:"updatesAvailable"`
}

GetStacksAnswer is an object the document declares inline.

type GetStacksAnswerContainerDetails ¶

type GetStacksAnswerContainerDetails struct {
	// when the container was made, in seconds since 1970
	Created int `json:"created,omitempty"`

	// healthy, unhealthy or starting; empty for a container with no health check
	Health       ContainerHealth                           `json:"health,omitempty"`
	Id           string                                    `json:"id,omitempty"`
	Image        string                                    `json:"image,omitempty"`
	Labels       map[string]string                         `json:"labels,omitzero"`
	Name         string                                    `json:"name,omitempty"`
	Networks     []GetStacksAnswerContainerDetailsNetworks `json:"networks,omitzero"`
	Ports        []GetStacksAnswerContainerDetailsPorts    `json:"ports,omitzero"`
	RestartCount int                                       `json:"restartCount,omitempty"`

	// the compose service the container is
	Service         string         `json:"service,omitempty"`
	State           ContainerState `json:"state,omitempty"`
	Status          string         `json:"status,omitempty"`
	UpdateAvailable bool           `json:"updateAvailable"`
	VolumeCount     int            `json:"volumeCount,omitempty"`
}

GetStacksAnswerContainerDetails is an object the document declares inline.

func (GetStacksAnswerContainerDetails) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetStacksAnswerContainerDetails) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetStacksAnswerContainerDetailsNetworks ¶

type GetStacksAnswerContainerDetailsNetworks struct {
	IpAddress string `json:"ipAddress,omitempty"`
	Name      string `json:"name,omitempty"`
}

GetStacksAnswerContainerDetailsNetworks is an object the document declares inline.

type GetStacksAnswerContainerDetailsPorts ¶

type GetStacksAnswerContainerDetailsPorts struct {
	// the port as a person writes it: 8080:80/tcp
	Display     string `json:"display,omitempty"`
	PrivatePort int    `json:"privatePort,omitempty"`
	PublicPort  int    `json:"publicPort,omitempty"`

	// tcp or udp
	Type string `json:"type,omitempty"`
}

GetStacksAnswerContainerDetailsPorts is an object the document declares inline.

type GetStacksBasePathAnswer ¶

type GetStacksBasePathAnswer struct {
	BasePath string `json:"basePath"`
}

GetStacksBasePathAnswer is an object the document declares inline.

type GetStacksBasePathOptions ¶

type GetStacksBasePathOptions struct {
	// Environment ID used to select the local or environment-scoped stacks root
	Env EnvironmentID
}

GetStacksBasePathOptions holds the query and header parameters of GetStacksBasePath.

func (GetStacksBasePathOptions) ToHeaders ¶

func (o GetStacksBasePathOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksBasePathOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksBasePathResponse ¶

type GetStacksBasePathResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksBasePathAnswer
	*GetStacksBasePathAnswer
}

GetStacksBasePathResponse is the result of GetStacksBasePath.

Answer is the GetStacksBasePathAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksBasePathResponse) Answered ¶

func (r GetStacksBasePathResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksBasePathResponse) Record ¶

Record is the GetStacksBasePathAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameComposeAnswer ¶

type GetStacksByNameComposeAnswer struct {
	ComposePath string `json:"composePath,omitempty"`

	// the compose file's text, as it is kept
	Content string `json:"content,omitempty"`

	// where the stack's .env file is kept; absent when it has none
	EnvPath string `json:"envPath,omitempty"`

	// the directory the stack's files are kept in, as Dockhand's own container sees it
	StackDir string `json:"stackDir,omitempty"`

	// where a .env file would be kept if the stack were given one
	SuggestedEnvPath string `json:"suggestedEnvPath,omitempty"`
}

GetStacksByNameComposeAnswer is an object the document declares inline.

type GetStacksByNameComposeOptions ¶

type GetStacksByNameComposeOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID
}

GetStacksByNameComposeOptions holds the query and header parameters of GetStacksByNameCompose.

func (GetStacksByNameComposeOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetStacksByNameComposeOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameComposeResponse ¶

type GetStacksByNameComposeResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameComposeAnswer
	*GetStacksByNameComposeAnswer
}

GetStacksByNameComposeResponse is the result of GetStacksByNameCompose.

Answer is the GetStacksByNameComposeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameComposeResponse) Answered ¶

func (r GetStacksByNameComposeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameComposeResponse) Record ¶

Record is the GetStacksByNameComposeAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameDeletePreviewAnswer ¶

type GetStacksByNameDeletePreviewAnswer struct {
	CanDeleteFiles bool            `json:"canDeleteFiles"`
	GitDir         string          `json:"gitDir,omitempty"`
	NamedVolumes   []string        `json:"namedVolumes"`
	SourceType     StackSourceType `json:"sourceType,omitempty"`
	StackDir       string          `json:"stackDir,omitempty"`
	StackName      string          `json:"stackName"`
}

GetStacksByNameDeletePreviewAnswer is an object the document declares inline.

type GetStacksByNameDeletePreviewOptions ¶

type GetStacksByNameDeletePreviewOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetStacksByNameDeletePreviewOptions holds the query and header parameters of GetStacksByNameDeletePreview.

func (GetStacksByNameDeletePreviewOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetStacksByNameDeletePreviewOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameDeletePreviewResponse ¶

type GetStacksByNameDeletePreviewResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameDeletePreviewAnswer
	*GetStacksByNameDeletePreviewAnswer
}

GetStacksByNameDeletePreviewResponse is the result of GetStacksByNameDeletePreview.

Answer is the GetStacksByNameDeletePreviewAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameDeletePreviewResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameDeletePreviewResponse) Record ¶

Record is the GetStacksByNameDeletePreviewAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameDeploysAnswer ¶

type GetStacksByNameDeploysAnswer struct {
	Runs []GetStacksByNameDeploysAnswerRuns `json:"runs"`
}

GetStacksByNameDeploysAnswer is an object the document declares inline.

type GetStacksByNameDeploysAnswerRuns ¶

type GetStacksByNameDeploysAnswerRuns struct {
	CompletedAt   Time                                     `json:"completedAt,omitzero"`
	Details       *GetStacksByNameDeploysAnswerRunsDetails `json:"details,omitempty"`
	Duration      int                                      `json:"duration,omitempty"`
	EnvironmentId EnvironmentID                            `json:"environmentId,omitempty"`
	ErrorMessage  string                                   `json:"errorMessage,omitempty"`
	Id            int                                      `json:"id"`
	StartedAt     Time                                     `json:"startedAt,omitzero"`
	Status        DeployStatus                             `json:"status"`
	TriggeredAt   Time                                     `json:"triggeredAt"`
	TriggeredBy   string                                   `json:"triggeredBy"`
}

GetStacksByNameDeploysAnswerRuns is an object the document declares inline.

type GetStacksByNameDeploysAnswerRunsDetails ¶

type GetStacksByNameDeploysAnswerRunsDetails struct {
	// a digest of the compose file the deploy ran with: two deploys with the same one ran the same file
	ComposeHash string                                          `json:"composeHash,omitempty"`
	EnvHash     string                                          `json:"envHash,omitempty"`
	ExitCode    int                                             `json:"exitCode,omitempty"`
	LogFile     string                                          `json:"logFile,omitempty"`
	Options     *GetStacksByNameDeploysAnswerRunsDetailsOptions `json:"options,omitempty"`
	Summary     *GetStacksByNameDeploysAnswerRunsDetailsSummary `json:"summary,omitempty"`
}

GetStacksByNameDeploysAnswerRunsDetails is an object the document declares inline.

type GetStacksByNameDeploysAnswerRunsDetailsOptions ¶

type GetStacksByNameDeploysAnswerRunsDetailsOptions struct {
	Build         bool `json:"build"`
	ForceRecreate bool `json:"forceRecreate"`
	Pull          bool `json:"pull"`
}

GetStacksByNameDeploysAnswerRunsDetailsOptions is an object the document declares inline.

type GetStacksByNameDeploysAnswerRunsDetailsSummary ¶

type GetStacksByNameDeploysAnswerRunsDetailsSummary struct {
	BuildSteps          int      `json:"buildSteps,omitempty"`
	BuildStepsCached    int      `json:"buildStepsCached,omitempty"`
	ContainerNames      []string `json:"containerNames,omitzero"`
	ContainersCreated   int      `json:"containersCreated,omitempty"`
	ContainersRecreated int      `json:"containersRecreated,omitempty"`
	ContainersStarted   int      `json:"containersStarted,omitempty"`
	ImagesBuilt         []string `json:"imagesBuilt,omitzero"`
	ImagesPulled        []string `json:"imagesPulled,omitzero"`
}

GetStacksByNameDeploysAnswerRunsDetailsSummary is an object the document declares inline.

type GetStacksByNameDeploysByRunIdAnswer ¶

type GetStacksByNameDeploysByRunIdAnswer struct {
	CompletedAt   Time                                        `json:"completedAt,omitzero"`
	Details       *GetStacksByNameDeploysByRunIdAnswerDetails `json:"details,omitempty"`
	Duration      int                                         `json:"duration,omitempty"`
	EnvironmentId EnvironmentID                               `json:"environmentId,omitempty"`
	ErrorMessage  string                                      `json:"errorMessage,omitempty"`
	Id            int                                         `json:"id"`
	StartedAt     Time                                        `json:"startedAt,omitzero"`
	Status        DeployStatus                                `json:"status"`
	TriggeredAt   Time                                        `json:"triggeredAt"`
	TriggeredBy   string                                      `json:"triggeredBy"`
}

GetStacksByNameDeploysByRunIdAnswer is an object the document declares inline.

type GetStacksByNameDeploysByRunIdAnswerDetails ¶

type GetStacksByNameDeploysByRunIdAnswerDetails struct {
	// a digest of the compose file the deploy ran with: two deploys with the same one ran the same file
	ComposeHash string                                             `json:"composeHash,omitempty"`
	EnvHash     string                                             `json:"envHash,omitempty"`
	ExitCode    int                                                `json:"exitCode,omitempty"`
	LogFile     string                                             `json:"logFile,omitempty"`
	Options     *GetStacksByNameDeploysByRunIdAnswerDetailsOptions `json:"options,omitempty"`
	Summary     *GetStacksByNameDeploysByRunIdAnswerDetailsSummary `json:"summary,omitempty"`
}

GetStacksByNameDeploysByRunIdAnswerDetails is an object the document declares inline.

type GetStacksByNameDeploysByRunIdAnswerDetailsOptions ¶

type GetStacksByNameDeploysByRunIdAnswerDetailsOptions struct {
	Build         bool `json:"build"`
	ForceRecreate bool `json:"forceRecreate"`
	Pull          bool `json:"pull"`
}

GetStacksByNameDeploysByRunIdAnswerDetailsOptions is an object the document declares inline.

type GetStacksByNameDeploysByRunIdAnswerDetailsSummary ¶

type GetStacksByNameDeploysByRunIdAnswerDetailsSummary struct {
	BuildSteps          int      `json:"buildSteps,omitempty"`
	BuildStepsCached    int      `json:"buildStepsCached,omitempty"`
	ContainerNames      []string `json:"containerNames,omitzero"`
	ContainersCreated   int      `json:"containersCreated,omitempty"`
	ContainersRecreated int      `json:"containersRecreated,omitempty"`
	ContainersStarted   int      `json:"containersStarted,omitempty"`
	ImagesBuilt         []string `json:"imagesBuilt,omitzero"`
	ImagesPulled        []string `json:"imagesPulled,omitzero"`
}

GetStacksByNameDeploysByRunIdAnswerDetailsSummary is an object the document declares inline.

type GetStacksByNameDeploysByRunIdLogResponse ¶

type GetStacksByNameDeploysByRunIdLogResponse struct {
	HttpResponse *http.Response
}

GetStacksByNameDeploysByRunIdLogResponse is the result of GetStacksByNameDeploysByRunIdLog.

The operation answers text/plain, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetStacksByNameDeploysByRunIdLogResponse) Bytes ¶

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetStacksByNameDeploysByRunIdLogResponse) ContentLength ¶

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetStacksByNameDeploysByRunIdLogResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetStacksByNameDeploysByRunIdLogResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetStacksByNameDeploysByRunIdLogResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetStacksByNameDeploysByRunIdResponse ¶

type GetStacksByNameDeploysByRunIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameDeploysByRunIdAnswer
	*GetStacksByNameDeploysByRunIdAnswer
}

GetStacksByNameDeploysByRunIdResponse is the result of GetStacksByNameDeploysByRunId.

Answer is the GetStacksByNameDeploysByRunIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameDeploysByRunIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameDeploysByRunIdResponse) Record ¶

Record is the GetStacksByNameDeploysByRunIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameDeploysOptions ¶

type GetStacksByNameDeploysOptions struct {
	// Environment id the stack belongs to (from GET /api/environments). Omit, or pass the literal string "null", for the local/default environment (deploys triggered without an explicit env, the normal shape on a single-environment install).
	Env EnvironmentID
}

GetStacksByNameDeploysOptions holds the query and header parameters of GetStacksByNameDeploys.

func (GetStacksByNameDeploysOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetStacksByNameDeploysOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameDeploysResponse ¶

type GetStacksByNameDeploysResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameDeploysAnswer
	*GetStacksByNameDeploysAnswer
}

GetStacksByNameDeploysResponse is the result of GetStacksByNameDeploys.

Answer is the GetStacksByNameDeploysAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameDeploysResponse) Answered ¶

func (r GetStacksByNameDeploysResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameDeploysResponse) Record ¶

Record is the GetStacksByNameDeploysAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameEnvAnswer ¶

type GetStacksByNameEnvAnswer struct {
	InjectedSecretKeys []string `json:"injectedSecretKeys,omitzero"`

	// the secret provider the stack's secrets are loaded from when it is deployed; null for a stack that has none
	SecretProvider *GetStacksByNameEnvAnswerSecretProvider `json:"secretProvider,omitempty"`
	Variables      []GetStacksByNameEnvAnswerVariables     `json:"variables"`
}

GetStacksByNameEnvAnswer is an object the document declares inline.

type GetStacksByNameEnvAnswerSecretProvider ¶

type GetStacksByNameEnvAnswerSecretProvider struct {
	Name string `json:"name,omitempty"`
	Type string `json:"type,omitempty"`
}

GetStacksByNameEnvAnswerSecretProvider is an object the document declares inline.

the secret provider the stack's secrets are loaded from when it is deployed; null for a stack that has none

type GetStacksByNameEnvAnswerVariables ¶

type GetStacksByNameEnvAnswerVariables struct {
	IsSecret bool   `json:"isSecret"`
	Key      string `json:"key"`
	Value    string `json:"value"`
}

GetStacksByNameEnvAnswerVariables is an object the document declares inline.

type GetStacksByNameEnvOptions ¶

type GetStacksByNameEnvOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID
}

GetStacksByNameEnvOptions holds the query and header parameters of GetStacksByNameEnv.

func (GetStacksByNameEnvOptions) ToHeaders ¶

func (o GetStacksByNameEnvOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksByNameEnvOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameEnvRawAnswer ¶

type GetStacksByNameEnvRawAnswer struct {
	Content   string `json:"content"`
	NoEnvFile bool   `json:"noEnvFile"`
}

GetStacksByNameEnvRawAnswer is an object the document declares inline.

type GetStacksByNameEnvRawOptions ¶

type GetStacksByNameEnvRawOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetStacksByNameEnvRawOptions holds the query and header parameters of GetStacksByNameEnvRaw.

func (GetStacksByNameEnvRawOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetStacksByNameEnvRawOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameEnvRawResponse ¶

type GetStacksByNameEnvRawResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameEnvRawAnswer
	*GetStacksByNameEnvRawAnswer
}

GetStacksByNameEnvRawResponse is the result of GetStacksByNameEnvRaw.

Answer is the GetStacksByNameEnvRawAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameEnvRawResponse) Answered ¶

func (r GetStacksByNameEnvRawResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameEnvRawResponse) Record ¶

Record is the GetStacksByNameEnvRawAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameEnvResponse ¶

type GetStacksByNameEnvResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameEnvAnswer
	*GetStacksByNameEnvAnswer
}

GetStacksByNameEnvResponse is the result of GetStacksByNameEnv.

Answer is the GetStacksByNameEnvAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameEnvResponse) Answered ¶

func (r GetStacksByNameEnvResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameEnvResponse) Record ¶

Record is the GetStacksByNameEnvAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksByNameIconOptions ¶

type GetStacksByNameIconOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID
}

GetStacksByNameIconOptions holds the query and header parameters of GetStacksByNameIcon.

func (GetStacksByNameIconOptions) ToHeaders ¶

func (o GetStacksByNameIconOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksByNameIconOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameIconResponse ¶

type GetStacksByNameIconResponse struct {
	HttpResponse *http.Response
}

GetStacksByNameIconResponse is the result of GetStacksByNameIcon.

The operation answers image/*, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetStacksByNameIconResponse) Bytes ¶

func (r GetStacksByNameIconResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetStacksByNameIconResponse) ContentLength ¶

func (r GetStacksByNameIconResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetStacksByNameIconResponse) Filename ¶

func (r GetStacksByNameIconResponse) Filename() string

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetStacksByNameIconResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetStacksByNameIconResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetStacksByNameTagsAnswer ¶

type GetStacksByNameTagsAnswer struct {
	TagIds []TagID `json:"tagIds"`
}

GetStacksByNameTagsAnswer is an object the document declares inline.

type GetStacksByNameTagsOptions ¶

type GetStacksByNameTagsOptions struct {
	// Environment id
	Env EnvironmentID
}

GetStacksByNameTagsOptions holds the query and header parameters of GetStacksByNameTags.

func (GetStacksByNameTagsOptions) ToHeaders ¶

func (o GetStacksByNameTagsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksByNameTagsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksByNameTagsResponse ¶

type GetStacksByNameTagsResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksByNameTagsAnswer
	*GetStacksByNameTagsAnswer
}

GetStacksByNameTagsResponse is the result of GetStacksByNameTags.

Answer is the GetStacksByNameTagsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksByNameTagsResponse) Answered ¶

func (r GetStacksByNameTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksByNameTagsResponse) Record ¶

Record is the GetStacksByNameTagsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksDefaultPathAnswer ¶

type GetStacksDefaultPathAnswer struct {
	ComposePath string `json:"composePath"`
	EnvPath     string `json:"envPath"`
	Source      string `json:"source"`
	StackDir    string `json:"stackDir"`
}

GetStacksDefaultPathAnswer is an object the document declares inline.

type GetStacksDefaultPathOptions ¶

type GetStacksDefaultPathOptions struct {
	// Stack name
	Name string

	// Environment ID (scopes the path under the environment name) (from GET /api/environments)
	Env EnvironmentID

	// Custom base location path
	Location string
}

GetStacksDefaultPathOptions holds the query and header parameters of GetStacksDefaultPath.

func (GetStacksDefaultPathOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetStacksDefaultPathOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksDefaultPathResponse ¶

type GetStacksDefaultPathResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksDefaultPathAnswer
	*GetStacksDefaultPathAnswer
}

GetStacksDefaultPathResponse is the result of GetStacksDefaultPath.

Answer is the GetStacksDefaultPathAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksDefaultPathResponse) Answered ¶

func (r GetStacksDefaultPathResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksDefaultPathResponse) Record ¶

Record is the GetStacksDefaultPathAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksOptions ¶

type GetStacksOptions struct {
	// Environment id
	Env EnvironmentID
}

GetStacksOptions holds the query and header parameters of GetStacks.

func (GetStacksOptions) ToHeaders ¶

func (o GetStacksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksOptions) ToQuery ¶

func (o GetStacksOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetStacksPathHintsAnswer ¶

type GetStacksPathHintsAnswer struct {
	ConfigFiles []string `json:"configFiles,omitzero"`
	StackName   string   `json:"stackName"`
	WorkingDir  string   `json:"workingDir,omitempty"`
}

GetStacksPathHintsAnswer is an object the document declares inline.

type GetStacksPathHintsOptions ¶

type GetStacksPathHintsOptions struct {
	// Stack name (from GET /api/stacks)
	Name string

	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetStacksPathHintsOptions holds the query and header parameters of GetStacksPathHints.

func (GetStacksPathHintsOptions) ToHeaders ¶

func (o GetStacksPathHintsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksPathHintsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksPathHintsResponse ¶

type GetStacksPathHintsResponse struct {
	HttpResponse *http.Response
	Answer       *GetStacksPathHintsAnswer
	*GetStacksPathHintsAnswer
}

GetStacksPathHintsResponse is the result of GetStacksPathHints.

Answer is the GetStacksPathHintsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetStacksPathHintsResponse) Answered ¶

func (r GetStacksPathHintsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetStacksPathHintsResponse) Record ¶

Record is the GetStacksPathHintsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetStacksResponse ¶

type GetStacksResponse struct {
	HttpResponse *http.Response
	Answer       []GetStacksAnswer
}

GetStacksResponse is the result of GetStacks.

func (GetStacksResponse) Answered ¶

func (r GetStacksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetStacksSourcesAnswer ¶

type GetStacksSourcesAnswer struct {
	ComposePath string `json:"composePath,omitempty"`

	// how many variables the stack is given: the ones in its .env file and the ones Dockhand keeps as secrets
	EnvVarCount      int              `json:"envVarCount,omitempty"`
	Icon             string           `json:"icon,omitempty"`
	SecretProviderId SecretProviderID `json:"secretProviderId,omitempty"`

	// internal for a stack Dockhand has the compose file of, wherever the file lies, git for one deployed from a repository, and external for one it keeps a record of with no file, as a stack it only found is once it is given an icon
	SourceType StackSourceType `json:"sourceType,omitempty"`
}

GetStacksSourcesAnswer is an object the document declares inline.

type GetStacksSourcesOptions ¶

type GetStacksSourcesOptions struct {
	// Filter to a single environment id
	Env EnvironmentID
}

GetStacksSourcesOptions holds the query and header parameters of GetStacksSources.

func (GetStacksSourcesOptions) ToHeaders ¶

func (o GetStacksSourcesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetStacksSourcesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetStacksSourcesResponse ¶

type GetStacksSourcesResponse struct {
	HttpResponse *http.Response
	Answer       map[string]GetStacksSourcesAnswer
}

GetStacksSourcesResponse is the result of GetStacksSources.

func (GetStacksSourcesResponse) Answered ¶

func (r GetStacksSourcesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetSystemAnswer ¶

type GetSystemAnswer struct {
	Database map[string]any `json:"database"`
	Docker   map[string]any `json:"docker,omitzero"`
	Host     map[string]any `json:"host,omitzero"`
	Runtime  map[string]any `json:"runtime"`
	Stats    map[string]any `json:"stats"`
}

GetSystemAnswer is an object the document declares inline.

type GetSystemDiskAnswer ¶

type GetSystemDiskAnswer struct {
	// Docker's own account of what its disk holds, in Docker's spelling; null when Dockhand could not get it from the host in time
	DiskUsage *GetSystemDiskAnswerDiskUsage `json:"diskUsage,omitempty"`
}

GetSystemDiskAnswer is an object the document declares inline.

type GetSystemDiskAnswerDiskUsage ¶

type GetSystemDiskAnswerDiskUsage struct {
	BuildCache []GetSystemDiskAnswerDiskUsageBuildCache `json:"BuildCache,omitzero"`
	Containers []GetSystemDiskAnswerDiskUsageContainers `json:"Containers,omitzero"`
	Images     []GetSystemDiskAnswerDiskUsageImages     `json:"Images,omitzero"`

	// what the images take together, the layers they share counted once, in bytes
	LayersSize int                                   `json:"LayersSize,omitempty"`
	Volumes    []GetSystemDiskAnswerDiskUsageVolumes `json:"Volumes,omitzero"`
}

GetSystemDiskAnswerDiskUsage is an object the document declares inline.

Docker's own account of what its disk holds, in Docker's spelling; null when Dockhand could not get it from the host in time

type GetSystemDiskAnswerDiskUsageBuildCache ¶

type GetSystemDiskAnswerDiskUsageBuildCache struct {
	Description string `json:"Description,omitempty"`
	ID          string `json:"ID,omitempty"`
	InUse       bool   `json:"InUse"`
	LastUsedAt  string `json:"LastUsedAt,omitempty"`
	Shared      bool   `json:"Shared"`

	// in bytes
	Size int    `json:"Size,omitempty"`
	Type string `json:"Type,omitempty"`
}

GetSystemDiskAnswerDiskUsageBuildCache is an object the document declares inline.

type GetSystemDiskAnswerDiskUsageContainers ¶

type GetSystemDiskAnswerDiskUsageContainers struct {
	Id    string   `json:"Id,omitempty"`
	Image string   `json:"Image,omitempty"`
	Names []string `json:"Names,omitzero"`

	// what its whole filesystem takes, its image included, in bytes
	SizeRootFs int `json:"SizeRootFs,omitempty"`

	// what it has written inside itself, in bytes; absent for one that has written nothing
	SizeRw int    `json:"SizeRw,omitempty"`
	State  string `json:"State,omitempty"`
	Status string `json:"Status,omitempty"`
}

GetSystemDiskAnswerDiskUsageContainers is an object the document declares inline.

type GetSystemDiskAnswerDiskUsageImages ¶

type GetSystemDiskAnswerDiskUsageImages struct {
	// how many containers are made from it, running or not
	Containers int `json:"Containers,omitempty"`

	// when it was built, in seconds since 1970
	Created  int      `json:"Created,omitempty"`
	Id       string   `json:"Id,omitempty"`
	RepoTags []string `json:"RepoTags,omitzero"`

	// how much of it other images share; -1 where Docker did not work it out
	SharedSize int `json:"SharedSize,omitempty"`

	// the image's size in bytes, shared layers included
	Size int `json:"Size,omitempty"`
}

GetSystemDiskAnswerDiskUsageImages is an object the document declares inline.

type GetSystemDiskAnswerDiskUsageVolumes ¶

type GetSystemDiskAnswerDiskUsageVolumes struct {
	Name      string                                        `json:"Name,omitempty"`
	UsageData *GetSystemDiskAnswerDiskUsageVolumesUsageData `json:"UsageData,omitempty"`
}

GetSystemDiskAnswerDiskUsageVolumes is an object the document declares inline.

type GetSystemDiskAnswerDiskUsageVolumesUsageData ¶

type GetSystemDiskAnswerDiskUsageVolumesUsageData struct {
	// how many containers mount it
	RefCount int `json:"RefCount,omitempty"`

	// what the volume holds, in bytes; -1 where Docker cannot tell
	Size int `json:"Size,omitempty"`
}

GetSystemDiskAnswerDiskUsageVolumesUsageData is an object the document declares inline.

type GetSystemDiskOptions ¶

type GetSystemDiskOptions struct {
	// ID of the environment to query disk usage for (from GET /api/environments)
	Env EnvironmentID
}

GetSystemDiskOptions holds the query and header parameters of GetSystemDisk.

func (GetSystemDiskOptions) ToHeaders ¶

func (o GetSystemDiskOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetSystemDiskOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetSystemDiskResponse ¶

type GetSystemDiskResponse struct {
	HttpResponse *http.Response
	Answer       *GetSystemDiskAnswer
	*GetSystemDiskAnswer
}

GetSystemDiskResponse is the result of GetSystemDisk.

Answer is the GetSystemDiskAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSystemDiskResponse) Answered ¶

func (r GetSystemDiskResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSystemDiskResponse) Record ¶

Record is the GetSystemDiskAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSystemFilesAnswer ¶

type GetSystemFilesAnswer struct {
	Entries []GetSystemFilesAnswerEntries `json:"entries"`
	Parent  string                        `json:"parent,omitempty"`
	Path    string                        `json:"path"`
}

GetSystemFilesAnswer is an object the document declares inline.

type GetSystemFilesAnswerEntries ¶

type GetSystemFilesAnswerEntries struct {
	Mode  string   `json:"mode"`
	Mtime Time     `json:"mtime"`
	Name  string   `json:"name"`
	Path  string   `json:"path"`
	Size  int      `json:"size"`
	Type  FileType `json:"type"`
}

GetSystemFilesAnswerEntries is an object the document declares inline.

type GetSystemFilesContentAnswer ¶

type GetSystemFilesContentAnswer struct {
	Content string `json:"content"`
	Mtime   Time   `json:"mtime"`
	Path    string `json:"path"`
	Size    int    `json:"size"`
}

GetSystemFilesContentAnswer is an object the document declares inline.

type GetSystemFilesContentOptions ¶

type GetSystemFilesContentOptions struct {
	// Absolute path of the file to read
	Path string
}

GetSystemFilesContentOptions holds the query and header parameters of GetSystemFilesContent.

func (GetSystemFilesContentOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetSystemFilesContentOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetSystemFilesContentResponse ¶

type GetSystemFilesContentResponse struct {
	HttpResponse *http.Response
	Answer       *GetSystemFilesContentAnswer
	*GetSystemFilesContentAnswer
}

GetSystemFilesContentResponse is the result of GetSystemFilesContent.

Answer is the GetSystemFilesContentAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSystemFilesContentResponse) Answered ¶

func (r GetSystemFilesContentResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSystemFilesContentResponse) Record ¶

Record is the GetSystemFilesContentAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSystemFilesOptions ¶

type GetSystemFilesOptions struct {
	// Absolute directory path to list (defaults to "/")
	Path string
}

GetSystemFilesOptions holds the query and header parameters of GetSystemFiles.

func (GetSystemFilesOptions) ToHeaders ¶

func (o GetSystemFilesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetSystemFilesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetSystemFilesResponse ¶

type GetSystemFilesResponse struct {
	HttpResponse *http.Response
	Answer       *GetSystemFilesAnswer
	*GetSystemFilesAnswer
}

GetSystemFilesResponse is the result of GetSystemFiles.

Answer is the GetSystemFilesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSystemFilesResponse) Answered ¶

func (r GetSystemFilesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSystemFilesResponse) Record ¶

Record is the GetSystemFilesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetSystemOptions ¶

type GetSystemOptions struct {
	// ID of the environment to collect Docker info for (Docker fields are null when omitted or unreachable) (from GET /api/environments)
	Env EnvironmentID
}

GetSystemOptions holds the query and header parameters of GetSystem.

func (GetSystemOptions) ToHeaders ¶

func (o GetSystemOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetSystemOptions) ToQuery ¶

func (o GetSystemOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetSystemResponse ¶

type GetSystemResponse struct {
	HttpResponse *http.Response
	Answer       *GetSystemAnswer
	*GetSystemAnswer
}

GetSystemResponse is the result of GetSystem.

Answer is the GetSystemAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetSystemResponse) Answered ¶

func (r GetSystemResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetSystemResponse) Record ¶

func (r GetSystemResponse) Record() (GetSystemAnswer, error)

Record is the GetSystemAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetTagsAnswer ¶

type GetTagsAnswer struct {
	Tags []GetTagsAnswerTags `json:"tags"`
}

GetTagsAnswer is an object the document declares inline.

type GetTagsAnswerTags ¶

type GetTagsAnswerTags struct {
	Color string `json:"color"`

	// null for a tag given none
	Icon string `json:"icon,omitempty"`
	Id   TagID  `json:"id"`
	Name string `json:"name"`
}

GetTagsAnswerTags is an object the document declares inline.

func (GetTagsAnswerTags) GetId ¶

func (m GetTagsAnswerTags) GetId() TagID

GetId is the record's Id, for code that handles records of several types alike.

func (GetTagsAnswerTags) GetName ¶

func (m GetTagsAnswerTags) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetTagsResponse ¶

type GetTagsResponse struct {
	HttpResponse *http.Response
	Answer       *GetTagsAnswer
	*GetTagsAnswer
}

GetTagsResponse is the result of GetTags.

Answer is the GetTagsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetTagsResponse) Answered ¶

func (r GetTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetTagsResponse) Record ¶

func (r GetTagsResponse) Record() (GetTagsAnswer, error)

Record is the GetTagsAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetTemplatesAnswer ¶

type GetTemplatesAnswer struct {
	Categories    []string                      `json:"categories"`
	Description   string                        `json:"description"`
	DetailsUrl    string                        `json:"detailsUrl,omitempty"`
	Env           []GetTemplatesAnswerEnv       `json:"env,omitzero"`
	Id            string                        `json:"id"`
	Image         string                        `json:"image,omitempty"`
	Network       string                        `json:"network,omitempty"`
	Note          string                        `json:"note,omitempty"`
	Ports         []string                      `json:"ports,omitzero"`
	ProjectUrl    string                        `json:"projectUrl,omitempty"`
	Repository    *GetTemplatesAnswerRepository `json:"repository,omitempty"`
	RestartPolicy RestartPolicy                 `json:"restartPolicy,omitempty"`
	Source        string                        `json:"source"`
	Title         string                        `json:"title"`
	Type          TemplateType                  `json:"type"`
	Volumes       []GetTemplatesAnswerVolumes   `json:"volumes,omitzero"`
}

GetTemplatesAnswer is an object the document declares inline.

type GetTemplatesAnswerEnv ¶

type GetTemplatesAnswerEnv struct {
	Default string `json:"default,omitempty"`
	Label   string `json:"label,omitempty"`
	Name    string `json:"name,omitempty"`
}

GetTemplatesAnswerEnv is an object the document declares inline.

type GetTemplatesAnswerRepository ¶

type GetTemplatesAnswerRepository struct {
	Stackfile string `json:"stackfile,omitempty"`
	Url       string `json:"url,omitempty"`
}

GetTemplatesAnswerRepository is an object the document declares inline.

type GetTemplatesAnswerVolumes ¶

type GetTemplatesAnswerVolumes struct {
	// the place on the host, when the template names one
	Bind      string `json:"bind,omitempty"`
	Container string `json:"container,omitempty"`
}

GetTemplatesAnswerVolumes is an object the document declares inline.

type GetTemplatesResponse ¶

type GetTemplatesResponse struct {
	HttpResponse *http.Response
	Answer       []GetTemplatesAnswer
}

GetTemplatesResponse is the result of GetTemplates.

func (GetTemplatesResponse) Answered ¶

func (r GetTemplatesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetTemplatesSourcesAnswer ¶

type GetTemplatesSourcesAnswer struct {
	// one of the sources Dockhand comes with
	Builtin   bool             `json:"builtin"`
	Enabled   bool             `json:"enabled"`
	Id        TemplateSourceID `json:"id"`
	Name      string           `json:"name"`
	SortOrder int              `json:"sortOrder,omitempty"`

	// the id Dockhand keeps the source under
	SourceId string `json:"sourceId,omitempty"`
	Url      string `json:"url"`
}

GetTemplatesSourcesAnswer is an object the document declares inline.

func (GetTemplatesSourcesAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetTemplatesSourcesAnswer) GetName ¶

func (m GetTemplatesSourcesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type GetTemplatesSourcesResponse ¶

type GetTemplatesSourcesResponse struct {
	HttpResponse *http.Response
	Answer       []GetTemplatesSourcesAnswer
}

GetTemplatesSourcesResponse is the result of GetTemplatesSources.

func (GetTemplatesSourcesResponse) Answered ¶

func (r GetTemplatesSourcesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetUsersAnswer ¶

type GetUsersAnswer struct {
	AuthProvider string `json:"authProvider"`
	CreatedAt    Time   `json:"createdAt,omitzero"`
	DisplayName  string `json:"displayName,omitempty"`
	Email        string `json:"email,omitempty"`
	Id           UserID `json:"id"`
	IsActive     bool   `json:"isActive"`
	IsAdmin      bool   `json:"isAdmin"`
	IsSso        bool   `json:"isSso"`

	// when the user last signed in; null for one who never has
	LastLogin  Time   `json:"lastLogin,omitzero"`
	MfaEnabled bool   `json:"mfaEnabled"`
	Username   string `json:"username"`
}

GetUsersAnswer is an object the document declares inline.

type GetUsersByIdAnswer ¶

type GetUsersByIdAnswer struct {
	CreatedAt   Time   `json:"createdAt"`
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Id          UserID `json:"id"`
	IsActive    bool   `json:"isActive"`
	IsAdmin     bool   `json:"isAdmin"`
	LastLogin   Time   `json:"lastLogin,omitzero"`
	MfaEnabled  bool   `json:"mfaEnabled"`
	UpdatedAt   Time   `json:"updatedAt"`
	Username    string `json:"username"`
}

GetUsersByIdAnswer is an object the document declares inline.

type GetUsersByIdResponse ¶

type GetUsersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *GetUsersByIdAnswer
	*GetUsersByIdAnswer
}

GetUsersByIdResponse is the result of GetUsersById.

Answer is the GetUsersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetUsersByIdResponse) Answered ¶

func (r GetUsersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetUsersByIdResponse) Record ¶

Record is the GetUsersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetUsersByIdRolesAnswer ¶

type GetUsersByIdRolesAnswer struct {
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	Name          string        `json:"name"`
	RoleId        RoleID        `json:"roleId"`
}

GetUsersByIdRolesAnswer is an object the document declares inline.

type GetUsersByIdRolesResponse ¶

type GetUsersByIdRolesResponse struct {
	HttpResponse *http.Response
	Answer       []GetUsersByIdRolesAnswer
}

GetUsersByIdRolesResponse is the result of GetUsersByIdRoles.

func (GetUsersByIdRolesResponse) Answered ¶

func (r GetUsersByIdRolesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetUsersResponse ¶

type GetUsersResponse struct {
	HttpResponse *http.Response
	Answer       []GetUsersAnswer
}

GetUsersResponse is the result of GetUsers.

func (GetUsersResponse) Answered ¶

func (r GetUsersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetVolumesAnswer ¶

type GetVolumesAnswer struct {
	// when the volume was made, as 2006-01-02T15:04:05Z
	Created string `json:"created,omitempty"`

	// local, for a volume kept on the host's own disk
	Driver string            `json:"driver,omitempty"`
	Labels map[string]string `json:"labels,omitzero"`

	// where the volume's files are on the host
	Mountpoint string `json:"mountpoint,omitempty"`
	Name       string `json:"name,omitempty"`
	Scope      string `json:"scope,omitempty"`

	// the containers that mount the volume, running or not; none for a volume nothing uses
	UsedBy []GetVolumesAnswerUsedBy `json:"usedBy,omitzero"`
}

GetVolumesAnswer is an object the document declares inline.

type GetVolumesAnswerUsedBy ¶

type GetVolumesAnswerUsedBy struct {
	ContainerId   string `json:"containerId,omitempty"`
	ContainerName string `json:"containerName,omitempty"`
}

GetVolumesAnswerUsedBy is an object the document declares inline.

type GetVolumesByNameAnswer ¶

type GetVolumesByNameAnswer struct {
	CreatedAt  Time              `json:"CreatedAt,omitzero"`
	Driver     string            `json:"Driver"`
	Labels     map[string]string `json:"Labels,omitzero"`
	Mountpoint string            `json:"Mountpoint"`
	Name       string            `json:"Name"`
	Options    map[string]string `json:"Options,omitzero"`
	Scope      string            `json:"Scope,omitempty"`
}

GetVolumesByNameAnswer is an object the document declares inline.

type GetVolumesByNameBrowseAnswer ¶

type GetVolumesByNameBrowseAnswer struct {
	Entries  []GetVolumesByNameBrowseAnswerEntries `json:"entries"`
	HelperId string                                `json:"helperId"`
	IsInUse  bool                                  `json:"isInUse"`
	Path     string                                `json:"path"`
	Usage    []GetVolumesByNameBrowseAnswerUsage   `json:"usage"`
}

GetVolumesByNameBrowseAnswer is an object the document declares inline.

type GetVolumesByNameBrowseAnswerEntries ¶

type GetVolumesByNameBrowseAnswerEntries struct {
	Group       string `json:"group"`
	Modified    string `json:"modified"`
	Name        string `json:"name"`
	Owner       string `json:"owner"`
	Permissions string `json:"permissions"`

	// whether the volume was opened for reading alone, as it is while a container uses it
	Readonly bool     `json:"readonly"`
	Size     int      `json:"size"`
	Type     FileType `json:"type"`
}

GetVolumesByNameBrowseAnswerEntries is an object the document declares inline.

type GetVolumesByNameBrowseAnswerUsage ¶

type GetVolumesByNameBrowseAnswerUsage struct {
	ContainerId   string `json:"containerId"`
	ContainerName string `json:"containerName"`
	State         string `json:"state"`
}

GetVolumesByNameBrowseAnswerUsage is an object the document declares inline.

type GetVolumesByNameBrowseContentAnswer ¶

type GetVolumesByNameBrowseContentAnswer struct {
	Content string `json:"content"`
	Path    string `json:"path"`
}

GetVolumesByNameBrowseContentAnswer is an object the document declares inline.

type GetVolumesByNameBrowseContentOptions ¶

type GetVolumesByNameBrowseContentOptions struct {
	// File path inside the volume to read
	Path string

	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetVolumesByNameBrowseContentOptions holds the query and header parameters of GetVolumesByNameBrowseContent.

func (GetVolumesByNameBrowseContentOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetVolumesByNameBrowseContentOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVolumesByNameBrowseContentResponse ¶

type GetVolumesByNameBrowseContentResponse struct {
	HttpResponse *http.Response
	Answer       *GetVolumesByNameBrowseContentAnswer
	*GetVolumesByNameBrowseContentAnswer
}

GetVolumesByNameBrowseContentResponse is the result of GetVolumesByNameBrowseContent.

Answer is the GetVolumesByNameBrowseContentAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetVolumesByNameBrowseContentResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetVolumesByNameBrowseContentResponse) Record ¶

Record is the GetVolumesByNameBrowseContentAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetVolumesByNameBrowseOptions ¶

type GetVolumesByNameBrowseOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID

	// Directory path inside the volume to list (defaults to "/")
	Path string
}

GetVolumesByNameBrowseOptions holds the query and header parameters of GetVolumesByNameBrowse.

func (GetVolumesByNameBrowseOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetVolumesByNameBrowseOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVolumesByNameBrowseResponse ¶

type GetVolumesByNameBrowseResponse struct {
	HttpResponse *http.Response
	Answer       *GetVolumesByNameBrowseAnswer
	*GetVolumesByNameBrowseAnswer
}

GetVolumesByNameBrowseResponse is the result of GetVolumesByNameBrowse.

Answer is the GetVolumesByNameBrowseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetVolumesByNameBrowseResponse) Answered ¶

func (r GetVolumesByNameBrowseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetVolumesByNameBrowseResponse) Record ¶

Record is the GetVolumesByNameBrowseAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetVolumesByNameExportOptions ¶

type GetVolumesByNameExportOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID

	// Sub-path inside the volume to export (defaults to "/")
	Path string

	// Archive format: "tar" (default), "tar.gz", or "raw" (single file)
	Format string
}

GetVolumesByNameExportOptions holds the query and header parameters of GetVolumesByNameExport.

func (GetVolumesByNameExportOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetVolumesByNameExportOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVolumesByNameExportResponse ¶

type GetVolumesByNameExportResponse struct {
	HttpResponse *http.Response
}

GetVolumesByNameExportResponse is the result of GetVolumesByNameExport.

The operation answers application/x-tar, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetVolumesByNameExportResponse) Bytes ¶

func (r GetVolumesByNameExportResponse) Bytes(max int64) ([]byte, error)

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetVolumesByNameExportResponse) ContentLength ¶

func (r GetVolumesByNameExportResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetVolumesByNameExportResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetVolumesByNameExportResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetVolumesByNameExportResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetVolumesByNameInspectAnswer ¶

type GetVolumesByNameInspectAnswer struct {
	CreatedAt  Time              `json:"CreatedAt,omitzero"`
	Driver     string            `json:"Driver"`
	Labels     map[string]string `json:"Labels,omitzero"`
	Mountpoint string            `json:"Mountpoint"`
	Name       string            `json:"Name"`
	Options    map[string]string `json:"Options,omitzero"`
	Scope      string            `json:"Scope,omitempty"`
}

GetVolumesByNameInspectAnswer is an object the document declares inline.

type GetVolumesByNameInspectOptions ¶

type GetVolumesByNameInspectOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetVolumesByNameInspectOptions holds the query and header parameters of GetVolumesByNameInspect.

func (GetVolumesByNameInspectOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetVolumesByNameInspectOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVolumesByNameInspectResponse ¶

type GetVolumesByNameInspectResponse struct {
	HttpResponse *http.Response
	Answer       *GetVolumesByNameInspectAnswer
	*GetVolumesByNameInspectAnswer
}

GetVolumesByNameInspectResponse is the result of GetVolumesByNameInspect.

Answer is the GetVolumesByNameInspectAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetVolumesByNameInspectResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetVolumesByNameInspectResponse) Record ¶

Record is the GetVolumesByNameInspectAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetVolumesByNameOptions ¶

type GetVolumesByNameOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID
}

GetVolumesByNameOptions holds the query and header parameters of GetVolumesByName.

func (GetVolumesByNameOptions) ToHeaders ¶

func (o GetVolumesByNameOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetVolumesByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVolumesByNameResponse ¶

type GetVolumesByNameResponse struct {
	HttpResponse *http.Response
	Answer       *GetVolumesByNameAnswer
	*GetVolumesByNameAnswer
}

GetVolumesByNameResponse is the result of GetVolumesByName.

Answer is the GetVolumesByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetVolumesByNameResponse) Answered ¶

func (r GetVolumesByNameResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetVolumesByNameResponse) Record ¶

Record is the GetVolumesByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetVolumesOptions ¶

type GetVolumesOptions struct {
	// Environment ID to list volumes for (from GET /api/environments)
	Env EnvironmentID
}

GetVolumesOptions holds the query and header parameters of GetVolumes.

func (GetVolumesOptions) ToHeaders ¶

func (o GetVolumesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetVolumesOptions) ToQuery ¶

func (o GetVolumesOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type GetVolumesResponse ¶

type GetVolumesResponse struct {
	HttpResponse *http.Response
	Answer       []GetVolumesAnswer
}

GetVolumesResponse is the result of GetVolumes.

func (GetVolumesResponse) Answered ¶

func (r GetVolumesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

type GetVulnerabilitiesAnswer ¶

type GetVulnerabilitiesAnswer struct {
	Findings []GetVulnerabilitiesAnswerFindings `json:"findings"`

	// the findings counted by how grave, of the ones that matched
	Summary *GetVulnerabilitiesAnswerSummary `json:"summary,omitempty"`
	Total   int                              `json:"total"`
}

GetVulnerabilitiesAnswer is an object the document declares inline.

type GetVulnerabilitiesAnswerFindings ¶

type GetVulnerabilitiesAnswerFindings struct {
	// the containers made from the image, as Dockhand last looked, which is up to half a minute ago; absent when there are none
	Containers  []GetVulnerabilitiesAnswerFindingsContainers `json:"containers,omitzero"`
	Cve         string                                       `json:"cve,omitempty"`
	Description string                                       `json:"description,omitempty"`

	// the version it is put right in; empty when none is known
	FixedVersion     string `json:"fixedVersion,omitempty"`
	ImageId          string `json:"imageId,omitempty"`
	ImageName        string `json:"imageName,omitempty"`
	InstalledVersion string `json:"installedVersion,omitempty"`
	Key              string `json:"key,omitempty"`
	Link             string `json:"link,omitempty"`
	Package          string `json:"package,omitempty"`
	ScannedAt        Time   `json:"scannedAt,omitzero"`

	// critical, high, medium, low, negligible or unknown
	Severity Severity `json:"severity,omitempty"`

	// the stacks those containers belong to; absent when there are none
	Stacks []string `json:"stacks,omitzero"`
}

GetVulnerabilitiesAnswerFindings is an object the document declares inline.

type GetVulnerabilitiesAnswerFindingsContainers ¶

type GetVulnerabilitiesAnswerFindingsContainers struct {
	Id   string `json:"id,omitempty"`
	Name string `json:"name,omitempty"`
}

GetVulnerabilitiesAnswerFindingsContainers is an object the document declares inline.

func (GetVulnerabilitiesAnswerFindingsContainers) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (GetVulnerabilitiesAnswerFindingsContainers) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type GetVulnerabilitiesAnswerSummary ¶

type GetVulnerabilitiesAnswerSummary struct {
	Critical int `json:"critical,omitempty"`
	High     int `json:"high,omitempty"`

	// how many of the images the host has were scanned
	ImagesScanned int `json:"imagesScanned,omitempty"`
	Low           int `json:"low,omitempty"`
	Medium        int `json:"medium,omitempty"`
	Total         int `json:"total,omitempty"`

	// how many images the host has
	TotalImages int `json:"totalImages,omitempty"`
}

GetVulnerabilitiesAnswerSummary is an object the document declares inline.

the findings counted by how grave, of the ones that matched

type GetVulnerabilitiesCountAnswer ¶

type GetVulnerabilitiesCountAnswer struct {
	// what the findings can be narrowed to
	Options *GetVulnerabilitiesCountAnswerOptions `json:"options,omitempty"`

	// the findings counted by how grave, of the ones that matched
	Summary *GetVulnerabilitiesCountAnswerSummary `json:"summary,omitempty"`
	Total   int                                   `json:"total,omitempty"`
}

GetVulnerabilitiesCountAnswer is an object the document declares inline.

type GetVulnerabilitiesCountAnswerOptions ¶

type GetVulnerabilitiesCountAnswerOptions struct {
	Containers []string `json:"containers,omitzero"`
	Images     []string `json:"images,omitzero"`
	Stacks     []string `json:"stacks,omitzero"`
}

GetVulnerabilitiesCountAnswerOptions is an object the document declares inline.

what the findings can be narrowed to

type GetVulnerabilitiesCountAnswerSummary ¶

type GetVulnerabilitiesCountAnswerSummary struct {
	Critical int `json:"critical,omitempty"`
	High     int `json:"high,omitempty"`

	// how many of the images the host has were scanned
	ImagesScanned int `json:"imagesScanned,omitempty"`
	Low           int `json:"low,omitempty"`
	Medium        int `json:"medium,omitempty"`
	Total         int `json:"total,omitempty"`

	// how many images the host has
	TotalImages int `json:"totalImages,omitempty"`
}

GetVulnerabilitiesCountAnswerSummary is an object the document declares inline.

the findings counted by how grave, of the ones that matched

type GetVulnerabilitiesCountOptions ¶

type GetVulnerabilitiesCountOptions struct {
	// the environment whose findings are asked for: with none, nothing is found
	Env EnvironmentID
}

GetVulnerabilitiesCountOptions holds the query and header parameters of GetVulnerabilitiesCount.

func (GetVulnerabilitiesCountOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetVulnerabilitiesCountOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVulnerabilitiesCountResponse ¶

type GetVulnerabilitiesCountResponse struct {
	HttpResponse *http.Response
	Answer       *GetVulnerabilitiesCountAnswer
	*GetVulnerabilitiesCountAnswer
}

GetVulnerabilitiesCountResponse is the result of GetVulnerabilitiesCount.

Answer is the GetVulnerabilitiesCountAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetVulnerabilitiesCountResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetVulnerabilitiesCountResponse) Record ¶

Record is the GetVulnerabilitiesCountAnswer answered, as a value to change and write back, or an error when the server answered none.

type GetVulnerabilitiesExportOptions ¶

type GetVulnerabilitiesExportOptions struct {
	// Output format — json (default) or csv
	Format string

	// the environment whose findings are asked for: with none, nothing is found
	Env EnvironmentID

	// only findings whose CVE, package, image, container or stack holds this text, whatever its case
	Q string

	// only findings this grave: critical, high, medium or low, or several with commas between
	Severity string

	// only findings of the image by this name, whole, or of several with commas between
	Image string

	// only findings of the image a container by this name was made from
	Container string

	// only findings of the images a stack's containers were made from
	Stack string

	// what to order by: severity, cve, package, image, installed, fixed, container, stack or scannedAt
	Sort string

	// desc for the order turned round; by severity the gravest come first unless it is
	Dir string
}

GetVulnerabilitiesExportOptions holds the query and header parameters of GetVulnerabilitiesExport.

func (GetVulnerabilitiesExportOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (GetVulnerabilitiesExportOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVulnerabilitiesExportResponse ¶

type GetVulnerabilitiesExportResponse struct {
	HttpResponse *http.Response
}

GetVulnerabilitiesExportResponse is the result of GetVulnerabilitiesExport.

The operation answers application/octet-stream, left unread in HttpResponse.Body. WriteTo copies it out and Bytes reads it whole up to a size, each closing it; Reader hands it over for the caller to read and close. After any of them the body is spent. A failed call has no open body: the base client reads a refusal and closes it.

func (GetVulnerabilitiesExportResponse) Bytes ¶

Bytes reads the file whole, up to max bytes, and closes the body: a file over max is a client.TooLargeError rather than cut short without a word.

func (GetVulnerabilitiesExportResponse) ContentLength ¶

func (r GetVulnerabilitiesExportResponse) ContentLength() int64

ContentLength is the file's length as the server named it, or -1 when it did not, to refuse one too big before reading any of it.

func (GetVulnerabilitiesExportResponse) Filename ¶

Filename is the name the server gave the file (Content-Disposition), or "" when it gave none, for a caller saving it under the server's name.

func (GetVulnerabilitiesExportResponse) Reader ¶

Reader is the file's body, for the caller to read and close, and the content type the server named it; an empty body and "" when the operation gave no answer, so a deferred Close is always safe. The body stays readable after the result goes out of scope, and has no size or time limit of the client's: the caller's context is the one bound on a slow read.

func (GetVulnerabilitiesExportResponse) WriteTo ¶

WriteTo copies the file to w and closes the body whatever happens, which is the one way to take the answer that cannot leave it open. A writer that failed is a client.WriteError, as against the server's side breaking off; it fails when the operation gave no answer, and again once the body is spent.

type GetVulnerabilitiesOptions ¶

type GetVulnerabilitiesOptions struct {
	// the environment whose findings are asked for: with none, nothing is found
	Env EnvironmentID

	// only findings whose CVE, package, image, container or stack holds this text, whatever its case
	Q string

	// only findings this grave: critical, high, medium or low, or several with commas between
	Severity string

	// only findings of the image by this name, whole, or of several with commas between
	Image string

	// only findings of the image a container by this name was made from
	Container string

	// only findings of the images a stack's containers were made from
	Stack string

	// what to order by: severity, cve, package, image, installed, fixed, container, stack or scannedAt
	Sort string

	// desc for the order turned round; by severity the gravest come first unless it is
	Dir string

	// the most findings to answer; every one unless given, and 0 for the counts alone
	Limit *int

	// how many findings to pass over first
	Offset *int
}

GetVulnerabilitiesOptions holds the query and header parameters of GetVulnerabilities.

func (GetVulnerabilitiesOptions) ToHeaders ¶

func (o GetVulnerabilitiesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (GetVulnerabilitiesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type GetVulnerabilitiesResponse ¶

type GetVulnerabilitiesResponse struct {
	HttpResponse *http.Response
	Answer       *GetVulnerabilitiesAnswer
	*GetVulnerabilitiesAnswer
}

GetVulnerabilitiesResponse is the result of GetVulnerabilities.

Answer is the GetVulnerabilitiesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (GetVulnerabilitiesResponse) Answered ¶

func (r GetVulnerabilitiesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (GetVulnerabilitiesResponse) Record ¶

Record is the GetVulnerabilitiesAnswer answered, as a value to change and write back, or an error when the server answered none.

type GitAuthType ¶

type GitAuthType string

GitAuthType is the "GitAuthType" enum.

const (
	GitAuthTypeNone     GitAuthType = "none"
	GitAuthTypePassword GitAuthType = "password"
	GitAuthTypeSsh      GitAuthType = "ssh"
)

Values of GitAuthType.

func (GitAuthType) Known ¶

func (v GitAuthType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type GitCredentialID ¶

type GitCredentialID int

GitCredentialID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and GitCredentialID(n) convert one value, client.IDs a list.

type GitRepositoryID ¶

type GitRepositoryID int

GitRepositoryID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and GitRepositoryID(n) convert one value, client.IDs a list.

type GitStackID ¶

type GitStackID int

GitStackID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and GitStackID(n) convert one value, client.IDs a list.

type GitStackSettings ¶

type GitStackSettings struct {
	Branch, EnvFilePath, ContextDir, SecretProvider, Webhook bool
}

GitStackSettings names the settings of a git stack that can be taken away rather than changed: the branch of its own, the extra .env file, the folder copied beside its compose file, the secret provider its secrets are loaded from, and its webhook with the secret that goes with it.

type JobStatus ¶

type JobStatus string

JobStatus is the "JobStatus" enum.

const (
	JobStatusRunning JobStatus = "running"
	JobStatusDone    JobStatus = "done"
	JobStatusError   JobStatus = "error"
)

Values of JobStatus.

func (JobStatus) Known ¶

func (v JobStatus) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type NotificationID ¶

type NotificationID int

NotificationID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and NotificationID(n) convert one value, client.IDs a list.

type NotificationType ¶

type NotificationType string

NotificationType is the "NotificationType" enum.

const (
	NotificationTypeSmtp    NotificationType = "smtp"
	NotificationTypeApprise NotificationType = "apprise"
)

Values of NotificationType.

func (NotificationType) Known ¶

func (v NotificationType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type PostAuthLdapAnswer ¶

type PostAuthLdapAnswer struct {
	BaseDn    string `json:"baseDn"`
	Enabled   bool   `json:"enabled"`
	Id        int    `json:"id"`
	Name      string `json:"name"`
	ServerUrl string `json:"serverUrl"`
}

PostAuthLdapAnswer is an object the document declares inline.

func (PostAuthLdapAnswer) GetId ¶

func (m PostAuthLdapAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (PostAuthLdapAnswer) GetName ¶

func (m PostAuthLdapAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostAuthLdapByIdTestResponse ¶

type PostAuthLdapByIdTestResponse struct {
	HttpResponse *http.Response
}

PostAuthLdapByIdTestResponse is the result of PostAuthLdapByIdTest.

type PostAuthLdapRequest ¶

type PostAuthLdapRequest struct {
	AdminGroup           string         `json:"adminGroup,omitempty"`
	BaseDn               string         `json:"baseDn"`
	BindDn               string         `json:"bindDn,omitempty"`
	BindPassword         string         `json:"bindPassword,omitempty"`
	DisplayNameAttribute string         `json:"displayNameAttribute,omitempty"`
	EmailAttribute       string         `json:"emailAttribute,omitempty"`
	Enabled              *bool          `json:"enabled,omitempty"`
	GroupBaseDn          string         `json:"groupBaseDn,omitempty"`
	GroupFilter          string         `json:"groupFilter,omitempty"`
	Name                 string         `json:"name"`
	RoleMappings         map[string]any `json:"roleMappings,omitzero"`
	ServerUrl            string         `json:"serverUrl"`
	TlsCa                string         `json:"tlsCa,omitempty"`
	TlsEnabled           *bool          `json:"tlsEnabled,omitempty"`
	UserFilter           string         `json:"userFilter,omitempty"`
	UsernameAttribute    string         `json:"usernameAttribute,omitempty"`
}

PostAuthLdapRequest is an object the document declares inline.

type PostAuthLdapResponse ¶

type PostAuthLdapResponse struct {
	HttpResponse *http.Response
	Answer       *PostAuthLdapAnswer
	*PostAuthLdapAnswer
}

PostAuthLdapResponse is the result of PostAuthLdap.

Answer is the PostAuthLdapAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAuthLdapResponse) Answered ¶

func (r PostAuthLdapResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAuthLdapResponse) Record ¶

Record is the PostAuthLdapAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostAuthLoginAnswer ¶

type PostAuthLoginAnswer struct {
	Success bool                     `json:"success"`
	User    *PostAuthLoginAnswerUser `json:"user,omitempty"`
}

PostAuthLoginAnswer is an object the document declares inline.

type PostAuthLoginAnswerUser ¶

type PostAuthLoginAnswerUser struct {
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Id          int    `json:"id"`
	IsAdmin     bool   `json:"isAdmin"`
	Username    string `json:"username"`
}

PostAuthLoginAnswerUser is an object the document declares inline.

type PostAuthLoginRequest ¶

type PostAuthLoginRequest struct {
	MfaToken string `json:"mfaToken,omitempty"`
	Password string `json:"password"`
	Provider string `json:"provider,omitempty"`
	Username string `json:"username"`
}

PostAuthLoginRequest is an object the document declares inline.

type PostAuthLoginResponse ¶

type PostAuthLoginResponse struct {
	HttpResponse *http.Response
	Answer       *PostAuthLoginAnswer
	*PostAuthLoginAnswer
}

PostAuthLoginResponse is the result of PostAuthLogin.

Answer is the PostAuthLoginAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAuthLoginResponse) Answered ¶

func (r PostAuthLoginResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAuthLoginResponse) Record ¶

Record is the PostAuthLoginAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostAuthLogoutAnswer ¶

type PostAuthLogoutAnswer struct {
	LogoutUrl string `json:"logoutUrl,omitempty"`
	Success   bool   `json:"success"`
}

PostAuthLogoutAnswer is an object the document declares inline.

type PostAuthLogoutResponse ¶

type PostAuthLogoutResponse struct {
	HttpResponse *http.Response
	Answer       *PostAuthLogoutAnswer
	*PostAuthLogoutAnswer
}

PostAuthLogoutResponse is the result of PostAuthLogout.

Answer is the PostAuthLogoutAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAuthLogoutResponse) Answered ¶

func (r PostAuthLogoutResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAuthLogoutResponse) Record ¶

Record is the PostAuthLogoutAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostAuthOidcAnswer ¶

type PostAuthOidcAnswer struct {
	// the claim named for an administrator, with adminValue; null when none is set
	AdminClaim string `json:"adminClaim,omitempty"`
	AdminValue string `json:"adminValue,omitempty"`
	ClientId   string `json:"clientId"`

	// eight asterisks, never the secret
	ClientSecret      string `json:"clientSecret,omitempty"`
	CreatedAt         Time   `json:"createdAt,omitzero"`
	DisplayNameClaim  string `json:"displayNameClaim,omitempty"`
	EmailClaim        string `json:"emailClaim,omitempty"`
	Enabled           bool   `json:"enabled"`
	Id                int    `json:"id"`
	IssuerUrl         string `json:"issuerUrl"`
	Name              string `json:"name"`
	RedirectUri       string `json:"redirectUri,omitempty"`
	RoleMappingsClaim string `json:"roleMappingsClaim,omitempty"`

	// the scopes named, with spaces between: openid profile email unless given
	Scopes        string `json:"scopes,omitempty"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
	UsernameClaim string `json:"usernameClaim,omitempty"`
}

PostAuthOidcAnswer is an object the document declares inline.

func (PostAuthOidcAnswer) GetId ¶

func (m PostAuthOidcAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (PostAuthOidcAnswer) GetName ¶

func (m PostAuthOidcAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostAuthOidcByIdInitiateAnswer ¶

type PostAuthOidcByIdInitiateAnswer struct {
	Url string `json:"url"`
}

PostAuthOidcByIdInitiateAnswer is an object the document declares inline.

type PostAuthOidcByIdInitiateRequest ¶

type PostAuthOidcByIdInitiateRequest struct {
	Redirect string `json:"redirect,omitempty"`
}

PostAuthOidcByIdInitiateRequest is an object the document declares inline.

type PostAuthOidcByIdInitiateResponse ¶

type PostAuthOidcByIdInitiateResponse struct {
	HttpResponse *http.Response
	Answer       *PostAuthOidcByIdInitiateAnswer
	*PostAuthOidcByIdInitiateAnswer
}

PostAuthOidcByIdInitiateResponse is the result of PostAuthOidcByIdInitiate.

Answer is the PostAuthOidcByIdInitiateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAuthOidcByIdInitiateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAuthOidcByIdInitiateResponse) Record ¶

Record is the PostAuthOidcByIdInitiateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostAuthOidcByIdTestResponse ¶

type PostAuthOidcByIdTestResponse struct {
	HttpResponse *http.Response
}

PostAuthOidcByIdTestResponse is the result of PostAuthOidcByIdTest.

type PostAuthOidcRequest ¶

type PostAuthOidcRequest struct {
	AdminClaim        string         `json:"adminClaim,omitempty"`
	AdminValue        string         `json:"adminValue,omitempty"`
	ClientId          string         `json:"clientId"`
	ClientSecret      string         `json:"clientSecret"`
	DisplayNameClaim  string         `json:"displayNameClaim,omitempty"`
	EmailClaim        string         `json:"emailClaim,omitempty"`
	Enabled           *bool          `json:"enabled,omitempty"`
	IssuerUrl         string         `json:"issuerUrl"`
	Name              string         `json:"name"`
	RedirectUri       string         `json:"redirectUri"`
	RoleMappings      map[string]any `json:"roleMappings,omitzero"`
	RoleMappingsClaim string         `json:"roleMappingsClaim,omitempty"`
	Scopes            string         `json:"scopes,omitempty"`
	UsernameClaim     string         `json:"usernameClaim,omitempty"`
}

PostAuthOidcRequest is an object the document declares inline.

type PostAuthOidcResponse ¶

type PostAuthOidcResponse struct {
	HttpResponse *http.Response
	Answer       *PostAuthOidcAnswer
	*PostAuthOidcAnswer
}

PostAuthOidcResponse is the result of PostAuthOidc.

Answer is the PostAuthOidcAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAuthOidcResponse) Answered ¶

func (r PostAuthOidcResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAuthOidcResponse) Record ¶

Record is the PostAuthOidcAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostAuthTokensAnswer ¶

type PostAuthTokensAnswer struct {
	Id          int    `json:"id"`
	Token       string `json:"token"`
	TokenPrefix string `json:"tokenPrefix"`
}

PostAuthTokensAnswer is an object the document declares inline.

type PostAuthTokensRequest ¶

type PostAuthTokensRequest struct {
	ExpiresAt Time   `json:"expiresAt,omitzero"`
	Name      string `json:"name"`
	Password  string `json:"password,omitempty"`
}

PostAuthTokensRequest is an object the document declares inline.

type PostAuthTokensResponse ¶

type PostAuthTokensResponse struct {
	HttpResponse *http.Response
	Answer       *PostAuthTokensAnswer
	*PostAuthTokensAnswer
}

PostAuthTokensResponse is the result of PostAuthTokens.

Answer is the PostAuthTokensAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAuthTokensResponse) Answered ¶

func (r PostAuthTokensResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAuthTokensResponse) Record ¶

Record is the PostAuthTokensAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostAutoUpdateByContainerNameAnswer ¶

type PostAutoUpdateByContainerNameAnswer struct {
	ContainerName         string        `json:"containerName,omitempty"`
	CreatedAt             Time          `json:"createdAt,omitzero"`
	CronExpression        string        `json:"cronExpression,omitempty"`
	Deleted               bool          `json:"deleted"`
	Enabled               bool          `json:"enabled"`
	EnvironmentId         EnvironmentID `json:"environmentId,omitempty"`
	Id                    int           `json:"id,omitempty"`
	LastChecked           Time          `json:"lastChecked,omitzero"`
	LastUpdated           Time          `json:"lastUpdated,omitzero"`
	ScheduleType          string        `json:"scheduleType,omitempty"`
	Success               bool          `json:"success"`
	UpdatedAt             Time          `json:"updatedAt,omitzero"`
	VulnerabilityCriteria string        `json:"vulnerabilityCriteria,omitempty"`
}

PostAutoUpdateByContainerNameAnswer is an object the document declares inline.

type PostAutoUpdateByContainerNameOptions ¶

type PostAutoUpdateByContainerNameOptions struct {
	// Environment the container belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostAutoUpdateByContainerNameOptions holds the query and header parameters of PostAutoUpdateByContainerName.

func (PostAutoUpdateByContainerNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostAutoUpdateByContainerNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostAutoUpdateByContainerNameRequest ¶

type PostAutoUpdateByContainerNameRequest struct {
	CronExpression        string `json:"cronExpression,omitempty"`
	Enabled               *bool  `json:"enabled,omitempty"`
	VulnerabilityCriteria string `json:"vulnerabilityCriteria,omitempty"`
}

PostAutoUpdateByContainerNameRequest is an object the document declares inline.

type PostAutoUpdateByContainerNameResponse ¶

type PostAutoUpdateByContainerNameResponse struct {
	HttpResponse *http.Response
	Answer       *PostAutoUpdateByContainerNameAnswer
	*PostAutoUpdateByContainerNameAnswer
}

PostAutoUpdateByContainerNameResponse is the result of PostAutoUpdateByContainerName.

Answer is the PostAutoUpdateByContainerNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostAutoUpdateByContainerNameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostAutoUpdateByContainerNameResponse) Record ¶

Record is the PostAutoUpdateByContainerNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupConfigsAnswer ¶ added in v0.2.0

type PostBackupConfigsAnswer struct {
	AllVolumes    bool                `json:"allVolumes"`
	CreatedAt     Time                `json:"createdAt,omitzero"`
	DestinationId BackupDestinationID `json:"destinationId,omitempty"`
	Enabled       bool                `json:"enabled"`

	// the environment the container or stack is on; null for one saved with none, which cannot be run
	EnvironmentId EnvironmentID  `json:"environmentId,omitempty"`
	Id            BackupConfigID `json:"id,omitempty"`
	LastBackupAt  Time           `json:"lastBackupAt,omitzero"`

	// success, warning, skipped or failed; null for one never run
	LastBackupStatus string `json:"lastBackupStatus,omitempty"`

	// more of how it is backed up, as JSON written out as text; null for none
	Options string `json:"options,omitempty"`

	// how many snapshots are kept, as JSON written out as text: keepLast, keepDaily, keepWeekly, keepMonthly, keepYearly; null to keep every one
	Retention string `json:"retention,omitempty"`

	// when it runs by itself, as cron; null or empty for one that only runs when asked
	Schedule string `json:"schedule,omitempty"`

	// the volumes to back up when not all of them, as a JSON list written out as text; null for none
	SelectedVolumes  string `json:"selectedVolumes,omitempty"`
	StopBeforeBackup bool   `json:"stopBeforeBackup"`

	// as a JSON list written out as text; null for none
	Tags       string `json:"tags,omitempty"`
	TargetName string `json:"targetName,omitempty"`

	// container or stack, as it was given: any other word is kept and then backs up nothing
	Type      string `json:"type,omitempty"`
	UpdatedAt Time   `json:"updatedAt,omitzero"`
}

PostBackupConfigsAnswer is an object the document declares inline.

type PostBackupConfigsByIdRunAnswer ¶ added in v0.2.0

type PostBackupConfigsByIdRunAnswer struct {
	// for one that failed, the kind of failure: VALIDATION, RESTIC or UNKNOWN
	Code  string `json:"code,omitempty"`
	Error string `json:"error,omitempty"`

	// the run, among those GET /api/schedules/executions lists
	ExecutionId int `json:"executionId,omitempty"`

	// the job the backup runs as, for a caller that asked for one: GET /api/jobs/{id} then answers the rest as its result
	JobId string `json:"jobId,omitempty"`

	// for one that was skipped, why: Backup cancelled for one that was stopped
	Reason string `json:"reason,omitempty"`

	// applied when older snapshots were looked through for ones to drop, none when the backup keeps every one
	Retention  string `json:"retention,omitempty"`
	SnapshotId string `json:"snapshotId,omitempty"`

	// success, warning, skipped or error
	Status  string                                 `json:"status,omitempty"`
	Summary *PostBackupConfigsByIdRunAnswerSummary `json:"summary,omitempty"`
}

PostBackupConfigsByIdRunAnswer is an object the document declares inline.

type PostBackupConfigsByIdRunAnswerSummary ¶ added in v0.2.0

type PostBackupConfigsByIdRunAnswerSummary struct {
	// bytes the store grew by
	DataAdded           int    `json:"dataAdded,omitempty"`
	FilesChanged        int    `json:"filesChanged,omitempty"`
	FilesNew            int    `json:"filesNew,omitempty"`
	FilesUnmodified     int    `json:"filesUnmodified,omitempty"`
	SnapshotId          string `json:"snapshotId,omitempty"`
	TotalBytesProcessed int    `json:"totalBytesProcessed,omitempty"`
	TotalFilesProcessed int    `json:"totalFilesProcessed,omitempty"`
}

PostBackupConfigsByIdRunAnswerSummary is an object the document declares inline.

type PostBackupConfigsByIdRunOptions ¶ added in v0.2.0

type PostBackupConfigsByIdRunOptions struct {
	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostBackupConfigsByIdRunOptions holds the query and header parameters of PostBackupConfigsByIdRun.

func (PostBackupConfigsByIdRunOptions) ToHeaders ¶ added in v0.2.0

ToHeaders returns the header parameters the options set.

func (PostBackupConfigsByIdRunOptions) ToQuery ¶ added in v0.2.0

ToQuery returns the query parameters the options set.

type PostBackupConfigsByIdRunResponse ¶

type PostBackupConfigsByIdRunResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupConfigsByIdRunAnswer
	*PostBackupConfigsByIdRunAnswer
}

PostBackupConfigsByIdRunResponse is the result of PostBackupConfigsByIdRun.

Answer is the PostBackupConfigsByIdRunAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupConfigsByIdRunResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupConfigsByIdRunResponse) Record ¶ added in v0.2.0

Record is the PostBackupConfigsByIdRunAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupConfigsByIdStopAnswer ¶ added in v0.2.0

type PostBackupConfigsByIdStopAnswer struct {
	// whether anything was running to stop
	Stopped bool `json:"stopped"`
	Success bool `json:"success"`
}

PostBackupConfigsByIdStopAnswer is an object the document declares inline.

type PostBackupConfigsByIdStopResponse ¶

type PostBackupConfigsByIdStopResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupConfigsByIdStopAnswer
	*PostBackupConfigsByIdStopAnswer
}

PostBackupConfigsByIdStopResponse is the result of PostBackupConfigsByIdStop.

Answer is the PostBackupConfigsByIdStopAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupConfigsByIdStopResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupConfigsByIdStopResponse) Record ¶ added in v0.2.0

Record is the PostBackupConfigsByIdStopAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupConfigsRequest ¶

type PostBackupConfigsRequest struct {
	AllVolumes       *bool                              `json:"allVolumes,omitempty"`
	DestinationId    BackupDestinationID                `json:"destinationId"`
	Enabled          *bool                              `json:"enabled,omitempty"`
	EnvironmentId    EnvironmentID                      `json:"environmentId,omitempty"`
	Options          map[string]any                     `json:"options,omitzero"`
	Retention        *PostBackupConfigsRequestRetention `json:"retention,omitempty"`
	Schedule         string                             `json:"schedule,omitempty"`
	SelectedVolumes  []string                           `json:"selectedVolumes,omitzero"`
	StopBeforeBackup *bool                              `json:"stopBeforeBackup,omitempty"`
	Tags             []string                           `json:"tags,omitzero"`
	TargetName       string                             `json:"targetName"`
	Type             string                             `json:"type,omitempty"`
}

PostBackupConfigsRequest is an object the document declares inline.

type PostBackupConfigsRequestRetention ¶

type PostBackupConfigsRequestRetention struct {
	KeepDaily   int `json:"keepDaily,omitempty"`
	KeepLast    int `json:"keepLast,omitempty"`
	KeepMonthly int `json:"keepMonthly,omitempty"`
	KeepWeekly  int `json:"keepWeekly,omitempty"`
	KeepYearly  int `json:"keepYearly,omitempty"`
}

PostBackupConfigsRequestRetention is an object the document declares inline.

type PostBackupConfigsResponse ¶

type PostBackupConfigsResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupConfigsAnswer
	*PostBackupConfigsAnswer
}

PostBackupConfigsResponse is the result of PostBackupConfigs.

Answer is the PostBackupConfigsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupConfigsResponse) Answered ¶ added in v0.2.0

func (r PostBackupConfigsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupConfigsResponse) Record ¶ added in v0.2.0

Record is the PostBackupConfigsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsAnswer ¶ added in v0.2.0

type PostBackupDestinationsAnswer struct {
	// more that restic is given for a backup; left out of the list
	BackupFlags string `json:"backupFlags,omitempty"`
	CreatedAt   Time   `json:"createdAt,omitzero"`

	// what the store is signed in to with, by the names restic reads them under; sent where one destination is read, made or changed, and left out of the list
	EnvVars map[string]string `json:"envVars,omitzero"`

	// the flags of a backup and of a restore together, as JSON written out as text; null for none. Sent, it is taken as the flags of a backup
	Flags            string              `json:"flags,omitempty"`
	HasCacert        bool                `json:"hasCacert"`
	HasTlsClientCert bool                `json:"hasTlsClientCert"`
	HostPath         string              `json:"hostPath,omitempty"`
	Id               BackupDestinationID `json:"id,omitempty"`
	LastTestAt       Time                `json:"lastTestAt,omitzero"`
	LastTestError    string              `json:"lastTestError,omitempty"`

	// how the last try of it went: success, failed or needs_init; null for one never tried
	LastTestStatus string `json:"lastTestStatus,omitempty"`
	Name           string `json:"name,omitempty"`

	// how the store is looked after by itself, as JSON written out as text: whether and when it is pruned, checked and verified
	Policies string `json:"policies,omitempty"`

	// where the backups are kept, as restic names it: a folder's path, or an address that opens with rest:, s3:, b2:, azure: or gs:
	Repository string `json:"repository,omitempty"`

	// more that restic is given for a restore; left out of the list
	RestoreFlags string `json:"restoreFlags,omitempty"`
	UpdatedAt    Time   `json:"updatedAt,omitzero"`
}

PostBackupDestinationsAnswer is an object the document declares inline.

func (PostBackupDestinationsAnswer) GetId ¶ added in v0.2.0

GetId is the record's Id, for code that handles records of several types alike.

func (PostBackupDestinationsAnswer) GetName ¶ added in v0.2.0

GetName is the record's Name, for code that handles records of several types alike.

type PostBackupDestinationsByIdInitAnswer ¶ added in v0.2.0

type PostBackupDestinationsByIdInitAnswer struct {
	Error   string `json:"error,omitempty"`
	Message string `json:"message,omitempty"`
	Success bool   `json:"success"`
}

PostBackupDestinationsByIdInitAnswer is an object the document declares inline.

type PostBackupDestinationsByIdInitResponse ¶

type PostBackupDestinationsByIdInitResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsByIdInitAnswer
	*PostBackupDestinationsByIdInitAnswer
}

PostBackupDestinationsByIdInitResponse is the result of PostBackupDestinationsByIdInit.

Answer is the PostBackupDestinationsByIdInitAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsByIdInitResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsByIdInitResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsByIdInitAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsByIdRotateKeyAnswer ¶ added in v0.2.0

type PostBackupDestinationsByIdRotateKeyAnswer struct {
	Error   string `json:"error,omitempty"`
	Success bool   `json:"success"`
}

PostBackupDestinationsByIdRotateKeyAnswer is an object the document declares inline.

type PostBackupDestinationsByIdRotateKeyRequest ¶

type PostBackupDestinationsByIdRotateKeyRequest struct {
	CurrentPassword string `json:"currentPassword"`
	NewPassword     string `json:"newPassword"`
}

PostBackupDestinationsByIdRotateKeyRequest is an object the document declares inline.

type PostBackupDestinationsByIdRotateKeyResponse ¶

type PostBackupDestinationsByIdRotateKeyResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsByIdRotateKeyAnswer
	*PostBackupDestinationsByIdRotateKeyAnswer
}

PostBackupDestinationsByIdRotateKeyResponse is the result of PostBackupDestinationsByIdRotateKey.

Answer is the PostBackupDestinationsByIdRotateKeyAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsByIdRotateKeyResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsByIdRotateKeyResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsByIdRotateKeyAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsByIdTaskAnswer ¶ added in v0.2.0

type PostBackupDestinationsByIdTaskAnswer struct {
	Error string `json:"error,omitempty"`

	// the job the work runs as, for a caller that asked for one
	JobId string `json:"jobId,omitempty"`

	// what restic printed
	Output string `json:"output,omitempty"`

	// for the stats task: what the store holds
	Stats   *PostBackupDestinationsByIdTaskAnswerStats `json:"stats,omitempty"`
	Success bool                                       `json:"success"`
}

PostBackupDestinationsByIdTaskAnswer is an object the document declares inline.

type PostBackupDestinationsByIdTaskAnswerStats ¶ added in v0.2.0

type PostBackupDestinationsByIdTaskAnswerStats struct {
	Snapshots  int `json:"snapshots,omitempty"`
	TotalFiles int `json:"totalFiles,omitempty"`
	TotalSize  int `json:"totalSize,omitempty"`
}

PostBackupDestinationsByIdTaskAnswerStats is an object the document declares inline.

for the stats task: what the store holds

type PostBackupDestinationsByIdTaskOptions ¶ added in v0.2.0

type PostBackupDestinationsByIdTaskOptions struct {
	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostBackupDestinationsByIdTaskOptions holds the query and header parameters of PostBackupDestinationsByIdTask.

func (PostBackupDestinationsByIdTaskOptions) ToHeaders ¶ added in v0.2.0

ToHeaders returns the header parameters the options set.

func (PostBackupDestinationsByIdTaskOptions) ToQuery ¶ added in v0.2.0

ToQuery returns the query parameters the options set.

type PostBackupDestinationsByIdTaskRequest ¶

type PostBackupDestinationsByIdTaskRequest struct {
	Task string `json:"task"`
}

PostBackupDestinationsByIdTaskRequest is an object the document declares inline.

type PostBackupDestinationsByIdTaskResponse ¶

type PostBackupDestinationsByIdTaskResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsByIdTaskAnswer
	*PostBackupDestinationsByIdTaskAnswer
}

PostBackupDestinationsByIdTaskResponse is the result of PostBackupDestinationsByIdTask.

Answer is the PostBackupDestinationsByIdTaskAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsByIdTaskResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsByIdTaskResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsByIdTaskAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsByIdTestAnswer ¶ added in v0.2.0

type PostBackupDestinationsByIdTestAnswer struct {
	Error string `json:"error,omitempty"`

	// nothing answered as a repository there: one not made yet, and one that could not be reached, read alike
	NeedsInit bool `json:"needsInit"`

	// for a saved destination: success, failed or needs_init
	Status  string `json:"status,omitempty"`
	Success bool   `json:"success"`
}

PostBackupDestinationsByIdTestAnswer is an object the document declares inline.

type PostBackupDestinationsByIdTestResponse ¶

type PostBackupDestinationsByIdTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsByIdTestAnswer
	*PostBackupDestinationsByIdTestAnswer
}

PostBackupDestinationsByIdTestResponse is the result of PostBackupDestinationsByIdTest.

Answer is the PostBackupDestinationsByIdTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsByIdTestResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsByIdTestResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsByIdTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsByIdVerifyAnswer ¶ added in v0.2.0

type PostBackupDestinationsByIdVerifyAnswer struct {
	Error string `json:"error,omitempty"`

	// the job the work runs as, for a caller that asked for one
	JobId string `json:"jobId,omitempty"`

	// what restic printed
	Output  string `json:"output,omitempty"`
	Success bool   `json:"success"`
}

PostBackupDestinationsByIdVerifyAnswer is an object the document declares inline.

type PostBackupDestinationsByIdVerifyOptions ¶ added in v0.2.0

type PostBackupDestinationsByIdVerifyOptions struct {
	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostBackupDestinationsByIdVerifyOptions holds the query and header parameters of PostBackupDestinationsByIdVerify.

func (PostBackupDestinationsByIdVerifyOptions) ToHeaders ¶ added in v0.2.0

ToHeaders returns the header parameters the options set.

func (PostBackupDestinationsByIdVerifyOptions) ToQuery ¶ added in v0.2.0

ToQuery returns the query parameters the options set.

type PostBackupDestinationsByIdVerifyRequest ¶

type PostBackupDestinationsByIdVerifyRequest struct {
	DataSubset string `json:"dataSubset,omitempty"`
}

PostBackupDestinationsByIdVerifyRequest is an object the document declares inline.

type PostBackupDestinationsByIdVerifyResponse ¶

type PostBackupDestinationsByIdVerifyResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsByIdVerifyAnswer
	*PostBackupDestinationsByIdVerifyAnswer
}

PostBackupDestinationsByIdVerifyResponse is the result of PostBackupDestinationsByIdVerify.

Answer is the PostBackupDestinationsByIdVerifyAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsByIdVerifyResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsByIdVerifyResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsByIdVerifyAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsRequest ¶

type PostBackupDestinationsRequest struct {
	BackupFlags   string         `json:"backupFlags,omitempty"`
	Cacert        string         `json:"cacert,omitempty"`
	EnvVars       map[string]any `json:"envVars,omitzero"`
	Flags         string         `json:"flags,omitempty"`
	HostPath      string         `json:"hostPath,omitempty"`
	Name          string         `json:"name"`
	Password      string         `json:"password"`
	Policies      string         `json:"policies,omitempty"`
	Repository    string         `json:"repository"`
	RestoreFlags  string         `json:"restoreFlags,omitempty"`
	TlsClientCert string         `json:"tlsClientCert,omitempty"`
}

PostBackupDestinationsRequest is an object the document declares inline.

type PostBackupDestinationsResponse ¶

type PostBackupDestinationsResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsAnswer
	*PostBackupDestinationsAnswer
}

PostBackupDestinationsResponse is the result of PostBackupDestinations.

Answer is the PostBackupDestinationsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsResponse) Answered ¶ added in v0.2.0

func (r PostBackupDestinationsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupDestinationsTestAnswer ¶ added in v0.2.0

type PostBackupDestinationsTestAnswer struct {
	Error string `json:"error,omitempty"`

	// nothing answered as a repository there: one not made yet, and one that could not be reached, read alike
	NeedsInit bool `json:"needsInit"`

	// for a saved destination: success, failed or needs_init
	Status  string `json:"status,omitempty"`
	Success bool   `json:"success"`
}

PostBackupDestinationsTestAnswer is an object the document declares inline.

type PostBackupDestinationsTestRequest ¶

type PostBackupDestinationsTestRequest struct {
	Cacert        string              `json:"cacert,omitempty"`
	DestinationId BackupDestinationID `json:"destinationId,omitempty"`
	EnvVars       map[string]any      `json:"envVars,omitzero"`
	Password      string              `json:"password,omitempty"`
	Repository    string              `json:"repository,omitempty"`
	TlsClientCert string              `json:"tlsClientCert,omitempty"`
}

PostBackupDestinationsTestRequest is an object the document declares inline.

type PostBackupDestinationsTestResponse ¶

type PostBackupDestinationsTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupDestinationsTestAnswer
	*PostBackupDestinationsTestAnswer
}

PostBackupDestinationsTestResponse is the result of PostBackupDestinationsTest.

Answer is the PostBackupDestinationsTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupDestinationsTestResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupDestinationsTestResponse) Record ¶ added in v0.2.0

Record is the PostBackupDestinationsTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupRestoreAnswer ¶ added in v0.2.0

type PostBackupRestoreAnswer struct {
	Code        string `json:"code,omitempty"`
	Error       string `json:"error,omitempty"`
	ExecutionId int    `json:"executionId,omitempty"`

	// the job the restore runs as, for a caller that asked for one
	JobId string `json:"jobId,omitempty"`

	// what was done with the container or stack once its data was back
	PostRestore     *PostBackupRestoreAnswerPostRestore `json:"postRestore,omitempty"`
	RestoredVolumes []string                            `json:"restoredVolumes,omitzero"`

	// success, warning or error
	Status     string `json:"status,omitempty"`
	TargetPath string `json:"targetPath,omitempty"`
}

PostBackupRestoreAnswer is an object the document declares inline.

type PostBackupRestoreAnswerPostRestore ¶ added in v0.2.0

type PostBackupRestoreAnswerPostRestore struct {
	// none, start or recreate
	Action string `json:"action,omitempty"`
	Error  string `json:"error,omitempty"`
	Ok     bool   `json:"ok"`
}

PostBackupRestoreAnswerPostRestore is an object the document declares inline.

what was done with the container or stack once its data was back

type PostBackupRestoreOptions ¶ added in v0.2.0

type PostBackupRestoreOptions struct {
	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostBackupRestoreOptions holds the query and header parameters of PostBackupRestore.

func (PostBackupRestoreOptions) ToHeaders ¶ added in v0.2.0

func (o PostBackupRestoreOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostBackupRestoreOptions) ToQuery ¶ added in v0.2.0

ToQuery returns the query parameters the options set.

type PostBackupRestorePreviewAnswer ¶ added in v0.2.0

type PostBackupRestorePreviewAnswer struct {
	BackupTime          Time          `json:"backupTime,omitzero"`
	Error               string        `json:"error,omitempty"`
	HasMetadata         bool          `json:"hasMetadata"`
	HasStackFiles       bool          `json:"hasStackFiles"`
	SnapshotId          string        `json:"snapshotId,omitempty"`
	SourceEnvironmentId EnvironmentID `json:"sourceEnvironmentId,omitempty"`
	SourceSecretKeys    []string      `json:"sourceSecretKeys,omitzero"`

	// with includeTargets: where each volume and the stack's files would be written
	Targets       *PostBackupRestorePreviewAnswerTargets `json:"targets,omitempty"`
	VolumeSources map[string]string                      `json:"volumeSources,omitzero"`
	VolumeTypes   map[string]string                      `json:"volumeTypes,omitzero"`
	Volumes       []string                               `json:"volumes,omitzero"`
}

PostBackupRestorePreviewAnswer is an object the document declares inline.

type PostBackupRestorePreviewAnswerTargets ¶ added in v0.2.0

type PostBackupRestorePreviewAnswerTargets struct {
	HelperOk bool `json:"helperOk"`

	// where a stack's files would be written; null for a snapshot that holds none
	StackFiles *PostBackupRestorePreviewAnswerTargetsStackFiles  `json:"stackFiles,omitempty"`
	Unresolved []PostBackupRestorePreviewAnswerTargetsUnresolved `json:"unresolved,omitzero"`
	Volumes    []PostBackupRestorePreviewAnswerTargetsVolumes    `json:"volumes,omitzero"`
}

PostBackupRestorePreviewAnswerTargets is an object the document declares inline.

with includeTargets: where each volume and the stack's files would be written

type PostBackupRestorePreviewAnswerTargetsStackFiles ¶ added in v0.2.0

type PostBackupRestorePreviewAnswerTargetsStackFiles struct {
	HasData   string `json:"hasData,omitempty"`
	TargetDir string `json:"targetDir,omitempty"`
	WillWrite bool   `json:"willWrite"`
}

PostBackupRestorePreviewAnswerTargetsStackFiles is an object the document declares inline.

where a stack's files would be written; null for a snapshot that holds none

type PostBackupRestorePreviewAnswerTargetsUnresolved ¶ added in v0.2.0

type PostBackupRestorePreviewAnswerTargetsUnresolved struct {
	Key    string `json:"key,omitempty"`
	Reason string `json:"reason,omitempty"`
}

PostBackupRestorePreviewAnswerTargetsUnresolved is an object the document declares inline.

type PostBackupRestorePreviewAnswerTargetsVolumes ¶ added in v0.2.0

type PostBackupRestorePreviewAnswerTargetsVolumes struct {
	// what is there now: has-data, empty or missing
	HasData string `json:"hasData,omitempty"`
	Key     string `json:"key,omitempty"`

	// how the target was come by: in-place-metadata, loose-files or clone
	Origin string `json:"origin,omitempty"`
	Target string `json:"target,omitempty"`

	// volume or bind
	Type string `json:"type,omitempty"`
}

PostBackupRestorePreviewAnswerTargetsVolumes is an object the document declares inline.

type PostBackupRestorePreviewRequest ¶

type PostBackupRestorePreviewRequest struct {
	DestinationId   BackupDestinationID `json:"destinationId"`
	EnvironmentId   EnvironmentID       `json:"environmentId,omitempty"`
	IncludeTargets  *bool               `json:"includeTargets,omitempty"`
	MergeStackFiles *bool               `json:"mergeStackFiles,omitempty"`
	Mode            string              `json:"mode,omitempty"`
	SkipStackFiles  *bool               `json:"skipStackFiles,omitempty"`
	SnapshotId      string              `json:"snapshotId"`
	TargetEnvId     EnvironmentID       `json:"targetEnvId,omitempty"`
	TargetName      string              `json:"targetName,omitempty"`
	TargetPath      string              `json:"targetPath,omitempty"`
	TargetType      string              `json:"targetType,omitempty"`

	// where a volume of the snapshot is to go: the volume as the snapshot names it, and the volume or the path on the host to put it in
	VolumeDestinations []PostBackupRestorePreviewRequestVolumeDestinations `json:"volumeDestinations,omitzero"`
	Volumes            []string                                            `json:"volumes,omitzero"`
}

PostBackupRestorePreviewRequest is an object the document declares inline.

type PostBackupRestorePreviewRequestVolumeDestinations ¶ added in v0.2.0

type PostBackupRestorePreviewRequestVolumeDestinations struct {
	Target string `json:"target,omitempty"`
	Volume string `json:"volume,omitempty"`
}

PostBackupRestorePreviewRequestVolumeDestinations is an object the document declares inline.

type PostBackupRestorePreviewResponse ¶

type PostBackupRestorePreviewResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupRestorePreviewAnswer
	*PostBackupRestorePreviewAnswer
}

PostBackupRestorePreviewResponse is the result of PostBackupRestorePreview.

Answer is the PostBackupRestorePreviewAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupRestorePreviewResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupRestorePreviewResponse) Record ¶ added in v0.2.0

Record is the PostBackupRestorePreviewAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupRestoreRequest ¶

type PostBackupRestoreRequest struct {
	ConfirmOverwrite *bool               `json:"confirmOverwrite,omitempty"`
	DestinationId    BackupDestinationID `json:"destinationId"`
	EnvironmentId    EnvironmentID       `json:"environmentId,omitempty"`
	Mode             string              `json:"mode,omitempty"`
	PostRestore      string              `json:"postRestore,omitempty"`
	RestoreSecrets   *bool               `json:"restoreSecrets,omitempty"`
	SkipStackFiles   *bool               `json:"skipStackFiles,omitempty"`
	SnapshotId       string              `json:"snapshotId"`
	TargetName       string              `json:"targetName,omitempty"`
	TargetPath       string              `json:"targetPath,omitempty"`
	TargetType       string              `json:"targetType,omitempty"`

	// where a volume of the snapshot is to go: the volume as the snapshot names it, whether the target is a volume or a path on the host, and the target
	VolumeDestinations []PostBackupRestoreRequestVolumeDestinations `json:"volumeDestinations,omitzero"`
	Volumes            []string                                     `json:"volumes,omitzero"`
}

PostBackupRestoreRequest is an object the document declares inline.

type PostBackupRestoreRequestVolumeDestinations ¶ added in v0.2.0

type PostBackupRestoreRequestVolumeDestinations struct {
	// volume or path
	Kind   string `json:"kind,omitempty"`
	Target string `json:"target,omitempty"`
	Volume string `json:"volume,omitempty"`
}

PostBackupRestoreRequestVolumeDestinations is an object the document declares inline.

type PostBackupRestoreResponse ¶

type PostBackupRestoreResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupRestoreAnswer
	*PostBackupRestoreAnswer
}

PostBackupRestoreResponse is the result of PostBackupRestore.

Answer is the PostBackupRestoreAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupRestoreResponse) Answered ¶ added in v0.2.0

func (r PostBackupRestoreResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupRestoreResponse) Record ¶ added in v0.2.0

Record is the PostBackupRestoreAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupRestoreStopAnswer ¶ added in v0.2.0

type PostBackupRestoreStopAnswer struct {
	// whether anything was running to stop
	Stopped bool `json:"stopped"`
	Success bool `json:"success"`
}

PostBackupRestoreStopAnswer is an object the document declares inline.

type PostBackupRestoreStopRequest ¶

type PostBackupRestoreStopRequest struct {
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	SnapshotId    string        `json:"snapshotId,omitempty"`
}

PostBackupRestoreStopRequest is an object the document declares inline.

type PostBackupRestoreStopResponse ¶

type PostBackupRestoreStopResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupRestoreStopAnswer
	*PostBackupRestoreStopAnswer
}

PostBackupRestoreStopResponse is the result of PostBackupRestoreStop.

Answer is the PostBackupRestoreStopAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupRestoreStopResponse) Answered ¶ added in v0.2.0

func (r PostBackupRestoreStopResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupRestoreStopResponse) Record ¶ added in v0.2.0

Record is the PostBackupRestoreStopAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBackupSnapshotsBatchDeleteAnswer ¶ added in v0.2.0

type PostBackupSnapshotsBatchDeleteAnswer struct {
	Deleted []string `json:"deleted,omitzero"`

	// the ones that are not this Dockhand's, or are not there
	Skipped []string `json:"skipped,omitzero"`
	Success bool     `json:"success"`
}

PostBackupSnapshotsBatchDeleteAnswer is an object the document declares inline.

type PostBackupSnapshotsBatchDeleteRequest ¶

type PostBackupSnapshotsBatchDeleteRequest struct {
	DestinationId BackupDestinationID `json:"destinationId"`
	SnapshotIds   []string            `json:"snapshotIds"`
}

PostBackupSnapshotsBatchDeleteRequest is an object the document declares inline.

type PostBackupSnapshotsBatchDeleteResponse ¶

type PostBackupSnapshotsBatchDeleteResponse struct {
	HttpResponse *http.Response
	Answer       *PostBackupSnapshotsBatchDeleteAnswer
	*PostBackupSnapshotsBatchDeleteAnswer
}

PostBackupSnapshotsBatchDeleteResponse is the result of PostBackupSnapshotsBatchDelete.

Answer is the PostBackupSnapshotsBatchDeleteAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostBackupSnapshotsBatchDeleteResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostBackupSnapshotsBatchDeleteResponse) Record ¶ added in v0.2.0

Record is the PostBackupSnapshotsBatchDeleteAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostBatchOptions ¶

type PostBatchOptions struct {
	// Environment ID the entities belong to (from GET /api/environments)
	Env EnvironmentID
}

PostBatchOptions holds the query and header parameters of PostBatch.

func (PostBatchOptions) ToHeaders ¶

func (o PostBatchOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostBatchOptions) ToQuery ¶

func (o PostBatchOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type PostBatchRequest ¶

type PostBatchRequest struct {
	EntityType string                   `json:"entityType"`
	Items      []PostBatchRequestItems  `json:"items"`
	Operation  string                   `json:"operation"`
	Options    *PostBatchRequestOptions `json:"options,omitempty"`
}

PostBatchRequest is an object the document declares inline.

type PostBatchRequestItems ¶

type PostBatchRequestItems struct {
	Id   string `json:"id"`
	Name string `json:"name"`
}

PostBatchRequestItems is an object the document declares inline.

func (PostBatchRequestItems) GetId ¶

func (m PostBatchRequestItems) GetId() string

GetId is the record's Id, for code that handles records of several types alike.

func (PostBatchRequestItems) GetName ¶

func (m PostBatchRequestItems) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostBatchRequestOptions ¶

type PostBatchRequestOptions struct {
	Force         *bool `json:"force,omitempty"`
	RemoveVolumes *bool `json:"removeVolumes,omitempty"`
}

PostBatchRequestOptions is an object the document declares inline.

type PostBatchResponse ¶

type PostBatchResponse struct {
	HttpResponse *http.Response
}

PostBatchResponse is the result of PostBatch.

type PostConfigSetsAnswer ¶

type PostConfigSetsAnswer struct {
	CreatedAt     Time                          `json:"createdAt"`
	Description   string                        `json:"description,omitempty"`
	EnvVars       []PostConfigSetsAnswerEnvVars `json:"envVars,omitzero"`
	Id            ConfigSetID                   `json:"id"`
	Labels        []PostConfigSetsAnswerLabels  `json:"labels,omitzero"`
	Name          string                        `json:"name"`
	NetworkMode   string                        `json:"networkMode"`
	Ports         []PostConfigSetsAnswerPorts   `json:"ports,omitzero"`
	RestartPolicy string                        `json:"restartPolicy"`
	UpdatedAt     Time                          `json:"updatedAt"`
	Volumes       []PostConfigSetsAnswerVolumes `json:"volumes,omitzero"`
}

PostConfigSetsAnswer is an object the document declares inline.

func (PostConfigSetsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostConfigSetsAnswer) GetName ¶

func (m PostConfigSetsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostConfigSetsAnswerEnvVars ¶

type PostConfigSetsAnswerEnvVars struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PostConfigSetsAnswerEnvVars is an object the document declares inline.

type PostConfigSetsAnswerLabels ¶

type PostConfigSetsAnswerLabels struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PostConfigSetsAnswerLabels is an object the document declares inline.

type PostConfigSetsAnswerPorts ¶

type PostConfigSetsAnswerPorts struct {
	ContainerPort string `json:"containerPort"`
	HostPort      string `json:"hostPort"`
	Protocol      string `json:"protocol"`
}

PostConfigSetsAnswerPorts is an object the document declares inline.

type PostConfigSetsAnswerVolumes ¶

type PostConfigSetsAnswerVolumes struct {
	ContainerPath string `json:"containerPath"`
	HostPath      string `json:"hostPath"`
	Mode          string `json:"mode"`
}

PostConfigSetsAnswerVolumes is an object the document declares inline.

type PostConfigSetsRequest ¶

type PostConfigSetsRequest struct {
	Description   string                         `json:"description,omitempty"`
	EnvVars       []PostConfigSetsRequestEnvVars `json:"envVars,omitzero"`
	Labels        []PostConfigSetsRequestLabels  `json:"labels,omitzero"`
	Name          string                         `json:"name"`
	NetworkMode   string                         `json:"networkMode,omitempty"`
	Ports         []PostConfigSetsRequestPorts   `json:"ports,omitzero"`
	RestartPolicy string                         `json:"restartPolicy,omitempty"`
	Volumes       []PostConfigSetsRequestVolumes `json:"volumes,omitzero"`
}

PostConfigSetsRequest is an object the document declares inline.

type PostConfigSetsRequestEnvVars ¶

type PostConfigSetsRequestEnvVars struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PostConfigSetsRequestEnvVars is an object the document declares inline.

type PostConfigSetsRequestLabels ¶

type PostConfigSetsRequestLabels struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PostConfigSetsRequestLabels is an object the document declares inline.

type PostConfigSetsRequestPorts ¶

type PostConfigSetsRequestPorts struct {
	ContainerPort string `json:"containerPort"`
	HostPort      string `json:"hostPort"`
	Protocol      string `json:"protocol"`
}

PostConfigSetsRequestPorts is an object the document declares inline.

type PostConfigSetsRequestVolumes ¶

type PostConfigSetsRequestVolumes struct {
	ContainerPath string `json:"containerPath"`
	HostPath      string `json:"hostPath"`
	Mode          string `json:"mode"`
}

PostConfigSetsRequestVolumes is an object the document declares inline.

type PostConfigSetsResponse ¶

type PostConfigSetsResponse struct {
	HttpResponse *http.Response
	Answer       *PostConfigSetsAnswer
	*PostConfigSetsAnswer
}

PostConfigSetsResponse is the result of PostConfigSets.

Answer is the PostConfigSetsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostConfigSetsResponse) Answered ¶

func (r PostConfigSetsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostConfigSetsResponse) Record ¶

Record is the PostConfigSetsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainerIconsByNameAnswer ¶

type PostContainerIconsByNameAnswer struct {
	Icon    string `json:"icon"`
	Success bool   `json:"success"`
}

PostContainerIconsByNameAnswer is an object the document declares inline.

type PostContainerIconsByNameOptions ¶

type PostContainerIconsByNameOptions struct {
	// Environment id the container belongs to
	Env EnvironmentID
}

PostContainerIconsByNameOptions holds the query and header parameters of PostContainerIconsByName.

func (PostContainerIconsByNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainerIconsByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainerIconsByNameRequest ¶

type PostContainerIconsByNameRequest struct {
	Icon  string `json:"icon,omitempty"`
	Image string `json:"image,omitempty"`
}

PostContainerIconsByNameRequest is an object the document declares inline.

type PostContainerIconsByNameResponse ¶

type PostContainerIconsByNameResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainerIconsByNameAnswer
	*PostContainerIconsByNameAnswer
}

PostContainerIconsByNameResponse is the result of PostContainerIconsByName.

Answer is the PostContainerIconsByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainerIconsByNameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainerIconsByNameResponse) Record ¶

Record is the PostContainerIconsByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersAnswer ¶

type PostContainersAnswer struct {
	Id          string `json:"id"`
	ImagePulled bool   `json:"imagePulled"`
	Success     bool   `json:"success"`
}

PostContainersAnswer is an object the document declares inline.

type PostContainersBatchUpdateAnswer ¶

type PostContainersBatchUpdateAnswer struct {
	Results []PostContainersBatchUpdateAnswerResults `json:"results"`
	Success bool                                     `json:"success"`
	Summary *PostContainersBatchUpdateAnswerSummary  `json:"summary"`
}

PostContainersBatchUpdateAnswer is an object the document declares inline.

type PostContainersBatchUpdateAnswerResults ¶

type PostContainersBatchUpdateAnswerResults struct {
	ContainerId   string `json:"containerId"`
	ContainerName string `json:"containerName"`
	Error         string `json:"error,omitempty"`
	Success       bool   `json:"success"`
}

PostContainersBatchUpdateAnswerResults is an object the document declares inline.

type PostContainersBatchUpdateAnswerSummary ¶

type PostContainersBatchUpdateAnswerSummary struct {
	Failed  int `json:"failed"`
	Success int `json:"success"`
	Total   int `json:"total"`
}

PostContainersBatchUpdateAnswerSummary is an object the document declares inline.

type PostContainersBatchUpdateOptions ¶

type PostContainersBatchUpdateOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersBatchUpdateOptions holds the query and header parameters of PostContainersBatchUpdate.

func (PostContainersBatchUpdateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersBatchUpdateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersBatchUpdateRequest ¶

type PostContainersBatchUpdateRequest struct {
	ContainerIds []string `json:"containerIds"`
}

PostContainersBatchUpdateRequest is an object the document declares inline.

type PostContainersBatchUpdateResponse ¶

type PostContainersBatchUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersBatchUpdateAnswer
	*PostContainersBatchUpdateAnswer
}

PostContainersBatchUpdateResponse is the result of PostContainersBatchUpdate.

Answer is the PostContainersBatchUpdateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersBatchUpdateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersBatchUpdateResponse) Record ¶

Record is the PostContainersBatchUpdateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersBatchUpdateStreamOptions ¶

type PostContainersBatchUpdateStreamOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersBatchUpdateStreamOptions holds the query and header parameters of PostContainersBatchUpdateStream.

func (PostContainersBatchUpdateStreamOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersBatchUpdateStreamOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersBatchUpdateStreamRequest ¶

type PostContainersBatchUpdateStreamRequest struct {
	ContainerIds          []string `json:"containerIds"`
	VulnerabilityCriteria string   `json:"vulnerabilityCriteria,omitempty"`
}

PostContainersBatchUpdateStreamRequest is an object the document declares inline.

type PostContainersBatchUpdateStreamResponse ¶

type PostContainersBatchUpdateStreamResponse struct {
	HttpResponse *http.Response
}

PostContainersBatchUpdateStreamResponse is the result of PostContainersBatchUpdateStream.

type PostContainersByIdExecAnswer ¶

type PostContainersByIdExecAnswer struct {
	ConnectionInfo *PostContainersByIdExecAnswerConnectionInfo `json:"connectionInfo,omitempty"`
	ExecId         string                                      `json:"execId"`
}

PostContainersByIdExecAnswer is an object the document declares inline.

type PostContainersByIdExecAnswerConnectionInfo ¶

type PostContainersByIdExecAnswerConnectionInfo struct {
	Host string `json:"host,omitempty"`
	Port int    `json:"port,omitempty"`
	Type string `json:"type"`
}

PostContainersByIdExecAnswerConnectionInfo is an object the document declares inline.

type PostContainersByIdExecOptions ¶

type PostContainersByIdExecOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	EnvId EnvironmentID
}

PostContainersByIdExecOptions holds the query and header parameters of PostContainersByIdExec.

func (PostContainersByIdExecOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdExecOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdExecRequest ¶

type PostContainersByIdExecRequest struct {
	Shell string `json:"shell,omitempty"`
	User  string `json:"user,omitempty"`
}

PostContainersByIdExecRequest is an object the document declares inline.

type PostContainersByIdExecResponse ¶

type PostContainersByIdExecResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdExecAnswer
	*PostContainersByIdExecAnswer
}

PostContainersByIdExecResponse is the result of PostContainersByIdExec.

Answer is the PostContainersByIdExecAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdExecResponse) Answered ¶

func (r PostContainersByIdExecResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdExecResponse) Record ¶

Record is the PostContainersByIdExecAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdExecRunAnswer ¶

type PostContainersByIdExecRunAnswer struct {
	ExitCode int    `json:"exitCode"`
	Stderr   string `json:"stderr"`
	Stdout   string `json:"stdout"`
}

PostContainersByIdExecRunAnswer is an object the document declares inline.

type PostContainersByIdExecRunOptions ¶

type PostContainersByIdExecRunOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	EnvId EnvironmentID
}

PostContainersByIdExecRunOptions holds the query and header parameters of PostContainersByIdExecRun.

func (PostContainersByIdExecRunOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdExecRunOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdExecRunRequest ¶

type PostContainersByIdExecRunRequest struct {
	Cmd        []string `json:"cmd"`
	User       string   `json:"user,omitempty"`
	WorkingDir string   `json:"workingDir,omitempty"`
}

PostContainersByIdExecRunRequest is an object the document declares inline.

type PostContainersByIdExecRunResponse ¶

type PostContainersByIdExecRunResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdExecRunAnswer
	*PostContainersByIdExecRunAnswer
}

PostContainersByIdExecRunResponse is the result of PostContainersByIdExecRun.

Answer is the PostContainersByIdExecRunAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdExecRunResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdExecRunResponse) Record ¶

Record is the PostContainersByIdExecRunAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdFilesChmodAnswer ¶

type PostContainersByIdFilesChmodAnswer struct {
	Mode      string `json:"mode"`
	Path      string `json:"path"`
	Recursive bool   `json:"recursive"`
	Success   bool   `json:"success"`
}

PostContainersByIdFilesChmodAnswer is an object the document declares inline.

type PostContainersByIdFilesChmodOptions ¶

type PostContainersByIdFilesChmodOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdFilesChmodOptions holds the query and header parameters of PostContainersByIdFilesChmod.

func (PostContainersByIdFilesChmodOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdFilesChmodOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdFilesChmodRequest ¶

type PostContainersByIdFilesChmodRequest struct {
	Mode      string `json:"mode"`
	Path      string `json:"path"`
	Recursive *bool  `json:"recursive,omitempty"`
}

PostContainersByIdFilesChmodRequest is an object the document declares inline.

type PostContainersByIdFilesChmodResponse ¶

type PostContainersByIdFilesChmodResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdFilesChmodAnswer
	*PostContainersByIdFilesChmodAnswer
}

PostContainersByIdFilesChmodResponse is the result of PostContainersByIdFilesChmod.

Answer is the PostContainersByIdFilesChmodAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdFilesChmodResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdFilesChmodResponse) Record ¶

Record is the PostContainersByIdFilesChmodAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdFilesChownAnswer ¶

type PostContainersByIdFilesChownAnswer struct {
	Owner     string `json:"owner"`
	Path      string `json:"path"`
	Recursive bool   `json:"recursive"`
	Success   bool   `json:"success"`
}

PostContainersByIdFilesChownAnswer is an object the document declares inline.

type PostContainersByIdFilesChownOptions ¶

type PostContainersByIdFilesChownOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdFilesChownOptions holds the query and header parameters of PostContainersByIdFilesChown.

func (PostContainersByIdFilesChownOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdFilesChownOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdFilesChownRequest ¶

type PostContainersByIdFilesChownRequest struct {
	Owner     string `json:"owner"`
	Path      string `json:"path"`
	Recursive *bool  `json:"recursive,omitempty"`
}

PostContainersByIdFilesChownRequest is an object the document declares inline.

type PostContainersByIdFilesChownResponse ¶

type PostContainersByIdFilesChownResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdFilesChownAnswer
	*PostContainersByIdFilesChownAnswer
}

PostContainersByIdFilesChownResponse is the result of PostContainersByIdFilesChown.

Answer is the PostContainersByIdFilesChownAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdFilesChownResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdFilesChownResponse) Record ¶

Record is the PostContainersByIdFilesChownAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdFilesCreateAnswer ¶

type PostContainersByIdFilesCreateAnswer struct {
	Owner   string `json:"owner,omitempty"`
	Path    string `json:"path"`
	Success bool   `json:"success"`
	Type    string `json:"type"`
}

PostContainersByIdFilesCreateAnswer is an object the document declares inline.

type PostContainersByIdFilesCreateOptions ¶

type PostContainersByIdFilesCreateOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdFilesCreateOptions holds the query and header parameters of PostContainersByIdFilesCreate.

func (PostContainersByIdFilesCreateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdFilesCreateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdFilesCreateRequest ¶

type PostContainersByIdFilesCreateRequest struct {
	Owner string `json:"owner,omitempty"`
	Path  string `json:"path"`
	Type  string `json:"type"`
}

PostContainersByIdFilesCreateRequest is an object the document declares inline.

type PostContainersByIdFilesCreateResponse ¶

type PostContainersByIdFilesCreateResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdFilesCreateAnswer
	*PostContainersByIdFilesCreateAnswer
}

PostContainersByIdFilesCreateResponse is the result of PostContainersByIdFilesCreate.

Answer is the PostContainersByIdFilesCreateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdFilesCreateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdFilesCreateResponse) Record ¶

Record is the PostContainersByIdFilesCreateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdFilesRenameAnswer ¶

type PostContainersByIdFilesRenameAnswer struct {
	NewPath string `json:"newPath"`
	OldPath string `json:"oldPath"`
	Success bool   `json:"success"`
}

PostContainersByIdFilesRenameAnswer is an object the document declares inline.

type PostContainersByIdFilesRenameOptions ¶

type PostContainersByIdFilesRenameOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdFilesRenameOptions holds the query and header parameters of PostContainersByIdFilesRename.

func (PostContainersByIdFilesRenameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdFilesRenameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdFilesRenameRequest ¶

type PostContainersByIdFilesRenameRequest struct {
	NewPath string `json:"newPath"`
	OldPath string `json:"oldPath"`
}

PostContainersByIdFilesRenameRequest is an object the document declares inline.

type PostContainersByIdFilesRenameResponse ¶

type PostContainersByIdFilesRenameResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdFilesRenameAnswer
	*PostContainersByIdFilesRenameAnswer
}

PostContainersByIdFilesRenameResponse is the result of PostContainersByIdFilesRename.

Answer is the PostContainersByIdFilesRenameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdFilesRenameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdFilesRenameResponse) Record ¶

Record is the PostContainersByIdFilesRenameAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdFilesUploadAnswer ¶

type PostContainersByIdFilesUploadAnswer struct {
	Errors   []string `json:"errors,omitzero"`
	Success  bool     `json:"success"`
	Uploaded []string `json:"uploaded"`
}

PostContainersByIdFilesUploadAnswer is an object the document declares inline.

type PostContainersByIdFilesUploadOptions ¶

type PostContainersByIdFilesUploadOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Absolute target directory inside the container
	Path string
}

PostContainersByIdFilesUploadOptions holds the query and header parameters of PostContainersByIdFilesUpload.

func (PostContainersByIdFilesUploadOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdFilesUploadOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdFilesUploadResponse ¶

type PostContainersByIdFilesUploadResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdFilesUploadAnswer
	*PostContainersByIdFilesUploadAnswer
}

PostContainersByIdFilesUploadResponse is the result of PostContainersByIdFilesUpload.

Answer is the PostContainersByIdFilesUploadAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdFilesUploadResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdFilesUploadResponse) Record ¶

Record is the PostContainersByIdFilesUploadAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdPauseAnswer ¶

type PostContainersByIdPauseAnswer struct {
	Success bool `json:"success"`
}

PostContainersByIdPauseAnswer is an object the document declares inline.

type PostContainersByIdPauseOptions ¶

type PostContainersByIdPauseOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdPauseOptions holds the query and header parameters of PostContainersByIdPause.

func (PostContainersByIdPauseOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdPauseOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdPauseResponse ¶

type PostContainersByIdPauseResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdPauseAnswer
	*PostContainersByIdPauseAnswer
}

PostContainersByIdPauseResponse is the result of PostContainersByIdPause.

Answer is the PostContainersByIdPauseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdPauseResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdPauseResponse) Record ¶

Record is the PostContainersByIdPauseAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdRenameAnswer ¶

type PostContainersByIdRenameAnswer struct {
	Success bool `json:"success"`
}

PostContainersByIdRenameAnswer is an object the document declares inline.

type PostContainersByIdRenameOptions ¶

type PostContainersByIdRenameOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdRenameOptions holds the query and header parameters of PostContainersByIdRename.

func (PostContainersByIdRenameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdRenameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdRenameRequest ¶

type PostContainersByIdRenameRequest struct {
	Name string `json:"name"`
}

PostContainersByIdRenameRequest is an object the document declares inline.

type PostContainersByIdRenameResponse ¶

type PostContainersByIdRenameResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdRenameAnswer
	*PostContainersByIdRenameAnswer
}

PostContainersByIdRenameResponse is the result of PostContainersByIdRename.

Answer is the PostContainersByIdRenameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdRenameResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdRenameResponse) Record ¶

Record is the PostContainersByIdRenameAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdRestartAnswer ¶

type PostContainersByIdRestartAnswer struct {
	Success bool `json:"success"`
}

PostContainersByIdRestartAnswer is an object the document declares inline.

type PostContainersByIdRestartOptions ¶

type PostContainersByIdRestartOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdRestartOptions holds the query and header parameters of PostContainersByIdRestart.

func (PostContainersByIdRestartOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdRestartOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdRestartResponse ¶

type PostContainersByIdRestartResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdRestartAnswer
	*PostContainersByIdRestartAnswer
}

PostContainersByIdRestartResponse is the result of PostContainersByIdRestart.

Answer is the PostContainersByIdRestartAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdRestartResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdRestartResponse) Record ¶

Record is the PostContainersByIdRestartAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdStartAnswer ¶

type PostContainersByIdStartAnswer struct {
	Success bool `json:"success"`
}

PostContainersByIdStartAnswer is an object the document declares inline.

type PostContainersByIdStartOptions ¶

type PostContainersByIdStartOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdStartOptions holds the query and header parameters of PostContainersByIdStart.

func (PostContainersByIdStartOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdStartOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdStartResponse ¶

type PostContainersByIdStartResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdStartAnswer
	*PostContainersByIdStartAnswer
}

PostContainersByIdStartResponse is the result of PostContainersByIdStart.

Answer is the PostContainersByIdStartAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdStartResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdStartResponse) Record ¶

Record is the PostContainersByIdStartAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdStopAnswer ¶

type PostContainersByIdStopAnswer struct {
	Success bool `json:"success"`
}

PostContainersByIdStopAnswer is an object the document declares inline.

type PostContainersByIdStopOptions ¶

type PostContainersByIdStopOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdStopOptions holds the query and header parameters of PostContainersByIdStop.

func (PostContainersByIdStopOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdStopOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdStopResponse ¶

type PostContainersByIdStopResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdStopAnswer
	*PostContainersByIdStopAnswer
}

PostContainersByIdStopResponse is the result of PostContainersByIdStop.

Answer is the PostContainersByIdStopAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdStopResponse) Answered ¶

func (r PostContainersByIdStopResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdStopResponse) Record ¶

Record is the PostContainersByIdStopAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdUnpauseAnswer ¶

type PostContainersByIdUnpauseAnswer struct {
	Success bool `json:"success"`
}

PostContainersByIdUnpauseAnswer is an object the document declares inline.

type PostContainersByIdUnpauseOptions ¶

type PostContainersByIdUnpauseOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdUnpauseOptions holds the query and header parameters of PostContainersByIdUnpause.

func (PostContainersByIdUnpauseOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdUnpauseOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdUnpauseResponse ¶

type PostContainersByIdUnpauseResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdUnpauseAnswer
	*PostContainersByIdUnpauseAnswer
}

PostContainersByIdUnpauseResponse is the result of PostContainersByIdUnpause.

Answer is the PostContainersByIdUnpauseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdUnpauseResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdUnpauseResponse) Record ¶

Record is the PostContainersByIdUnpauseAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdUpdateAnswer ¶

type PostContainersByIdUpdateAnswer struct {
	Id      string `json:"id"`
	Success bool   `json:"success"`
}

PostContainersByIdUpdateAnswer is an object the document declares inline.

type PostContainersByIdUpdateOptions ¶

type PostContainersByIdUpdateOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdUpdateOptions holds the query and header parameters of PostContainersByIdUpdate.

func (PostContainersByIdUpdateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdUpdateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdUpdateRequest ¶

type PostContainersByIdUpdateRequest struct {
	AdditionalNetworks []string       `json:"additionalNetworks,omitzero"`
	Cmd                []string       `json:"cmd,omitzero"`
	Entrypoint         []string       `json:"entrypoint,omitzero"`
	Env                []string       `json:"env,omitzero"`
	Image              string         `json:"image,omitempty"`
	Labels             map[string]any `json:"labels,omitzero"`
	Name               string         `json:"name,omitempty"`
	NetworkAliases     []string       `json:"networkAliases,omitzero"`
	NetworkIpv4Address string         `json:"networkIpv4Address,omitempty"`
	NetworkIpv6Address string         `json:"networkIpv6Address,omitempty"`
	NetworkMode        string         `json:"networkMode,omitempty"`
	Ports              map[string]any `json:"ports,omitzero"`
	RepullImage        *bool          `json:"repullImage,omitempty"`
	RestartMaxRetries  int            `json:"restartMaxRetries,omitempty"`
	RestartPolicy      string         `json:"restartPolicy,omitempty"`
	StartAfterUpdate   *bool          `json:"startAfterUpdate,omitempty"`
	VolumeBinds        []string       `json:"volumeBinds,omitzero"`
	Volumes            map[string]any `json:"volumes,omitzero"`
	WorkingDir         string         `json:"workingDir,omitempty"`
}

PostContainersByIdUpdateRequest is an object the document declares inline.

type PostContainersByIdUpdateResponse ¶

type PostContainersByIdUpdateResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdUpdateAnswer
	*PostContainersByIdUpdateAnswer
}

PostContainersByIdUpdateResponse is the result of PostContainersByIdUpdate.

Answer is the PostContainersByIdUpdateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdUpdateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdUpdateResponse) Record ¶

Record is the PostContainersByIdUpdateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersByIdUpdateRuntimeAnswer ¶

type PostContainersByIdUpdateRuntimeAnswer struct {
	Success  bool     `json:"success"`
	Warnings []string `json:"warnings,omitzero"`
}

PostContainersByIdUpdateRuntimeAnswer is an object the document declares inline.

type PostContainersByIdUpdateRuntimeOptions ¶

type PostContainersByIdUpdateRuntimeOptions struct {
	// Environment id (from GET /api/environments)
	Env EnvironmentID
}

PostContainersByIdUpdateRuntimeOptions holds the query and header parameters of PostContainersByIdUpdateRuntime.

func (PostContainersByIdUpdateRuntimeOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersByIdUpdateRuntimeOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersByIdUpdateRuntimeRequest ¶

type PostContainersByIdUpdateRuntimeRequest struct {
	BlkioDeviceReadBps   []string       `json:"BlkioDeviceReadBps,omitzero"`
	BlkioDeviceReadIOps  []string       `json:"BlkioDeviceReadIOps,omitzero"`
	BlkioDeviceWriteBps  []string       `json:"BlkioDeviceWriteBps,omitzero"`
	BlkioDeviceWriteIOps []string       `json:"BlkioDeviceWriteIOps,omitzero"`
	BlkioWeight          int            `json:"BlkioWeight,omitempty"`
	BlkioWeightDevice    []string       `json:"BlkioWeightDevice,omitzero"`
	CpuPeriod            int            `json:"CpuPeriod,omitempty"`
	CpuQuota             int            `json:"CpuQuota,omitempty"`
	CpuRealtimePeriod    int            `json:"CpuRealtimePeriod,omitempty"`
	CpuRealtimeRuntime   int            `json:"CpuRealtimeRuntime,omitempty"`
	CpuShares            int            `json:"CpuShares,omitempty"`
	CpusetCpus           string         `json:"CpusetCpus,omitempty"`
	CpusetMems           string         `json:"CpusetMems,omitempty"`
	KernelMemory         int            `json:"KernelMemory,omitempty"`
	Memory               int            `json:"Memory,omitempty"`
	MemoryReservation    int            `json:"MemoryReservation,omitempty"`
	MemorySwap           int            `json:"MemorySwap,omitempty"`
	MemorySwappiness     int            `json:"MemorySwappiness,omitempty"`
	NanoCpus             int            `json:"NanoCpus,omitempty"`
	PidsLimit            int            `json:"PidsLimit,omitempty"`
	RestartPolicy        map[string]any `json:"RestartPolicy,omitzero"`
}

PostContainersByIdUpdateRuntimeRequest is an object the document declares inline.

type PostContainersByIdUpdateRuntimeResponse ¶

type PostContainersByIdUpdateRuntimeResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersByIdUpdateRuntimeAnswer
	*PostContainersByIdUpdateRuntimeAnswer
}

PostContainersByIdUpdateRuntimeResponse is the result of PostContainersByIdUpdateRuntime.

Answer is the PostContainersByIdUpdateRuntimeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersByIdUpdateRuntimeResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersByIdUpdateRuntimeResponse) Record ¶

Record is the PostContainersByIdUpdateRuntimeAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersCheckUpdatesAnswer ¶

type PostContainersCheckUpdatesAnswer struct {
	Results []PostContainersCheckUpdatesAnswerResults `json:"results,omitzero"`

	// how many containers were checked
	Total        int `json:"total,omitempty"`
	UpdatesFound int `json:"updatesFound,omitempty"`
}

PostContainersCheckUpdatesAnswer is an object the document declares inline.

type PostContainersCheckUpdatesAnswerResults ¶

type PostContainersCheckUpdatesAnswerResults struct {
	ContainerId   string `json:"containerId,omitempty"`
	ContainerName string `json:"containerName,omitempty"`
	CurrentDigest string `json:"currentDigest,omitempty"`

	// why the registry could not be asked, when it could not
	Error string `json:"error,omitempty"`

	// whether the registry has another image under the name than the one the container was made from
	HasUpdate bool   `json:"hasUpdate"`
	ImageName string `json:"imageName,omitempty"`

	// the image was built on the host and no registry has it
	IsLocalImage bool   `json:"isLocalImage"`
	NewDigest    string `json:"newDigest,omitempty"`

	// a newer version tag of the image, when Dockhand is set to look for them and found one
	NewerVersion *PostContainersCheckUpdatesAnswerResultsNewerVersion `json:"newerVersion,omitempty"`

	// dockhand or hawser for a container that is Dockhand itself or one of its agents
	SystemContainer string `json:"systemContainer,omitempty"`

	// the container carries the label dockhand.update=false, and was not looked at
	UpdateDisabled bool `json:"updateDisabled"`
}

PostContainersCheckUpdatesAnswerResults is an object the document declares inline.

type PostContainersCheckUpdatesAnswerResultsNewerVersion ¶

type PostContainersCheckUpdatesAnswerResultsNewerVersion struct {
	// how far a step it is from the tag in use: patch, minor or major
	Bump   string `json:"bump,omitempty"`
	Digest string `json:"digest,omitempty"`

	// the version tags between the one in use and the newest, the newest among them
	Skipped []string `json:"skipped,omitzero"`

	// the newest version tag the registry has for the image
	Tag string `json:"tag,omitempty"`
}

PostContainersCheckUpdatesAnswerResultsNewerVersion is an object the document declares inline.

a newer version tag of the image, when Dockhand is set to look for them and found one

type PostContainersCheckUpdatesOptions ¶

type PostContainersCheckUpdatesOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID
}

PostContainersCheckUpdatesOptions holds the query and header parameters of PostContainersCheckUpdates.

func (PostContainersCheckUpdatesOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostContainersCheckUpdatesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersCheckUpdatesResponse ¶

type PostContainersCheckUpdatesResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersCheckUpdatesAnswer
	*PostContainersCheckUpdatesAnswer
}

PostContainersCheckUpdatesResponse is the result of PostContainersCheckUpdates.

Answer is the PostContainersCheckUpdatesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersCheckUpdatesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersCheckUpdatesResponse) Record ¶

Record is the PostContainersCheckUpdatesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostContainersOptions ¶

type PostContainersOptions struct {
	// Environment id (from GET /api/environments)
	Env EnvironmentID
}

PostContainersOptions holds the query and header parameters of PostContainers.

func (PostContainersOptions) ToHeaders ¶

func (o PostContainersOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostContainersOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostContainersRequest ¶

type PostContainersRequest struct {
	AdditionalNetworks []string       `json:"additionalNetworks,omitzero"`
	Cmd                []string       `json:"cmd,omitzero"`
	Entrypoint         []string       `json:"entrypoint,omitzero"`
	Env                []string       `json:"env,omitzero"`
	Image              string         `json:"image"`
	Labels             map[string]any `json:"labels,omitzero"`
	Name               string         `json:"name"`
	NetworkAliases     []string       `json:"networkAliases,omitzero"`
	NetworkIpv4Address string         `json:"networkIpv4Address,omitempty"`
	NetworkIpv6Address string         `json:"networkIpv6Address,omitempty"`
	NetworkMode        string         `json:"networkMode,omitempty"`
	Ports              map[string]any `json:"ports,omitzero"`
	RestartMaxRetries  int            `json:"restartMaxRetries,omitempty"`
	RestartPolicy      string         `json:"restartPolicy,omitempty"`
	StartAfterCreate   *bool          `json:"startAfterCreate,omitempty"`
	VolumeBinds        []string       `json:"volumeBinds,omitzero"`
	Volumes            map[string]any `json:"volumes,omitzero"`
	WorkingDir         string         `json:"workingDir,omitempty"`
}

PostContainersRequest is an object the document declares inline.

type PostContainersResponse ¶

type PostContainersResponse struct {
	HttpResponse *http.Response
	Answer       *PostContainersAnswer
	*PostContainersAnswer
}

PostContainersResponse is the result of PostContainers.

Answer is the PostContainersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostContainersResponse) Answered ¶

func (r PostContainersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostContainersResponse) Record ¶

Record is the PostContainersAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostDashboardPreferencesAnswer ¶

type PostDashboardPreferencesAnswer struct {
	GridLayout []map[string]any `json:"gridLayout,omitzero"`
	Locked     bool             `json:"locked"`
	ViewMode   string           `json:"viewMode"`
}

PostDashboardPreferencesAnswer is an object the document declares inline.

type PostDashboardPreferencesRequest ¶

type PostDashboardPreferencesRequest struct {
	GridLayout []map[string]any `json:"gridLayout,omitzero"`
	Locked     *bool            `json:"locked,omitempty"`
	ViewMode   string           `json:"viewMode,omitempty"`
}

PostDashboardPreferencesRequest is an object the document declares inline.

type PostDashboardPreferencesResponse ¶

type PostDashboardPreferencesResponse struct {
	HttpResponse *http.Response
	Answer       *PostDashboardPreferencesAnswer
	*PostDashboardPreferencesAnswer
}

PostDashboardPreferencesResponse is the result of PostDashboardPreferences.

Answer is the PostDashboardPreferencesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostDashboardPreferencesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostDashboardPreferencesResponse) Record ¶

Record is the PostDashboardPreferencesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsAnswer ¶

type PostEnvironmentsAnswer struct {
	CollectActivity bool `json:"collectActivity"`
	CollectMetrics  bool `json:"collectMetrics"`

	// how the host is reached: socket, direct, hawser-standard or hawser-edge
	ConnectionType ConnectionType `json:"connectionType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`

	// an agent's token is kept for the host; the token itself is never sent
	HasHawserToken bool `json:"hasHawserToken"`

	// a TLS key is kept for the host; the key itself is never sent
	HasTlsKey       bool   `json:"hasTlsKey"`
	HawserAgentId   string `json:"hawserAgentId,omitempty"`
	HawserAgentName string `json:"hawserAgentName,omitempty"`

	// when an agent that calls in was last heard from; empty for every other connection
	HawserLastSeen   Time   `json:"hawserLastSeen,omitzero"`
	HawserVersion    string `json:"hawserVersion,omitempty"`
	HighlightChanges bool   `json:"highlightChanges"`

	// the host or its agent, for every connection but a socket
	Host string        `json:"host,omitempty"`
	Icon string        `json:"icon,omitempty"`
	Id   EnvironmentID `json:"id,omitempty"`

	// the labels given, as the text of a JSON list: ["a","b"]; every other call answers the list itself
	Labels   string              `json:"labels,omitempty"`
	Name     string              `json:"name,omitempty"`
	Port     int                 `json:"port,omitempty"`
	Protocol EnvironmentProtocol `json:"protocol,omitempty"`
	PublicIp string              `json:"publicIp,omitempty"`

	// the Docker socket, for a socket connection; sent for the others too, and means nothing there
	SocketPath    string `json:"socketPath,omitempty"`
	TlsCa         string `json:"tlsCa,omitempty"`
	TlsCert       string `json:"tlsCert,omitempty"`
	TlsSkipVerify bool   `json:"tlsSkipVerify"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
}

PostEnvironmentsAnswer is an object the document declares inline.

func (PostEnvironmentsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostEnvironmentsAnswer) GetName ¶

func (m PostEnvironmentsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostEnvironmentsByIdDiskWarningAnswer ¶

type PostEnvironmentsByIdDiskWarningAnswer struct {
	Success bool `json:"success"`
}

PostEnvironmentsByIdDiskWarningAnswer is an object the document declares inline.

type PostEnvironmentsByIdDiskWarningRequest ¶

type PostEnvironmentsByIdDiskWarningRequest struct {
	Enabled     *bool           `json:"enabled,omitempty"`
	Mode        DiskWarningMode `json:"mode,omitempty"`
	Threshold   int             `json:"threshold,omitempty"`
	ThresholdGb int             `json:"thresholdGb,omitempty"`
}

PostEnvironmentsByIdDiskWarningRequest is an object the document declares inline.

type PostEnvironmentsByIdDiskWarningResponse ¶

type PostEnvironmentsByIdDiskWarningResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdDiskWarningAnswer
	*PostEnvironmentsByIdDiskWarningAnswer
}

PostEnvironmentsByIdDiskWarningResponse is the result of PostEnvironmentsByIdDiskWarning.

Answer is the PostEnvironmentsByIdDiskWarningAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdDiskWarningResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdDiskWarningResponse) Record ¶

Record is the PostEnvironmentsByIdDiskWarningAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdIconAnswer ¶

type PostEnvironmentsByIdIconAnswer struct {
	Icon    string `json:"icon"`
	Success bool   `json:"success"`
}

PostEnvironmentsByIdIconAnswer is an object the document declares inline.

type PostEnvironmentsByIdIconRequest ¶

type PostEnvironmentsByIdIconRequest struct {
	Image string `json:"image"`
}

PostEnvironmentsByIdIconRequest is an object the document declares inline.

type PostEnvironmentsByIdIconResponse ¶

type PostEnvironmentsByIdIconResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdIconAnswer
	*PostEnvironmentsByIdIconAnswer
}

PostEnvironmentsByIdIconResponse is the result of PostEnvironmentsByIdIcon.

Answer is the PostEnvironmentsByIdIconAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdIconResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdIconResponse) Record ¶

Record is the PostEnvironmentsByIdIconAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdImagePruneAnswer ¶

type PostEnvironmentsByIdImagePruneAnswer struct {
	Settings *PostEnvironmentsByIdImagePruneAnswerSettings `json:"settings"`
	Success  bool                                          `json:"success"`
}

PostEnvironmentsByIdImagePruneAnswer is an object the document declares inline.

type PostEnvironmentsByIdImagePruneAnswerSettings ¶

type PostEnvironmentsByIdImagePruneAnswerSettings struct {
	CronExpression string `json:"cronExpression"`
	Enabled        bool   `json:"enabled"`
	PruneMode      string `json:"pruneMode"`
}

PostEnvironmentsByIdImagePruneAnswerSettings is an object the document declares inline.

type PostEnvironmentsByIdImagePruneRequest ¶

type PostEnvironmentsByIdImagePruneRequest struct {
	CronExpression string `json:"cronExpression,omitempty"`
	Enabled        *bool  `json:"enabled,omitempty"`
	PruneMode      string `json:"pruneMode,omitempty"`
}

PostEnvironmentsByIdImagePruneRequest is an object the document declares inline.

type PostEnvironmentsByIdImagePruneResponse ¶

type PostEnvironmentsByIdImagePruneResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdImagePruneAnswer
	*PostEnvironmentsByIdImagePruneAnswer
}

PostEnvironmentsByIdImagePruneResponse is the result of PostEnvironmentsByIdImagePrune.

Answer is the PostEnvironmentsByIdImagePruneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdImagePruneResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdImagePruneResponse) Record ¶

Record is the PostEnvironmentsByIdImagePruneAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdNotificationsAnswer ¶

type PostEnvironmentsByIdNotificationsAnswer struct {
	// whether the channel itself is switched on: a link that is on sends nothing through a channel that is off
	ChannelEnabled bool           `json:"channelEnabled"`
	ChannelName    string         `json:"channelName,omitempty"`
	ChannelType    string         `json:"channelType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`
	Enabled        bool           `json:"enabled"`
	EnvironmentId  EnvironmentID  `json:"environmentId,omitempty"`
	EventTypes     []string       `json:"eventTypes,omitzero"`
	Id             int            `json:"id"`
	NotificationId NotificationID `json:"notificationId"`
	UpdatedAt      Time           `json:"updatedAt,omitzero"`
}

PostEnvironmentsByIdNotificationsAnswer is an object the document declares inline.

type PostEnvironmentsByIdNotificationsRequest ¶

type PostEnvironmentsByIdNotificationsRequest struct {
	Enabled        *bool          `json:"enabled,omitempty"`
	EventTypes     []string       `json:"eventTypes,omitzero"`
	NotificationId NotificationID `json:"notificationId"`
}

PostEnvironmentsByIdNotificationsRequest is an object the document declares inline.

type PostEnvironmentsByIdNotificationsResponse ¶

type PostEnvironmentsByIdNotificationsResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdNotificationsAnswer
	*PostEnvironmentsByIdNotificationsAnswer
}

PostEnvironmentsByIdNotificationsResponse is the result of PostEnvironmentsByIdNotifications.

Answer is the PostEnvironmentsByIdNotificationsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdNotificationsResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdNotificationsResponse) Record ¶

Record is the PostEnvironmentsByIdNotificationsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdRemoteStacksDirAnswer ¶

type PostEnvironmentsByIdRemoteStacksDirAnswer struct {
	RemoteStacksDir string `json:"remoteStacksDir,omitempty"`
	Success         bool   `json:"success"`
}

PostEnvironmentsByIdRemoteStacksDirAnswer is an object the document declares inline.

type PostEnvironmentsByIdRemoteStacksDirRequest ¶

type PostEnvironmentsByIdRemoteStacksDirRequest struct {
	RemoteStacksDir string `json:"remoteStacksDir,omitempty"`
}

PostEnvironmentsByIdRemoteStacksDirRequest is an object the document declares inline.

type PostEnvironmentsByIdRemoteStacksDirResponse ¶

type PostEnvironmentsByIdRemoteStacksDirResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdRemoteStacksDirAnswer
	*PostEnvironmentsByIdRemoteStacksDirAnswer
}

PostEnvironmentsByIdRemoteStacksDirResponse is the result of PostEnvironmentsByIdRemoteStacksDir.

Answer is the PostEnvironmentsByIdRemoteStacksDirAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdRemoteStacksDirResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdRemoteStacksDirResponse) Record ¶

Record is the PostEnvironmentsByIdRemoteStacksDirAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdTestAnswer ¶

type PostEnvironmentsByIdTestAnswer struct {
	// why the host could not be reached, when success is false
	Error      string                              `json:"error,omitempty"`
	Hawser     map[string]any                      `json:"hawser,omitzero"`
	Info       *PostEnvironmentsByIdTestAnswerInfo `json:"info,omitempty"`
	IsEdgeMode bool                                `json:"isEdgeMode"`
	Success    bool                                `json:"success"`
}

PostEnvironmentsByIdTestAnswer is an object the document declares inline.

type PostEnvironmentsByIdTestAnswerInfo ¶

type PostEnvironmentsByIdTestAnswerInfo struct {
	Containers    int    `json:"containers,omitempty"`
	Engine        string `json:"engine,omitempty"`
	Images        int    `json:"images,omitempty"`
	Name          string `json:"name,omitempty"`
	ServerVersion string `json:"serverVersion,omitempty"`
}

PostEnvironmentsByIdTestAnswerInfo is an object the document declares inline.

type PostEnvironmentsByIdTestResponse ¶

type PostEnvironmentsByIdTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdTestAnswer
	*PostEnvironmentsByIdTestAnswer
}

PostEnvironmentsByIdTestResponse is the result of PostEnvironmentsByIdTest.

Answer is the PostEnvironmentsByIdTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdTestResponse) Record ¶

Record is the PostEnvironmentsByIdTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdTimezoneAnswer ¶

type PostEnvironmentsByIdTimezoneAnswer struct {
	Success  bool   `json:"success"`
	Timezone string `json:"timezone"`
}

PostEnvironmentsByIdTimezoneAnswer is an object the document declares inline.

type PostEnvironmentsByIdTimezoneRequest ¶

type PostEnvironmentsByIdTimezoneRequest struct {
	Timezone string `json:"timezone"`
}

PostEnvironmentsByIdTimezoneRequest is an object the document declares inline.

type PostEnvironmentsByIdTimezoneResponse ¶

type PostEnvironmentsByIdTimezoneResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdTimezoneAnswer
	*PostEnvironmentsByIdTimezoneAnswer
}

PostEnvironmentsByIdTimezoneResponse is the result of PostEnvironmentsByIdTimezone.

Answer is the PostEnvironmentsByIdTimezoneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdTimezoneResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdTimezoneResponse) Record ¶

Record is the PostEnvironmentsByIdTimezoneAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsByIdUpdateCheckAnswer ¶

type PostEnvironmentsByIdUpdateCheckAnswer struct {
	Settings *PostEnvironmentsByIdUpdateCheckAnswerSettings `json:"settings"`
	Success  bool                                           `json:"success"`
}

PostEnvironmentsByIdUpdateCheckAnswer is an object the document declares inline.

type PostEnvironmentsByIdUpdateCheckAnswerSettings ¶

type PostEnvironmentsByIdUpdateCheckAnswerSettings struct {
	AutoUpdate            bool   `json:"autoUpdate"`
	Cron                  string `json:"cron"`
	Enabled               bool   `json:"enabled"`
	VulnerabilityCriteria string `json:"vulnerabilityCriteria"`
}

PostEnvironmentsByIdUpdateCheckAnswerSettings is an object the document declares inline.

type PostEnvironmentsByIdUpdateCheckRequest ¶

type PostEnvironmentsByIdUpdateCheckRequest struct {
	AutoUpdate            *bool  `json:"autoUpdate,omitempty"`
	Cron                  string `json:"cron,omitempty"`
	Enabled               *bool  `json:"enabled,omitempty"`
	VulnerabilityCriteria string `json:"vulnerabilityCriteria,omitempty"`
}

PostEnvironmentsByIdUpdateCheckRequest is an object the document declares inline.

type PostEnvironmentsByIdUpdateCheckResponse ¶

type PostEnvironmentsByIdUpdateCheckResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsByIdUpdateCheckAnswer
	*PostEnvironmentsByIdUpdateCheckAnswer
}

PostEnvironmentsByIdUpdateCheckResponse is the result of PostEnvironmentsByIdUpdateCheck.

Answer is the PostEnvironmentsByIdUpdateCheckAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsByIdUpdateCheckResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsByIdUpdateCheckResponse) Record ¶

Record is the PostEnvironmentsByIdUpdateCheckAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsRequest ¶

type PostEnvironmentsRequest struct {
	CollectActivity  *bool               `json:"collectActivity,omitempty"`
	CollectMetrics   *bool               `json:"collectMetrics,omitempty"`
	ConnectionType   ConnectionType      `json:"connectionType,omitempty"`
	HawserToken      string              `json:"hawserToken,omitempty"`
	HighlightChanges *bool               `json:"highlightChanges,omitempty"`
	Host             string              `json:"host,omitempty"`
	Icon             string              `json:"icon,omitempty"`
	Labels           []string            `json:"labels,omitzero"`
	Name             string              `json:"name"`
	Port             int                 `json:"port,omitempty"`
	Protocol         EnvironmentProtocol `json:"protocol,omitempty"`
	PublicIp         string              `json:"publicIp,omitempty"`
	SocketPath       string              `json:"socketPath,omitempty"`
	TlsCa            string              `json:"tlsCa,omitempty"`
	TlsCert          string              `json:"tlsCert,omitempty"`
	TlsKey           string              `json:"tlsKey,omitempty"`
	TlsSkipVerify    *bool               `json:"tlsSkipVerify,omitempty"`
}

PostEnvironmentsRequest is an object the document declares inline.

type PostEnvironmentsResponse ¶

type PostEnvironmentsResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsAnswer
	*PostEnvironmentsAnswer
}

PostEnvironmentsResponse is the result of PostEnvironments.

Answer is the PostEnvironmentsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsResponse) Answered ¶

func (r PostEnvironmentsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsResponse) Record ¶

Record is the PostEnvironmentsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostEnvironmentsTestAnswer ¶

type PostEnvironmentsTestAnswer struct {
	// why the host could not be reached, when success is false
	Error   string                          `json:"error,omitempty"`
	Hawser  map[string]any                  `json:"hawser,omitzero"`
	Info    *PostEnvironmentsTestAnswerInfo `json:"info,omitempty"`
	Success bool                            `json:"success"`
}

PostEnvironmentsTestAnswer is an object the document declares inline.

type PostEnvironmentsTestAnswerInfo ¶

type PostEnvironmentsTestAnswerInfo struct {
	Containers           int    `json:"containers,omitempty"`
	Images               int    `json:"images,omitempty"`
	MemoryLimitSupported bool   `json:"memoryLimitSupported"`
	Name                 string `json:"name,omitempty"`
	ServerVersion        string `json:"serverVersion,omitempty"`
	ShowMemoryWarning    bool   `json:"showMemoryWarning"`
}

PostEnvironmentsTestAnswerInfo is an object the document declares inline.

type PostEnvironmentsTestRequest ¶

type PostEnvironmentsTestRequest struct {
	ConnectionType ConnectionType      `json:"connectionType"`
	EnvironmentId  EnvironmentID       `json:"environmentId,omitempty"`
	HawserToken    string              `json:"hawserToken,omitempty"`
	Host           string              `json:"host,omitempty"`
	Port           int                 `json:"port,omitempty"`
	Protocol       EnvironmentProtocol `json:"protocol,omitempty"`
	SocketPath     string              `json:"socketPath,omitempty"`
	TlsCa          string              `json:"tlsCa,omitempty"`
	TlsCert        string              `json:"tlsCert,omitempty"`
	TlsKey         string              `json:"tlsKey,omitempty"`
	TlsSkipVerify  *bool               `json:"tlsSkipVerify,omitempty"`
}

PostEnvironmentsTestRequest is an object the document declares inline.

type PostEnvironmentsTestResponse ¶

type PostEnvironmentsTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostEnvironmentsTestAnswer
	*PostEnvironmentsTestAnswer
}

PostEnvironmentsTestResponse is the result of PostEnvironmentsTest.

Answer is the PostEnvironmentsTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostEnvironmentsTestResponse) Answered ¶

func (r PostEnvironmentsTestResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostEnvironmentsTestResponse) Record ¶

Record is the PostEnvironmentsTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitBranchesAnswer ¶

type PostGitBranchesAnswer struct {
	Branches []PostGitBranchesAnswerBranches `json:"branches"`
}

PostGitBranchesAnswer is an object the document declares inline.

type PostGitBranchesAnswerBranches ¶

type PostGitBranchesAnswerBranches struct {
	Name string `json:"name,omitempty"`

	// its newest commit, shortened
	Sha string `json:"sha,omitempty"`
}

PostGitBranchesAnswerBranches is an object the document declares inline.

type PostGitBranchesRequest ¶

type PostGitBranchesRequest struct {
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	RepositoryId GitRepositoryID `json:"repositoryId,omitempty"`
	Url          string          `json:"url,omitempty"`
}

PostGitBranchesRequest is an object the document declares inline.

type PostGitBranchesResponse ¶

type PostGitBranchesResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitBranchesAnswer
	*PostGitBranchesAnswer
}

PostGitBranchesResponse is the result of PostGitBranches.

Answer is the PostGitBranchesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitBranchesResponse) Answered ¶

func (r PostGitBranchesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitBranchesResponse) Record ¶

Record is the PostGitBranchesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitCredentialsAnswer ¶

type PostGitCredentialsAnswer struct {
	AuthType    GitAuthType     `json:"authType"`
	CreatedAt   Time            `json:"createdAt,omitzero"`
	HasPassword bool            `json:"hasPassword"`
	HasSshKey   bool            `json:"hasSshKey"`
	Id          GitCredentialID `json:"id"`
	Name        string          `json:"name"`
	UpdatedAt   Time            `json:"updatedAt,omitzero"`
	Username    string          `json:"username,omitempty"`
}

PostGitCredentialsAnswer is an object the document declares inline.

func (PostGitCredentialsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostGitCredentialsAnswer) GetName ¶

func (m PostGitCredentialsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostGitCredentialsRequest ¶

type PostGitCredentialsRequest struct {
	AuthType      GitAuthType `json:"authType,omitempty"`
	Name          string      `json:"name"`
	Password      string      `json:"password,omitempty"`
	SshPassphrase string      `json:"sshPassphrase,omitempty"`
	SshPrivateKey string      `json:"sshPrivateKey,omitempty"`
	Username      string      `json:"username,omitempty"`
}

PostGitCredentialsRequest is an object the document declares inline.

type PostGitCredentialsResponse ¶

type PostGitCredentialsResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitCredentialsAnswer
	*PostGitCredentialsAnswer
}

PostGitCredentialsResponse is the result of PostGitCredentials.

Answer is the PostGitCredentialsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitCredentialsResponse) Answered ¶

func (r PostGitCredentialsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitCredentialsResponse) Record ¶

Record is the PostGitCredentialsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitPreviewEnvAnswer ¶

type PostGitPreviewEnvAnswer struct {
	// which file each variable came from, by its name: .env for the one beside the compose file, envFile for the one named
	Sources map[string]string `json:"sources"`

	// each variable's value, by its name
	Vars map[string]string `json:"vars"`
}

PostGitPreviewEnvAnswer is an object the document declares inline.

type PostGitPreviewEnvRequest ¶

type PostGitPreviewEnvRequest struct {
	Branch       string          `json:"branch,omitempty"`
	ComposePath  string          `json:"composePath"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	EnvFilePath  string          `json:"envFilePath,omitempty"`
	RepositoryId GitRepositoryID `json:"repositoryId,omitempty"`
	Url          string          `json:"url,omitempty"`
}

PostGitPreviewEnvRequest is an object the document declares inline.

type PostGitPreviewEnvResponse ¶

type PostGitPreviewEnvResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitPreviewEnvAnswer
	*PostGitPreviewEnvAnswer
}

PostGitPreviewEnvResponse is the result of PostGitPreviewEnv.

Answer is the PostGitPreviewEnvAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitPreviewEnvResponse) Answered ¶

func (r PostGitPreviewEnvResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitPreviewEnvResponse) Record ¶

Record is the PostGitPreviewEnvAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitRepositoriesAnswer ¶

type PostGitRepositoriesAnswer struct {
	AutoUpdate         bool   `json:"autoUpdate"`
	AutoUpdateCron     string `json:"autoUpdateCron,omitempty"`
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`
	Branch             string `json:"branch"`

	// left from when a repository was itself deployed: always compose.yaml, and nothing sets it
	ComposePath  string          `json:"composePath,omitempty"`
	CreatedAt    Time            `json:"createdAt,omitzero"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`

	// left from when a repository was itself deployed: always null, and nothing sets it
	EnvironmentId EnvironmentID   `json:"environmentId,omitempty"`
	Id            GitRepositoryID `json:"id"`

	// the commit the repository's own copy is at, shortened
	LastCommit string `json:"lastCommit,omitempty"`

	// when the repository's own copy was last fetched, which no git stack uses
	LastSync  Time   `json:"lastSync,omitzero"`
	Name      string `json:"name"`
	SyncError string `json:"syncError,omitempty"`

	// pending for a copy never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`
	UpdatedAt  Time   `json:"updatedAt,omitzero"`
	Url        string `json:"url"`

	// always false: nothing in the API switches a repository's own webhook on
	WebhookEnabled bool   `json:"webhookEnabled"`
	WebhookSecret  string `json:"webhookSecret,omitempty"`
}

PostGitRepositoriesAnswer is an object the document declares inline.

func (PostGitRepositoriesAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostGitRepositoriesAnswer) GetName ¶

func (m PostGitRepositoriesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostGitRepositoriesByIdDeployAnswer ¶

type PostGitRepositoriesByIdDeployAnswer struct {
	// the compose command that was run
	Command  string `json:"command,omitempty"`
	Error    string `json:"error,omitempty"`
	ExitCode int    `json:"exitCode,omitempty"`
	Output   string `json:"output,omitempty"`
	Success  bool   `json:"success"`
}

PostGitRepositoriesByIdDeployAnswer is an object the document declares inline.

type PostGitRepositoriesByIdDeployResponse ¶

type PostGitRepositoriesByIdDeployResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitRepositoriesByIdDeployAnswer
	*PostGitRepositoriesByIdDeployAnswer
}

PostGitRepositoriesByIdDeployResponse is the result of PostGitRepositoriesByIdDeploy.

Answer is the PostGitRepositoriesByIdDeployAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitRepositoriesByIdDeployResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitRepositoriesByIdDeployResponse) Record ¶

Record is the PostGitRepositoriesByIdDeployAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitRepositoriesByIdSyncAnswer ¶

type PostGitRepositoriesByIdSyncAnswer struct {
	Commit string `json:"commit,omitempty"`

	// the compose file at that commit
	ComposeContent string `json:"composeContent,omitempty"`
	Error          string `json:"error,omitempty"`
	Success        bool   `json:"success"`

	// whether the commit is a new one
	Updated bool `json:"updated"`
}

PostGitRepositoriesByIdSyncAnswer is an object the document declares inline.

type PostGitRepositoriesByIdSyncResponse ¶

type PostGitRepositoriesByIdSyncResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitRepositoriesByIdSyncAnswer
	*PostGitRepositoriesByIdSyncAnswer
}

PostGitRepositoriesByIdSyncResponse is the result of PostGitRepositoriesByIdSync.

Answer is the PostGitRepositoriesByIdSyncAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitRepositoriesByIdSyncResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitRepositoriesByIdSyncResponse) Record ¶

Record is the PostGitRepositoriesByIdSyncAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitRepositoriesByIdTestAnswer ¶

type PostGitRepositoriesByIdTestAnswer struct {
	// the branch that was looked for
	Branch string `json:"branch,omitempty"`
	Error  string `json:"error,omitempty"`

	// the newest commit on it, shortened
	LastCommit string `json:"lastCommit,omitempty"`
	Success    bool   `json:"success"`
}

PostGitRepositoriesByIdTestAnswer is an object the document declares inline.

type PostGitRepositoriesByIdTestResponse ¶

type PostGitRepositoriesByIdTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitRepositoriesByIdTestAnswer
	*PostGitRepositoriesByIdTestAnswer
}

PostGitRepositoriesByIdTestResponse is the result of PostGitRepositoriesByIdTest.

Answer is the PostGitRepositoriesByIdTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitRepositoriesByIdTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitRepositoriesByIdTestResponse) Record ¶

Record is the PostGitRepositoriesByIdTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitRepositoriesRequest ¶

type PostGitRepositoriesRequest struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Name         string          `json:"name"`
	Url          string          `json:"url"`
}

PostGitRepositoriesRequest is an object the document declares inline.

type PostGitRepositoriesResponse ¶

type PostGitRepositoriesResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitRepositoriesAnswer
	*PostGitRepositoriesAnswer
}

PostGitRepositoriesResponse is the result of PostGitRepositories.

Answer is the PostGitRepositoriesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitRepositoriesResponse) Answered ¶

func (r PostGitRepositoriesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitRepositoriesResponse) Record ¶

Record is the PostGitRepositoriesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitRepositoriesTestAnswer ¶

type PostGitRepositoriesTestAnswer struct {
	// the branch that was looked for
	Branch string `json:"branch,omitempty"`
	Error  string `json:"error,omitempty"`

	// the newest commit on it, shortened
	LastCommit string `json:"lastCommit,omitempty"`
	Success    bool   `json:"success"`
}

PostGitRepositoriesTestAnswer is an object the document declares inline.

type PostGitRepositoriesTestRequest ¶

type PostGitRepositoriesTestRequest struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Url          string          `json:"url"`
}

PostGitRepositoriesTestRequest is an object the document declares inline.

type PostGitRepositoriesTestResponse ¶

type PostGitRepositoriesTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitRepositoriesTestAnswer
	*PostGitRepositoriesTestAnswer
}

PostGitRepositoriesTestResponse is the result of PostGitRepositoriesTest.

Answer is the PostGitRepositoriesTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitRepositoriesTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitRepositoriesTestResponse) Record ¶

Record is the PostGitRepositoriesTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksAnswer ¶

type PostGitStacksAnswer struct {
	// whether the stack is fetched and, when something changed, deployed on a schedule
	AutoUpdate     bool   `json:"autoUpdate"`
	AutoUpdateCron string `json:"autoUpdateCron,omitempty"`

	// a word for the schedule, as the web interface offers them: the cron beside it is what the schedule goes by
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`

	// the branch this stack follows; null for the repository's own
	Branch        string `json:"branch,omitempty"`
	BuildOnDeploy bool   `json:"buildOnDeploy"`

	// the compose file's path in the repository
	ComposePath string `json:"composePath,omitempty"`

	// the folder of the repository that is copied beside the compose file; null for the folder the compose file is in
	ContextDir string `json:"contextDir,omitempty"`
	CreatedAt  Time   `json:"createdAt,omitzero"`

	// one more .env file in the repository to fill the compose file in from; null for none
	EnvFilePath string `json:"envFilePath,omitempty"`

	// the environment the stack is deployed on; null for one made with none
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ForceRedeploy bool          `json:"forceRedeploy"`
	Id            GitStackID    `json:"id,omitempty"`

	// the commit last fetched, shortened
	LastCommit   string `json:"lastCommit,omitempty"`
	LastSync     Time   `json:"lastSync,omitzero"`
	NoBuildCache bool   `json:"noBuildCache"`

	// the repository the stack is deployed from
	Repository   *PostGitStacksAnswerRepository `json:"repository,omitempty"`
	RepositoryId GitRepositoryID                `json:"repositoryId,omitempty"`
	RepullImages bool                           `json:"repullImages"`
	StackName    string                         `json:"stackName,omitempty"`
	SyncError    string                         `json:"syncError,omitempty"`

	// pending for a stack never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`

	// the files last copied from the repository, each with a hash, as JSON in a text; absent in the list
	SyncedFiles    string `json:"syncedFiles,omitempty"`
	UpdatedAt      Time   `json:"updatedAt,omitzero"`
	WebhookEnabled bool   `json:"webhookEnabled"`

	// the webhook's secret, sent back whole as it was given; null for none
	WebhookSecret string `json:"webhookSecret,omitempty"`
}

PostGitStacksAnswer is an object the document declares inline.

type PostGitStacksAnswerRepository ¶

type PostGitStacksAnswerRepository struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Id           GitRepositoryID `json:"id,omitempty"`
	Name         string          `json:"name,omitempty"`
	Url          string          `json:"url,omitempty"`
}

PostGitStacksAnswerRepository is an object the document declares inline.

the repository the stack is deployed from

func (PostGitStacksAnswerRepository) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostGitStacksAnswerRepository) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type PostGitStacksByIdDeployAnswer ¶

type PostGitStacksByIdDeployAnswer struct {
	// the compose command that was run
	Command  string `json:"command,omitempty"`
	Error    string `json:"error,omitempty"`
	ExitCode int    `json:"exitCode,omitempty"`

	// what compose printed
	Output  string `json:"output,omitempty"`
	Success bool   `json:"success"`
}

PostGitStacksByIdDeployAnswer is an object the document declares inline.

type PostGitStacksByIdDeployResponse ¶

type PostGitStacksByIdDeployResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksByIdDeployAnswer
	*PostGitStacksByIdDeployAnswer
}

PostGitStacksByIdDeployResponse is the result of PostGitStacksByIdDeploy.

Answer is the PostGitStacksByIdDeployAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksByIdDeployResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksByIdDeployResponse) Record ¶

Record is the PostGitStacksByIdDeployAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksByIdDeployStreamAnswer ¶

type PostGitStacksByIdDeployStreamAnswer struct {
	JobId string `json:"jobId,omitempty"`
}

PostGitStacksByIdDeployStreamAnswer is an object the document declares inline.

type PostGitStacksByIdDeployStreamOptions ¶

type PostGitStacksByIdDeployStreamOptions struct {
	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostGitStacksByIdDeployStreamOptions holds the query and header parameters of PostGitStacksByIdDeployStream.

func (PostGitStacksByIdDeployStreamOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostGitStacksByIdDeployStreamOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostGitStacksByIdDeployStreamResponse ¶

type PostGitStacksByIdDeployStreamResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksByIdDeployStreamAnswer
	*PostGitStacksByIdDeployStreamAnswer
}

PostGitStacksByIdDeployStreamResponse is the result of PostGitStacksByIdDeployStream.

Answer is the PostGitStacksByIdDeployStreamAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksByIdDeployStreamResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksByIdDeployStreamResponse) Record ¶

Record is the PostGitStacksByIdDeployStreamAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksByIdEnvFilesAnswer ¶

type PostGitStacksByIdEnvFilesAnswer struct {
	// each variable's value, by its name
	Vars map[string]string `json:"vars"`
}

PostGitStacksByIdEnvFilesAnswer is an object the document declares inline.

type PostGitStacksByIdEnvFilesRequest ¶

type PostGitStacksByIdEnvFilesRequest struct {
	Path string `json:"path"`
}

PostGitStacksByIdEnvFilesRequest is an object the document declares inline.

type PostGitStacksByIdEnvFilesResponse ¶

type PostGitStacksByIdEnvFilesResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksByIdEnvFilesAnswer
	*PostGitStacksByIdEnvFilesAnswer
}

PostGitStacksByIdEnvFilesResponse is the result of PostGitStacksByIdEnvFiles.

Answer is the PostGitStacksByIdEnvFilesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksByIdEnvFilesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksByIdEnvFilesResponse) Record ¶

Record is the PostGitStacksByIdEnvFilesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksByIdSyncAnswer ¶

type PostGitStacksByIdSyncAnswer struct {
	// the files that differ; one line in brackets for a first fetch
	ChangedFiles []string `json:"changedFiles,omitzero"`

	// the commit fetched, shortened
	Commit string `json:"commit,omitempty"`

	// the compose file at that commit
	ComposeContent string `json:"composeContent,omitempty"`

	// where Dockhand keeps its copy of the repository
	ComposeDir      string `json:"composeDir,omitempty"`
	ComposeFileName string `json:"composeFileName,omitempty"`

	// what the next deploy would take out of the stack's folder
	DeletionPlan  *PostGitStacksByIdSyncAnswerDeletionPlan `json:"deletionPlan,omitempty"`
	Error         string                                   `json:"error,omitempty"`
	NewCommitFull string                                   `json:"newCommitFull,omitempty"`

	// a hash of each file at that commit, by its path
	NewFiles map[string]string `json:"newFiles,omitzero"`

	// what was fetched the time before
	PreviousManifest *PostGitStacksByIdSyncAnswerPreviousManifest `json:"previousManifest,omitempty"`
	Success          bool                                         `json:"success"`

	// whether anything differs from what was last fetched
	Updated bool `json:"updated"`
}

PostGitStacksByIdSyncAnswer is an object the document declares inline.

type PostGitStacksByIdSyncAnswerDeletionPlan ¶

type PostGitStacksByIdSyncAnswerDeletionPlan struct {
	// the files it would leave though they are gone from the repository
	Skipped []map[string]any `json:"skipped,omitzero"`

	// the files the next deploy removes from the stack's folder, for having gone from the repository
	ToDelete []PostGitStacksByIdSyncAnswerDeletionPlanToDelete `json:"toDelete,omitzero"`
}

PostGitStacksByIdSyncAnswerDeletionPlan is an object the document declares inline.

what the next deploy would take out of the stack's folder

type PostGitStacksByIdSyncAnswerDeletionPlanToDelete ¶

type PostGitStacksByIdSyncAnswerDeletionPlanToDelete struct {
	Hash string `json:"hash,omitempty"`
	Path string `json:"path,omitempty"`
}

PostGitStacksByIdSyncAnswerDeletionPlanToDelete is an object the document declares inline.

type PostGitStacksByIdSyncAnswerPreviousManifest ¶

type PostGitStacksByIdSyncAnswerPreviousManifest struct {
	Commit string            `json:"commit,omitempty"`
	Files  map[string]string `json:"files,omitzero"`
}

PostGitStacksByIdSyncAnswerPreviousManifest is an object the document declares inline.

what was fetched the time before

type PostGitStacksByIdSyncResponse ¶

type PostGitStacksByIdSyncResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksByIdSyncAnswer
	*PostGitStacksByIdSyncAnswer
}

PostGitStacksByIdSyncResponse is the result of PostGitStacksByIdSync.

Answer is the PostGitStacksByIdSyncAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksByIdSyncResponse) Answered ¶

func (r PostGitStacksByIdSyncResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksByIdSyncResponse) Record ¶

Record is the PostGitStacksByIdSyncAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksByIdTestAnswer ¶

type PostGitStacksByIdTestAnswer struct {
	// the branch that was looked for
	Branch string `json:"branch,omitempty"`
	Error  string `json:"error,omitempty"`

	// the newest commit on it, shortened
	LastCommit string `json:"lastCommit,omitempty"`
	Success    bool   `json:"success"`
}

PostGitStacksByIdTestAnswer is an object the document declares inline.

type PostGitStacksByIdTestResponse ¶

type PostGitStacksByIdTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksByIdTestAnswer
	*PostGitStacksByIdTestAnswer
}

PostGitStacksByIdTestResponse is the result of PostGitStacksByIdTest.

Answer is the PostGitStacksByIdTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksByIdTestResponse) Answered ¶

func (r PostGitStacksByIdTestResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksByIdTestResponse) Record ¶

Record is the PostGitStacksByIdTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksByIdWebhookAnswer ¶

type PostGitStacksByIdWebhookAnswer struct {
	Error string `json:"error,omitempty"`

	// what compose printed, or that nothing had changed and nothing was deployed
	Output  string `json:"output,omitempty"`
	Skipped bool   `json:"skipped"`
	Success bool   `json:"success"`
}

PostGitStacksByIdWebhookAnswer is an object the document declares inline.

type PostGitStacksByIdWebhookResponse ¶

type PostGitStacksByIdWebhookResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksByIdWebhookAnswer
	*PostGitStacksByIdWebhookAnswer
}

PostGitStacksByIdWebhookResponse is the result of PostGitStacksByIdWebhook.

Answer is the PostGitStacksByIdWebhookAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksByIdWebhookResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksByIdWebhookResponse) Record ¶

Record is the PostGitStacksByIdWebhookAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitStacksRequest ¶

type PostGitStacksRequest struct {
	AutoUpdate     *bool  `json:"autoUpdate,omitempty"`
	AutoUpdateCron string `json:"autoUpdateCron,omitempty"`

	// a word for the schedule: the cron beside it is what the schedule goes by
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`

	// the branch this stack follows instead of the repository's own
	Branch        string `json:"branch,omitempty"`
	BuildOnDeploy *bool  `json:"buildOnDeploy,omitempty"`

	// the compose file's path in the repository; compose.yaml unless said
	ComposePath string `json:"composePath,omitempty"`

	// the folder of the repository that is copied beside the compose file
	ContextDir string `json:"contextDir,omitempty"`

	// with url: the credential to fetch it with
	CredentialId GitCredentialID `json:"credentialId,omitempty"`

	// deploy it at once, and answer the stack with how that went as deployResult
	DeployNow *bool `json:"deployNow,omitempty"`

	// one more .env file in the repository to fill the compose file in from
	EnvFilePath string `json:"envFilePath,omitempty"`

	// the variables Dockhand keeps for the stack, whole: the ones left out are removed, and an empty list removes them all
	EnvVars       []PostGitStacksRequestEnvVars `json:"envVars,omitzero"`
	EnvironmentId EnvironmentID                 `json:"environmentId,omitempty"`
	ForceRedeploy *bool                         `json:"forceRedeploy,omitempty"`
	NoBuildCache  *bool                         `json:"noBuildCache,omitempty"`

	// with url: what to call the repository; the stack's name unless said
	RepoName         string           `json:"repoName,omitempty"`
	RepositoryId     GitRepositoryID  `json:"repositoryId,omitempty"`
	RepullImages     *bool            `json:"repullImages,omitempty"`
	SecretProviderId SecretProviderID `json:"secretProviderId,omitempty"`
	StackName        string           `json:"stackName"`

	// in place of repositoryId: the address of a repository to save with the stack
	Url            string `json:"url,omitempty"`
	WebhookEnabled *bool  `json:"webhookEnabled,omitempty"`
	WebhookSecret  string `json:"webhookSecret,omitempty"`
}

PostGitStacksRequest is an object the document declares inline.

type PostGitStacksRequestEnvVars ¶

type PostGitStacksRequestEnvVars struct {
	IsSecret *bool  `json:"isSecret,omitempty"`
	Key      string `json:"key,omitempty"`

	// the value; *** for a secret keeps the one it has
	Value string `json:"value,omitempty"`
}

PostGitStacksRequestEnvVars is an object the document declares inline.

type PostGitStacksResponse ¶

type PostGitStacksResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitStacksAnswer
	*PostGitStacksAnswer
}

PostGitStacksResponse is the result of PostGitStacks.

Answer is the PostGitStacksAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitStacksResponse) Answered ¶

func (r PostGitStacksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitStacksResponse) Record ¶

Record is the PostGitStacksAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostGitWebhookByIdAnswer ¶

type PostGitWebhookByIdAnswer struct {
	Error   string `json:"error,omitempty"`
	Success bool   `json:"success"`
}

PostGitWebhookByIdAnswer is an object the document declares inline.

type PostGitWebhookByIdRequest ¶

type PostGitWebhookByIdRequest struct {
	Ref string `json:"ref,omitempty"`
}

PostGitWebhookByIdRequest is an object the document declares inline.

Fields auto-detected from the handler's destructuring of the request body - generic string type, no @openapi annotation for this body yet.

type PostGitWebhookByIdResponse ¶

type PostGitWebhookByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PostGitWebhookByIdAnswer
	*PostGitWebhookByIdAnswer
}

PostGitWebhookByIdResponse is the result of PostGitWebhookById.

Answer is the PostGitWebhookByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostGitWebhookByIdResponse) Answered ¶

func (r PostGitWebhookByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostGitWebhookByIdResponse) Record ¶

Record is the PostGitWebhookByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostHawserConnectResponse ¶

type PostHawserConnectResponse struct {
	HttpResponse *http.Response
}

PostHawserConnectResponse is the result of PostHawserConnect.

type PostHawserTokensAnswer ¶

type PostHawserTokensAnswer struct {
	Message string `json:"message"`
	Token   string `json:"token"`
	TokenId int    `json:"tokenId"`
}

PostHawserTokensAnswer is an object the document declares inline.

type PostHawserTokensRequest ¶

type PostHawserTokensRequest struct {
	EnvironmentId EnvironmentID `json:"environmentId"`
	ExpiresAt     Time          `json:"expiresAt,omitzero"`
	Name          string        `json:"name"`
	RawToken      string        `json:"rawToken,omitempty"`
}

PostHawserTokensRequest is an object the document declares inline.

type PostHawserTokensResponse ¶

type PostHawserTokensResponse struct {
	HttpResponse *http.Response
	Answer       *PostHawserTokensAnswer
	*PostHawserTokensAnswer
}

PostHawserTokensResponse is the result of PostHawserTokens.

Answer is the PostHawserTokensAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostHawserTokensResponse) Answered ¶

func (r PostHawserTokensResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostHawserTokensResponse) Record ¶

Record is the PostHawserTokensAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostIconsSelfhstBatchAnswer ¶

type PostIconsSelfhstBatchAnswer struct {
	// each icon that could be had as a data: address, by its reference; one that could not is left out
	Icons map[string]string `json:"icons"`
}

PostIconsSelfhstBatchAnswer is an object the document declares inline.

type PostIconsSelfhstBatchRequest ¶

type PostIconsSelfhstBatchRequest struct {
	Refs []string `json:"refs"`
}

PostIconsSelfhstBatchRequest is an object the document declares inline.

type PostIconsSelfhstBatchResponse ¶

type PostIconsSelfhstBatchResponse struct {
	HttpResponse *http.Response
	Answer       *PostIconsSelfhstBatchAnswer
	*PostIconsSelfhstBatchAnswer
}

PostIconsSelfhstBatchResponse is the result of PostIconsSelfhstBatch.

Answer is the PostIconsSelfhstBatchAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostIconsSelfhstBatchResponse) Answered ¶

func (r PostIconsSelfhstBatchResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostIconsSelfhstBatchResponse) Record ¶

Record is the PostIconsSelfhstBatchAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostImagesByIdTagAnswer ¶

type PostImagesByIdTagAnswer struct {
	Success bool `json:"success"`
}

PostImagesByIdTagAnswer is an object the document declares inline.

type PostImagesByIdTagOptions ¶

type PostImagesByIdTagOptions struct {
	// ID of the environment the image belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostImagesByIdTagOptions holds the query and header parameters of PostImagesByIdTag.

func (PostImagesByIdTagOptions) ToHeaders ¶

func (o PostImagesByIdTagOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostImagesByIdTagOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostImagesByIdTagRequest ¶

type PostImagesByIdTagRequest struct {
	Repo string `json:"repo"`
	Tag  string `json:"tag,omitempty"`
}

PostImagesByIdTagRequest is an object the document declares inline.

type PostImagesByIdTagResponse ¶

type PostImagesByIdTagResponse struct {
	HttpResponse *http.Response
	Answer       *PostImagesByIdTagAnswer
	*PostImagesByIdTagAnswer
}

PostImagesByIdTagResponse is the result of PostImagesByIdTag.

Answer is the PostImagesByIdTagAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostImagesByIdTagResponse) Answered ¶

func (r PostImagesByIdTagResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostImagesByIdTagResponse) Record ¶

Record is the PostImagesByIdTagAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostImagesLoadAnswer ¶

type PostImagesLoadAnswer struct {
	Loaded  string `json:"loaded,omitempty"`
	Success bool   `json:"success"`
}

PostImagesLoadAnswer is an object the document declares inline.

type PostImagesLoadOptions ¶

type PostImagesLoadOptions struct {
	// Target environment id
	Env EnvironmentID
}

PostImagesLoadOptions holds the query and header parameters of PostImagesLoad.

func (PostImagesLoadOptions) ToHeaders ¶

func (o PostImagesLoadOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostImagesLoadOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostImagesLoadResponse ¶

type PostImagesLoadResponse struct {
	HttpResponse *http.Response
	Answer       *PostImagesLoadAnswer
	*PostImagesLoadAnswer
}

PostImagesLoadResponse is the result of PostImagesLoad.

Answer is the PostImagesLoadAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostImagesLoadResponse) Answered ¶

func (r PostImagesLoadResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostImagesLoadResponse) Record ¶

Record is the PostImagesLoadAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostImagesPullAnswer ¶

type PostImagesPullAnswer struct {
	// why not, when the image could not be pulled
	Error string `json:"error,omitempty"`

	// the job the pull runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it goes
	JobId string `json:"jobId,omitempty"`

	// complete, or error; an error comes with HTTP 200 all the same
	Status string `json:"status,omitempty"`
}

PostImagesPullAnswer is an object the document declares inline.

type PostImagesPullOptions ¶

type PostImagesPullOptions struct {
	// ID of the environment to pull into (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostImagesPullOptions holds the query and header parameters of PostImagesPull.

func (PostImagesPullOptions) ToHeaders ¶

func (o PostImagesPullOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostImagesPullOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostImagesPullRequest ¶

type PostImagesPullRequest struct {
	Image         string `json:"image"`
	ScanAfterPull *bool  `json:"scanAfterPull,omitempty"`
}

PostImagesPullRequest is an object the document declares inline.

type PostImagesPullResponse ¶

type PostImagesPullResponse struct {
	HttpResponse *http.Response
	Answer       *PostImagesPullAnswer
	*PostImagesPullAnswer
}

PostImagesPullResponse is the result of PostImagesPull.

Answer is the PostImagesPullAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostImagesPullResponse) Answered ¶

func (r PostImagesPullResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostImagesPullResponse) Record ¶

Record is the PostImagesPullAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostImagesPushAnswer ¶

type PostImagesPushAnswer struct {
	Error   string `json:"error,omitempty"`
	JobId   string `json:"jobId,omitempty"`
	Message string `json:"message,omitempty"`

	// complete, or error with why
	Status string `json:"status,omitempty"`

	// the whole name the image was pushed under, its registry first
	TargetTag string `json:"targetTag,omitempty"`
}

PostImagesPushAnswer is an object the document declares inline.

type PostImagesPushOptions ¶

type PostImagesPushOptions struct {
	// ID of the environment the source image belongs to (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostImagesPushOptions holds the query and header parameters of PostImagesPush.

func (PostImagesPushOptions) ToHeaders ¶

func (o PostImagesPushOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostImagesPushOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostImagesPushRequest ¶

type PostImagesPushRequest struct {
	ImageId    string     `json:"imageId"`
	ImageName  string     `json:"imageName,omitempty"`
	NewTag     string     `json:"newTag,omitempty"`
	RegistryId RegistryID `json:"registryId"`
}

PostImagesPushRequest is an object the document declares inline.

type PostImagesPushResponse ¶

type PostImagesPushResponse struct {
	HttpResponse *http.Response
	Answer       *PostImagesPushAnswer
	*PostImagesPushAnswer
}

PostImagesPushResponse is the result of PostImagesPush.

Answer is the PostImagesPushAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostImagesPushResponse) Answered ¶

func (r PostImagesPushResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostImagesPushResponse) Record ¶

Record is the PostImagesPushAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostImagesScanAnswer ¶

type PostImagesScanAnswer struct {
	// the job the scan runs as, for a caller that did not ask for JSON alone
	JobId    string `json:"jobId,omitempty"`
	Message  string `json:"message,omitempty"`
	Progress int    `json:"progress,omitempty"`

	// the first scanner's scan; absent when the environment scans with nothing
	Result *PostImagesScanAnswerResult `json:"result,omitempty"`

	// one scan for each scanner that ran: none when the environment scans with nothing, which is answered as complete all the same
	Results []PostImagesScanAnswerResults `json:"results,omitzero"`

	// complete, or error with why in message
	Stage ScanStage `json:"stage,omitempty"`
}

PostImagesScanAnswer is an object the document declares inline.

type PostImagesScanAnswerResult ¶

type PostImagesScanAnswerResult struct {
	ImageId   string `json:"imageId,omitempty"`
	ImageName string `json:"imageName,omitempty"`

	// how long the scan took, in milliseconds
	ScanDuration int  `json:"scanDuration,omitempty"`
	ScannedAt    Time `json:"scannedAt,omitzero"`

	// grype or trivy
	Scanner         Scanner                                     `json:"scanner,omitempty"`
	Summary         *PostImagesScanAnswerResultSummary          `json:"summary,omitempty"`
	Vulnerabilities []PostImagesScanAnswerResultVulnerabilities `json:"vulnerabilities,omitzero"`
}

PostImagesScanAnswerResult is an object the document declares inline.

the first scanner's scan; absent when the environment scans with nothing

type PostImagesScanAnswerResultSummary ¶

type PostImagesScanAnswerResultSummary struct {
	Critical   int `json:"critical,omitempty"`
	High       int `json:"high,omitempty"`
	Low        int `json:"low,omitempty"`
	Medium     int `json:"medium,omitempty"`
	Negligible int `json:"negligible,omitempty"`
	Unknown    int `json:"unknown,omitempty"`
}

PostImagesScanAnswerResultSummary is an object the document declares inline.

type PostImagesScanAnswerResultVulnerabilities ¶

type PostImagesScanAnswerResultVulnerabilities struct {
	Description string `json:"description,omitempty"`

	// the version it is put right in; absent when none is known
	FixedVersion string `json:"fixedVersion,omitempty"`

	// the CVE, or the scanner's own id for what it found
	Id      string  `json:"id,omitempty"`
	Link    string  `json:"link,omitempty"`
	Package string  `json:"package,omitempty"`
	Scanner Scanner `json:"scanner,omitempty"`

	// critical, high, medium, low, negligible or unknown
	Severity Severity `json:"severity,omitempty"`

	// the version of the package the image has
	Version string `json:"version,omitempty"`
}

PostImagesScanAnswerResultVulnerabilities is an object the document declares inline.

type PostImagesScanAnswerResults ¶

type PostImagesScanAnswerResults struct {
	ImageId   string `json:"imageId,omitempty"`
	ImageName string `json:"imageName,omitempty"`

	// how long the scan took, in milliseconds
	ScanDuration int  `json:"scanDuration,omitempty"`
	ScannedAt    Time `json:"scannedAt,omitzero"`

	// grype or trivy
	Scanner         Scanner                                      `json:"scanner,omitempty"`
	Summary         *PostImagesScanAnswerResultsSummary          `json:"summary,omitempty"`
	Vulnerabilities []PostImagesScanAnswerResultsVulnerabilities `json:"vulnerabilities,omitzero"`
}

PostImagesScanAnswerResults is an object the document declares inline.

type PostImagesScanAnswerResultsSummary ¶

type PostImagesScanAnswerResultsSummary struct {
	Critical   int `json:"critical,omitempty"`
	High       int `json:"high,omitempty"`
	Low        int `json:"low,omitempty"`
	Medium     int `json:"medium,omitempty"`
	Negligible int `json:"negligible,omitempty"`
	Unknown    int `json:"unknown,omitempty"`
}

PostImagesScanAnswerResultsSummary is an object the document declares inline.

type PostImagesScanAnswerResultsVulnerabilities ¶

type PostImagesScanAnswerResultsVulnerabilities struct {
	Description string `json:"description,omitempty"`

	// the version it is put right in; absent when none is known
	FixedVersion string `json:"fixedVersion,omitempty"`

	// the CVE, or the scanner's own id for what it found
	Id      string  `json:"id,omitempty"`
	Link    string  `json:"link,omitempty"`
	Package string  `json:"package,omitempty"`
	Scanner Scanner `json:"scanner,omitempty"`

	// critical, high, medium, low, negligible or unknown
	Severity Severity `json:"severity,omitempty"`

	// the version of the package the image has
	Version string `json:"version,omitempty"`
}

PostImagesScanAnswerResultsVulnerabilities is an object the document declares inline.

type PostImagesScanOptions ¶

type PostImagesScanOptions struct {
	// ID of the environment the image belongs to (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostImagesScanOptions holds the query and header parameters of PostImagesScan.

func (PostImagesScanOptions) ToHeaders ¶

func (o PostImagesScanOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostImagesScanOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostImagesScanRequest ¶

type PostImagesScanRequest struct {
	ImageName string  `json:"imageName"`
	Scanner   Scanner `json:"scanner,omitempty"`
}

PostImagesScanRequest is an object the document declares inline.

type PostImagesScanResponse ¶

type PostImagesScanResponse struct {
	HttpResponse *http.Response
	Answer       *PostImagesScanAnswer
	*PostImagesScanAnswer
}

PostImagesScanResponse is the result of PostImagesScan.

Answer is the PostImagesScanAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostImagesScanResponse) Answered ¶

func (r PostImagesScanResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostImagesScanResponse) Record ¶

Record is the PostImagesScanAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostLabelsAnswer ¶

type PostLabelsAnswer struct {
	Affected int  `json:"affected,omitempty"`
	Success  bool `json:"success"`
}

PostLabelsAnswer is an object the document declares inline.

type PostLabelsRequest ¶

type PostLabelsRequest struct {
	Action         string          `json:"action"`
	Color          string          `json:"color,omitempty"`
	EnvironmentIds []EnvironmentID `json:"environmentIds,omitzero"`
	Label          string          `json:"label,omitempty"`
	NewLabel       string          `json:"newLabel,omitempty"`
	OldLabel       string          `json:"oldLabel,omitempty"`
}

PostLabelsRequest is an object the document declares inline.

type PostLabelsResponse ¶

type PostLabelsResponse struct {
	HttpResponse *http.Response
	Answer       *PostLabelsAnswer
	*PostLabelsAnswer
}

PostLabelsResponse is the result of PostLabels.

Answer is the PostLabelsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostLabelsResponse) Answered ¶

func (r PostLabelsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostLabelsResponse) Record ¶

Record is the PostLabelsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostLicenseAnswer ¶

type PostLicenseAnswer struct {
	License map[string]any `json:"license,omitzero"`
	Success bool           `json:"success"`
}

PostLicenseAnswer is an object the document declares inline.

type PostLicenseRequest ¶

type PostLicenseRequest struct {
	Key  string `json:"key"`
	Name string `json:"name"`
}

PostLicenseRequest is an object the document declares inline.

type PostLicenseResponse ¶

type PostLicenseResponse struct {
	HttpResponse *http.Response
	Answer       *PostLicenseAnswer
	*PostLicenseAnswer
}

PostLicenseResponse is the result of PostLicense.

Answer is the PostLicenseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostLicenseResponse) Answered ¶

func (r PostLicenseResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostLicenseResponse) Record ¶

Record is the PostLicenseAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNetworksAnswer ¶

type PostNetworksAnswer struct {
	Id      string `json:"id"`
	Success bool   `json:"success"`
}

PostNetworksAnswer is an object the document declares inline.

type PostNetworksByIdConnectAnswer ¶

type PostNetworksByIdConnectAnswer struct {
	Success bool `json:"success"`
}

PostNetworksByIdConnectAnswer is an object the document declares inline.

type PostNetworksByIdConnectOptions ¶

type PostNetworksByIdConnectOptions struct {
	// Environment the network belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostNetworksByIdConnectOptions holds the query and header parameters of PostNetworksByIdConnect.

func (PostNetworksByIdConnectOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostNetworksByIdConnectOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostNetworksByIdConnectRequest ¶

type PostNetworksByIdConnectRequest struct {
	ContainerId   string `json:"containerId"`
	ContainerName string `json:"containerName,omitempty"`
}

PostNetworksByIdConnectRequest is an object the document declares inline.

type PostNetworksByIdConnectResponse ¶

type PostNetworksByIdConnectResponse struct {
	HttpResponse *http.Response
	Answer       *PostNetworksByIdConnectAnswer
	*PostNetworksByIdConnectAnswer
}

PostNetworksByIdConnectResponse is the result of PostNetworksByIdConnect.

Answer is the PostNetworksByIdConnectAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNetworksByIdConnectResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNetworksByIdConnectResponse) Record ¶

Record is the PostNetworksByIdConnectAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNetworksByIdDisconnectAnswer ¶

type PostNetworksByIdDisconnectAnswer struct {
	Success bool `json:"success"`
}

PostNetworksByIdDisconnectAnswer is an object the document declares inline.

type PostNetworksByIdDisconnectOptions ¶

type PostNetworksByIdDisconnectOptions struct {
	// Environment the network belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostNetworksByIdDisconnectOptions holds the query and header parameters of PostNetworksByIdDisconnect.

func (PostNetworksByIdDisconnectOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostNetworksByIdDisconnectOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostNetworksByIdDisconnectRequest ¶

type PostNetworksByIdDisconnectRequest struct {
	ContainerId   string `json:"containerId"`
	ContainerName string `json:"containerName,omitempty"`
	Force         *bool  `json:"force,omitempty"`
}

PostNetworksByIdDisconnectRequest is an object the document declares inline.

type PostNetworksByIdDisconnectResponse ¶

type PostNetworksByIdDisconnectResponse struct {
	HttpResponse *http.Response
	Answer       *PostNetworksByIdDisconnectAnswer
	*PostNetworksByIdDisconnectAnswer
}

PostNetworksByIdDisconnectResponse is the result of PostNetworksByIdDisconnect.

Answer is the PostNetworksByIdDisconnectAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNetworksByIdDisconnectResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNetworksByIdDisconnectResponse) Record ¶

Record is the PostNetworksByIdDisconnectAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNetworksOptions ¶

type PostNetworksOptions struct {
	// Environment ID to create the network in (from GET /api/environments)
	Env EnvironmentID
}

PostNetworksOptions holds the query and header parameters of PostNetworks.

func (PostNetworksOptions) ToHeaders ¶

func (o PostNetworksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostNetworksOptions) ToQuery ¶

func (o PostNetworksOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type PostNetworksRequest ¶

type PostNetworksRequest struct {
	Attachable *bool                    `json:"attachable,omitempty"`
	Driver     string                   `json:"driver,omitempty"`
	EnableIPv6 *bool                    `json:"enableIPv6,omitempty"`
	Ingress    *bool                    `json:"ingress,omitempty"`
	Internal   *bool                    `json:"internal,omitempty"`
	Ipam       *PostNetworksRequestIpam `json:"ipam,omitempty"`
	Labels     map[string]any           `json:"labels,omitzero"`
	Name       string                   `json:"name"`
	Options    map[string]any           `json:"options,omitzero"`
}

PostNetworksRequest is an object the document declares inline.

type PostNetworksRequestIpam ¶

type PostNetworksRequestIpam struct {
	Config  []map[string]any `json:"config,omitzero"`
	Driver  string           `json:"driver,omitempty"`
	Options map[string]any   `json:"options,omitzero"`
}

PostNetworksRequestIpam is an object the document declares inline.

type PostNetworksResponse ¶

type PostNetworksResponse struct {
	HttpResponse *http.Response
	Answer       *PostNetworksAnswer
	*PostNetworksAnswer
}

PostNetworksResponse is the result of PostNetworks.

Answer is the PostNetworksAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNetworksResponse) Answered ¶

func (r PostNetworksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNetworksResponse) Record ¶

Record is the PostNetworksAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNotificationsAnswer ¶

type PostNotificationsAnswer struct {
	Config     *PostNotificationsAnswerConfig `json:"config,omitempty"`
	CreatedAt  Time                           `json:"createdAt,omitzero"`
	Enabled    bool                           `json:"enabled"`
	EventTypes []string                       `json:"eventTypes,omitzero"`
	Id         NotificationID                 `json:"id"`
	Name       string                         `json:"name"`
	Type       NotificationType               `json:"type"`
	UpdatedAt  Time                           `json:"updatedAt,omitzero"`
}

PostNotificationsAnswer is an object the document declares inline.

func (PostNotificationsAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostNotificationsAnswer) GetName ¶

func (m PostNotificationsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostNotificationsAnswerConfig ¶

type PostNotificationsAnswerConfig struct {
	FromEmail string `json:"from_email,omitempty"`
	FromName  string `json:"from_name,omitempty"`
	Host      string `json:"host,omitempty"`

	// for mail: eight asterisks where a password is kept, never the password
	Password string   `json:"password,omitempty"`
	Port     int      `json:"port,omitempty"`
	Secure   bool     `json:"secure"`
	ToEmails []string `json:"to_emails,omitzero"`

	// for a channel that is not mail: the addresses it sends to, in full, with whatever token or login each carries
	Urls     []string `json:"urls,omitzero"`
	Username string   `json:"username,omitempty"`
}

PostNotificationsAnswerConfig is an object the document declares inline.

type PostNotificationsByIdTestAnswer ¶

type PostNotificationsByIdTestAnswer struct {
	Error   string `json:"error,omitempty"`
	Message string `json:"message,omitempty"`
	Success bool   `json:"success"`
}

PostNotificationsByIdTestAnswer is an object the document declares inline.

type PostNotificationsByIdTestResponse ¶

type PostNotificationsByIdTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostNotificationsByIdTestAnswer
	*PostNotificationsByIdTestAnswer
}

PostNotificationsByIdTestResponse is the result of PostNotificationsByIdTest.

Answer is the PostNotificationsByIdTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNotificationsByIdTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNotificationsByIdTestResponse) Record ¶

Record is the PostNotificationsByIdTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNotificationsRequest ¶

type PostNotificationsRequest struct {
	Config     *PostNotificationsRequestConfig `json:"config,omitempty"`
	Enabled    *bool                           `json:"enabled,omitempty"`
	EventTypes []string                        `json:"eventTypes,omitzero"`
	Name       string                          `json:"name"`
	Type       NotificationType                `json:"type"`
}

PostNotificationsRequest is an object the document declares inline.

type PostNotificationsRequestConfig ¶

type PostNotificationsRequestConfig struct {
	FromEmail string   `json:"from_email,omitempty"`
	FromName  string   `json:"from_name,omitempty"`
	Host      string   `json:"host,omitempty"`
	Password  string   `json:"password,omitempty"`
	Port      int      `json:"port,omitempty"`
	Secure    *bool    `json:"secure,omitempty"`
	ToEmails  []string `json:"to_emails,omitzero"`
	Urls      []string `json:"urls,omitzero"`
	Username  string   `json:"username,omitempty"`
}

PostNotificationsRequestConfig is an object the document declares inline.

type PostNotificationsResponse ¶

type PostNotificationsResponse struct {
	HttpResponse *http.Response
	Answer       *PostNotificationsAnswer
	*PostNotificationsAnswer
}

PostNotificationsResponse is the result of PostNotifications.

Answer is the PostNotificationsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNotificationsResponse) Answered ¶

func (r PostNotificationsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNotificationsResponse) Record ¶

Record is the PostNotificationsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNotificationsTestAnswer ¶

type PostNotificationsTestAnswer struct {
	Error   string `json:"error,omitempty"`
	Message string `json:"message,omitempty"`
	Success bool   `json:"success"`
}

PostNotificationsTestAnswer is an object the document declares inline.

type PostNotificationsTestRequest ¶

type PostNotificationsTestRequest struct {
	Config *PostNotificationsTestRequestConfig `json:"config,omitempty"`
	Name   string                              `json:"name,omitempty"`
	Type   NotificationType                    `json:"type"`
}

PostNotificationsTestRequest is an object the document declares inline.

type PostNotificationsTestRequestConfig ¶

type PostNotificationsTestRequestConfig struct {
	FromEmail string   `json:"from_email,omitempty"`
	FromName  string   `json:"from_name,omitempty"`
	Host      string   `json:"host,omitempty"`
	Password  string   `json:"password,omitempty"`
	Port      int      `json:"port,omitempty"`
	Secure    *bool    `json:"secure,omitempty"`
	ToEmails  []string `json:"to_emails,omitzero"`
	Urls      []string `json:"urls,omitzero"`
	Username  string   `json:"username,omitempty"`
}

PostNotificationsTestRequestConfig is an object the document declares inline.

type PostNotificationsTestResponse ¶

type PostNotificationsTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostNotificationsTestAnswer
	*PostNotificationsTestAnswer
}

PostNotificationsTestResponse is the result of PostNotificationsTest.

Answer is the PostNotificationsTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNotificationsTestResponse) Answered ¶

func (r PostNotificationsTestResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNotificationsTestResponse) Record ¶

Record is the PostNotificationsTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostNotificationsTriggerTestAnswer ¶

type PostNotificationsTriggerTestAnswer struct {
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	EventType     string        `json:"eventType"`
	Sent          int           `json:"sent,omitempty"`
	Success       bool          `json:"success"`
}

PostNotificationsTriggerTestAnswer is an object the document declares inline.

type PostNotificationsTriggerTestRequest ¶

type PostNotificationsTriggerTestRequest struct {
	EnvironmentId EnvironmentID                               `json:"environmentId,omitempty"`
	EventType     string                                      `json:"eventType"`
	Payload       *PostNotificationsTriggerTestRequestPayload `json:"payload,omitempty"`
}

PostNotificationsTriggerTestRequest is an object the document declares inline.

type PostNotificationsTriggerTestRequestPayload ¶

type PostNotificationsTriggerTestRequestPayload struct {
	Message string `json:"message"`
	Title   string `json:"title"`
	Type    string `json:"type,omitempty"`
}

PostNotificationsTriggerTestRequestPayload is an object the document declares inline.

type PostNotificationsTriggerTestResponse ¶

type PostNotificationsTriggerTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostNotificationsTriggerTestAnswer
	*PostNotificationsTriggerTestAnswer
}

PostNotificationsTriggerTestResponse is the result of PostNotificationsTriggerTest.

Answer is the PostNotificationsTriggerTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostNotificationsTriggerTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostNotificationsTriggerTestResponse) Record ¶

Record is the PostNotificationsTriggerTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPreferencesEnvironmentOrderAnswer ¶

type PostPreferencesEnvironmentOrderAnswer struct {
	Order []int `json:"order,omitzero"`
}

PostPreferencesEnvironmentOrderAnswer is an object the document declares inline.

type PostPreferencesEnvironmentOrderRequest ¶

type PostPreferencesEnvironmentOrderRequest struct {
	Order []int `json:"order"`
}

PostPreferencesEnvironmentOrderRequest is an object the document declares inline.

type PostPreferencesEnvironmentOrderResponse ¶

type PostPreferencesEnvironmentOrderResponse struct {
	HttpResponse *http.Response
	Answer       *PostPreferencesEnvironmentOrderAnswer
	*PostPreferencesEnvironmentOrderAnswer
}

PostPreferencesEnvironmentOrderResponse is the result of PostPreferencesEnvironmentOrder.

Answer is the PostPreferencesEnvironmentOrderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPreferencesEnvironmentOrderResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPreferencesEnvironmentOrderResponse) Record ¶

Record is the PostPreferencesEnvironmentOrderAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPreferencesFavoriteGroupsAnswer ¶

type PostPreferencesFavoriteGroupsAnswer struct {
	// everything kept for the environment's log view, in order: a container's name as a text, and a group as a record of its name and its containers
	Groups []any `json:"groups,omitzero"`
}

PostPreferencesFavoriteGroupsAnswer is an object the document declares inline.

type PostPreferencesFavoriteGroupsRequest ¶

type PostPreferencesFavoriteGroupsRequest struct {
	Action        string                                       `json:"action"`
	Containers    []string                                     `json:"containers,omitzero"`
	EnvironmentId EnvironmentID                                `json:"environmentId"`
	Groups        []PostPreferencesFavoriteGroupsRequestGroups `json:"groups,omitzero"`
	Name          string                                       `json:"name,omitempty"`
	NewName       string                                       `json:"newName,omitempty"`
}

PostPreferencesFavoriteGroupsRequest is an object the document declares inline.

type PostPreferencesFavoriteGroupsRequestGroups ¶

type PostPreferencesFavoriteGroupsRequestGroups struct {
	Containers []string `json:"containers,omitzero"`
	Name       string   `json:"name"`
}

PostPreferencesFavoriteGroupsRequestGroups is an object the document declares inline.

type PostPreferencesFavoriteGroupsResponse ¶

type PostPreferencesFavoriteGroupsResponse struct {
	HttpResponse *http.Response
	Answer       *PostPreferencesFavoriteGroupsAnswer
	*PostPreferencesFavoriteGroupsAnswer
}

PostPreferencesFavoriteGroupsResponse is the result of PostPreferencesFavoriteGroups.

Answer is the PostPreferencesFavoriteGroupsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPreferencesFavoriteGroupsResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPreferencesFavoriteGroupsResponse) Record ¶

Record is the PostPreferencesFavoriteGroupsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPreferencesFavoritesAnswer ¶

type PostPreferencesFavoritesAnswer struct {
	// everything kept for the environment's log view, in order: a container's name as a text, and a group as a record of its name and its containers
	Favorites []any `json:"favorites,omitzero"`
}

PostPreferencesFavoritesAnswer is an object the document declares inline.

type PostPreferencesFavoritesRequest ¶

type PostPreferencesFavoritesRequest struct {
	Action        string        `json:"action"`
	ContainerName string        `json:"containerName,omitempty"`
	EnvironmentId EnvironmentID `json:"environmentId"`
	Favorites     []string      `json:"favorites,omitzero"`
}

PostPreferencesFavoritesRequest is an object the document declares inline.

type PostPreferencesFavoritesResponse ¶

type PostPreferencesFavoritesResponse struct {
	HttpResponse *http.Response
	Answer       *PostPreferencesFavoritesAnswer
	*PostPreferencesFavoritesAnswer
}

PostPreferencesFavoritesResponse is the result of PostPreferencesFavorites.

Answer is the PostPreferencesFavoritesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPreferencesFavoritesResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPreferencesFavoritesResponse) Record ¶

Record is the PostPreferencesFavoritesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPreferencesGridAnswer ¶

type PostPreferencesGridAnswer struct {
	// the columns saved for each grid, by the grid's id
	Preferences map[string]PostPreferencesGridAnswerPreferences `json:"preferences,omitzero"`
}

PostPreferencesGridAnswer is an object the document declares inline.

type PostPreferencesGridAnswerPreferences ¶

type PostPreferencesGridAnswerPreferences struct {
	Columns []PostPreferencesGridAnswerPreferencesColumns `json:"columns,omitzero"`
}

PostPreferencesGridAnswerPreferences is an object the document declares inline.

type PostPreferencesGridAnswerPreferencesColumns ¶

type PostPreferencesGridAnswerPreferencesColumns struct {
	Id      string `json:"id,omitempty"`
	Visible bool   `json:"visible"`
}

PostPreferencesGridAnswerPreferencesColumns is an object the document declares inline.

type PostPreferencesGridRequest ¶

type PostPreferencesGridRequest struct {
	Columns []PostPreferencesGridRequestColumns `json:"columns,omitzero"`
	GridId  string                              `json:"gridId"`
}

PostPreferencesGridRequest is an object the document declares inline.

type PostPreferencesGridRequestColumns ¶

type PostPreferencesGridRequestColumns struct {
	Id      string `json:"id"`
	Visible bool   `json:"visible"`
}

PostPreferencesGridRequestColumns is an object the document declares inline.

type PostPreferencesGridResponse ¶

type PostPreferencesGridResponse struct {
	HttpResponse *http.Response
	Answer       *PostPreferencesGridAnswer
	*PostPreferencesGridAnswer
}

PostPreferencesGridResponse is the result of PostPreferencesGrid.

Answer is the PostPreferencesGridAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPreferencesGridResponse) Answered ¶

func (r PostPreferencesGridResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPreferencesGridResponse) Record ¶

Record is the PostPreferencesGridAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPreferencesSidebarAnswer ¶

type PostPreferencesSidebarAnswer struct {
	Preferences *PostPreferencesSidebarAnswerPreferences `json:"preferences,omitempty"`
}

PostPreferencesSidebarAnswer is an object the document declares inline.

type PostPreferencesSidebarAnswerPreferences ¶

type PostPreferencesSidebarAnswerPreferences struct {
	Hidden []string `json:"hidden,omitzero"`
	Order  []string `json:"order,omitzero"`
}

PostPreferencesSidebarAnswerPreferences is an object the document declares inline.

type PostPreferencesSidebarRequest ¶

type PostPreferencesSidebarRequest struct {
	Hidden []string `json:"hidden"`
	Order  []string `json:"order"`
}

PostPreferencesSidebarRequest is an object the document declares inline.

type PostPreferencesSidebarResponse ¶

type PostPreferencesSidebarResponse struct {
	HttpResponse *http.Response
	Answer       *PostPreferencesSidebarAnswer
	*PostPreferencesSidebarAnswer
}

PostPreferencesSidebarResponse is the result of PostPreferencesSidebar.

Answer is the PostPreferencesSidebarAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPreferencesSidebarResponse) Answered ¶

func (r PostPreferencesSidebarResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPreferencesSidebarResponse) Record ¶

Record is the PostPreferencesSidebarAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPreferencesTagOrderAnswer ¶

type PostPreferencesTagOrderAnswer struct {
	Order []int `json:"order,omitzero"`
}

PostPreferencesTagOrderAnswer is an object the document declares inline.

type PostPreferencesTagOrderRequest ¶

type PostPreferencesTagOrderRequest struct {
	Order []int `json:"order"`
}

PostPreferencesTagOrderRequest is an object the document declares inline.

type PostPreferencesTagOrderResponse ¶

type PostPreferencesTagOrderResponse struct {
	HttpResponse *http.Response
	Answer       *PostPreferencesTagOrderAnswer
	*PostPreferencesTagOrderAnswer
}

PostPreferencesTagOrderResponse is the result of PostPreferencesTagOrder.

Answer is the PostPreferencesTagOrderAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPreferencesTagOrderResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPreferencesTagOrderResponse) Record ¶

Record is the PostPreferencesTagOrderAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostProfileAvatarAnswer ¶

type PostProfileAvatarAnswer struct {
	Avatar  string `json:"avatar"`
	Success bool   `json:"success"`
}

PostProfileAvatarAnswer is an object the document declares inline.

type PostProfileAvatarRequest ¶

type PostProfileAvatarRequest struct {
	Avatar string `json:"avatar"`
}

PostProfileAvatarRequest is an object the document declares inline.

type PostProfileAvatarResponse ¶

type PostProfileAvatarResponse struct {
	HttpResponse *http.Response
	Answer       *PostProfileAvatarAnswer
	*PostProfileAvatarAnswer
}

PostProfileAvatarResponse is the result of PostProfileAvatar.

Answer is the PostProfileAvatarAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostProfileAvatarResponse) Answered ¶

func (r PostProfileAvatarResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostProfileAvatarResponse) Record ¶

Record is the PostProfileAvatarAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPruneAllAnswer ¶

type PostPruneAllAnswer struct {
	Result  *PostPruneAllAnswerResult `json:"result,omitempty"`
	Success bool                      `json:"success"`
}

PostPruneAllAnswer is an object the document declares inline.

type PostPruneAllAnswerResult ¶

type PostPruneAllAnswerResult struct {
	Containers *PostPruneAllAnswerResultContainers `json:"containers,omitempty"`
	Images     *PostPruneAllAnswerResultImages     `json:"images,omitempty"`
	Networks   *PostPruneAllAnswerResultNetworks   `json:"networks,omitempty"`
	Volumes    *PostPruneAllAnswerResultVolumes    `json:"volumes,omitempty"`
}

PostPruneAllAnswerResult is an object the document declares inline.

type PostPruneAllAnswerResultContainers ¶

type PostPruneAllAnswerResultContainers struct {
	// the whole ids of the containers removed
	ContainersDeleted []string `json:"ContainersDeleted,omitzero"`

	// the bytes got back
	SpaceReclaimed int `json:"SpaceReclaimed,omitempty"`
}

PostPruneAllAnswerResultContainers is an object the document declares inline.

type PostPruneAllAnswerResultImages ¶

type PostPruneAllAnswerResultImages struct {
	// each name taken off and each image and layer deleted, one to an entry
	ImagesDeleted []PostPruneAllAnswerResultImagesImagesDeleted `json:"ImagesDeleted,omitzero"`

	// the bytes got back
	SpaceReclaimed int `json:"SpaceReclaimed,omitempty"`
}

PostPruneAllAnswerResultImages is an object the document declares inline.

type PostPruneAllAnswerResultImagesImagesDeleted ¶

type PostPruneAllAnswerResultImagesImagesDeleted struct {
	// the id of an image or of a layer that was deleted
	Deleted string `json:"Deleted,omitempty"`

	// a name and tag that was taken off an image
	Untagged string `json:"Untagged,omitempty"`
}

PostPruneAllAnswerResultImagesImagesDeleted is an object the document declares inline.

type PostPruneAllAnswerResultNetworks ¶

type PostPruneAllAnswerResultNetworks struct {
	// the names of the networks removed
	NetworksDeleted []string `json:"NetworksDeleted,omitzero"`
}

PostPruneAllAnswerResultNetworks is an object the document declares inline.

type PostPruneAllAnswerResultVolumes ¶

type PostPruneAllAnswerResultVolumes struct {
	// the bytes got back
	SpaceReclaimed int `json:"SpaceReclaimed,omitempty"`

	// the names of the volumes removed
	VolumesDeleted []string `json:"VolumesDeleted,omitzero"`
}

PostPruneAllAnswerResultVolumes is an object the document declares inline.

type PostPruneAllOptions ¶

type PostPruneAllOptions struct {
	// Target environment id; scopes both the prune operation and the permission check (defaults to the local environment) (from GET /api/environments)
	Env EnvironmentID
}

PostPruneAllOptions holds the query and header parameters of PostPruneAll.

func (PostPruneAllOptions) ToHeaders ¶

func (o PostPruneAllOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostPruneAllOptions) ToQuery ¶

func (o PostPruneAllOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type PostPruneAllResponse ¶

type PostPruneAllResponse struct {
	HttpResponse *http.Response
	Answer       *PostPruneAllAnswer
	*PostPruneAllAnswer
}

PostPruneAllResponse is the result of PostPruneAll.

Answer is the PostPruneAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPruneAllResponse) Answered ¶

func (r PostPruneAllResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPruneAllResponse) Record ¶

Record is the PostPruneAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPruneContainersAnswer ¶

type PostPruneContainersAnswer struct {
	Result  *PostPruneContainersAnswerResult `json:"result,omitempty"`
	Success bool                             `json:"success"`
}

PostPruneContainersAnswer is an object the document declares inline.

type PostPruneContainersAnswerResult ¶

type PostPruneContainersAnswerResult struct {
	// the whole ids of the containers removed
	ContainersDeleted []string `json:"ContainersDeleted,omitzero"`

	// the bytes got back
	SpaceReclaimed int `json:"SpaceReclaimed,omitempty"`
}

PostPruneContainersAnswerResult is an object the document declares inline.

type PostPruneContainersOptions ¶

type PostPruneContainersOptions struct {
	// Target environment id; scopes both the prune operation and the permission check (defaults to the local environment) (from GET /api/environments)
	Env EnvironmentID
}

PostPruneContainersOptions holds the query and header parameters of PostPruneContainers.

func (PostPruneContainersOptions) ToHeaders ¶

func (o PostPruneContainersOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostPruneContainersOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostPruneContainersResponse ¶

type PostPruneContainersResponse struct {
	HttpResponse *http.Response
	Answer       *PostPruneContainersAnswer
	*PostPruneContainersAnswer
}

PostPruneContainersResponse is the result of PostPruneContainers.

Answer is the PostPruneContainersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPruneContainersResponse) Answered ¶

func (r PostPruneContainersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPruneContainersResponse) Record ¶

Record is the PostPruneContainersAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPruneImagesAnswer ¶

type PostPruneImagesAnswer struct {
	// why not, when success is false: it comes with HTTP 200 all the same
	Error string `json:"error,omitempty"`

	// the job the pruning runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it goes
	JobId   string                       `json:"jobId,omitempty"`
	Result  *PostPruneImagesAnswerResult `json:"result,omitempty"`
	Success bool                         `json:"success"`
}

PostPruneImagesAnswer is an object the document declares inline.

type PostPruneImagesAnswerResult ¶

type PostPruneImagesAnswerResult struct {
	// each name taken off and each image and layer deleted, one to an entry
	ImagesDeleted []PostPruneImagesAnswerResultImagesDeleted `json:"ImagesDeleted,omitzero"`

	// the bytes got back
	SpaceReclaimed int `json:"SpaceReclaimed,omitempty"`
}

PostPruneImagesAnswerResult is an object the document declares inline.

type PostPruneImagesAnswerResultImagesDeleted ¶

type PostPruneImagesAnswerResultImagesDeleted struct {
	// the id of an image or of a layer that was deleted
	Deleted string `json:"Deleted,omitempty"`

	// a name and tag that was taken off an image
	Untagged string `json:"Untagged,omitempty"`
}

PostPruneImagesAnswerResultImagesDeleted is an object the document declares inline.

type PostPruneImagesOptions ¶

type PostPruneImagesOptions struct {
	// When not "false", prune only dangling images; set "dangling=false" to prune all unused images (defaults to dangling-only)
	Dangling *bool

	// Target environment id; scopes both the prune operation and the permission check (defaults to the local environment) (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostPruneImagesOptions holds the query and header parameters of PostPruneImages.

func (PostPruneImagesOptions) ToHeaders ¶

func (o PostPruneImagesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostPruneImagesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostPruneImagesResponse ¶

type PostPruneImagesResponse struct {
	HttpResponse *http.Response
	Answer       *PostPruneImagesAnswer
	*PostPruneImagesAnswer
}

PostPruneImagesResponse is the result of PostPruneImages.

Answer is the PostPruneImagesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPruneImagesResponse) Answered ¶

func (r PostPruneImagesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPruneImagesResponse) Record ¶

Record is the PostPruneImagesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPruneNetworksAnswer ¶

type PostPruneNetworksAnswer struct {
	Result  *PostPruneNetworksAnswerResult `json:"result,omitempty"`
	Success bool                           `json:"success"`
}

PostPruneNetworksAnswer is an object the document declares inline.

type PostPruneNetworksAnswerResult ¶

type PostPruneNetworksAnswerResult struct {
	// the names of the networks removed
	NetworksDeleted []string `json:"NetworksDeleted,omitzero"`
}

PostPruneNetworksAnswerResult is an object the document declares inline.

type PostPruneNetworksOptions ¶

type PostPruneNetworksOptions struct {
	// Target environment id; scopes both the prune operation and the permission check (defaults to the local environment) (from GET /api/environments)
	Env EnvironmentID
}

PostPruneNetworksOptions holds the query and header parameters of PostPruneNetworks.

func (PostPruneNetworksOptions) ToHeaders ¶

func (o PostPruneNetworksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostPruneNetworksOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostPruneNetworksResponse ¶

type PostPruneNetworksResponse struct {
	HttpResponse *http.Response
	Answer       *PostPruneNetworksAnswer
	*PostPruneNetworksAnswer
}

PostPruneNetworksResponse is the result of PostPruneNetworks.

Answer is the PostPruneNetworksAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPruneNetworksResponse) Answered ¶

func (r PostPruneNetworksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPruneNetworksResponse) Record ¶

Record is the PostPruneNetworksAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostPruneVolumesAnswer ¶

type PostPruneVolumesAnswer struct {
	Result  *PostPruneVolumesAnswerResult `json:"result,omitempty"`
	Success bool                          `json:"success"`
}

PostPruneVolumesAnswer is an object the document declares inline.

type PostPruneVolumesAnswerResult ¶

type PostPruneVolumesAnswerResult struct {
	// the bytes got back
	SpaceReclaimed int `json:"SpaceReclaimed,omitempty"`

	// the names of the volumes removed
	VolumesDeleted []string `json:"VolumesDeleted,omitzero"`
}

PostPruneVolumesAnswerResult is an object the document declares inline.

type PostPruneVolumesOptions ¶

type PostPruneVolumesOptions struct {
	// Target environment id; scopes both the prune operation and the permission check (defaults to the local environment) (from GET /api/environments)
	Env EnvironmentID
}

PostPruneVolumesOptions holds the query and header parameters of PostPruneVolumes.

func (PostPruneVolumesOptions) ToHeaders ¶

func (o PostPruneVolumesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostPruneVolumesOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostPruneVolumesResponse ¶

type PostPruneVolumesResponse struct {
	HttpResponse *http.Response
	Answer       *PostPruneVolumesAnswer
	*PostPruneVolumesAnswer
}

PostPruneVolumesResponse is the result of PostPruneVolumes.

Answer is the PostPruneVolumesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostPruneVolumesResponse) Answered ¶

func (r PostPruneVolumesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostPruneVolumesResponse) Record ¶

Record is the PostPruneVolumesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostRegistriesAnswer ¶

type PostRegistriesAnswer struct {
	CreatedAt      Time       `json:"createdAt,omitzero"`
	HasCredentials bool       `json:"hasCredentials"`
	Id             RegistryID `json:"id"`
	IsDefault      bool       `json:"isDefault"`
	Name           string     `json:"name"`
	UpdatedAt      Time       `json:"updatedAt,omitzero"`
	Url            string     `json:"url"`

	// the user name it signs in to the registry with; null for one with no credentials
	Username string `json:"username,omitempty"`
}

PostRegistriesAnswer is an object the document declares inline.

func (PostRegistriesAnswer) GetId ¶

func (m PostRegistriesAnswer) GetId() RegistryID

GetId is the record's Id, for code that handles records of several types alike.

func (PostRegistriesAnswer) GetName ¶

func (m PostRegistriesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostRegistriesByIdDefaultAnswer ¶

type PostRegistriesByIdDefaultAnswer struct {
	Success bool `json:"success"`
}

PostRegistriesByIdDefaultAnswer is an object the document declares inline.

type PostRegistriesByIdDefaultResponse ¶

type PostRegistriesByIdDefaultResponse struct {
	HttpResponse *http.Response
	Answer       *PostRegistriesByIdDefaultAnswer
	*PostRegistriesByIdDefaultAnswer
}

PostRegistriesByIdDefaultResponse is the result of PostRegistriesByIdDefault.

Answer is the PostRegistriesByIdDefaultAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostRegistriesByIdDefaultResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostRegistriesByIdDefaultResponse) Record ¶

Record is the PostRegistriesByIdDefaultAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostRegistriesRequest ¶

type PostRegistriesRequest struct {
	IsDefault *bool  `json:"isDefault,omitempty"`
	Name      string `json:"name"`
	Password  string `json:"password,omitempty"`
	Url       string `json:"url"`
	Username  string `json:"username,omitempty"`
}

PostRegistriesRequest is an object the document declares inline.

type PostRegistriesResponse ¶

type PostRegistriesResponse struct {
	HttpResponse *http.Response
	Answer       *PostRegistriesAnswer
	*PostRegistriesAnswer
}

PostRegistriesResponse is the result of PostRegistries.

Answer is the PostRegistriesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostRegistriesResponse) Answered ¶

func (r PostRegistriesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostRegistriesResponse) Record ¶

Record is the PostRegistriesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostRegistriesTestAnswer ¶

type PostRegistriesTestAnswer struct {
	Authenticated *bool  `json:"authenticated,omitempty"`
	Connectivity  bool   `json:"connectivity"`
	Message       string `json:"message"`
	Success       bool   `json:"success"`
}

PostRegistriesTestAnswer is an object the document declares inline.

type PostRegistriesTestRequest ¶

type PostRegistriesTestRequest struct {
	Password   string     `json:"password,omitempty"`
	RegistryId RegistryID `json:"registryId,omitempty"`
	Url        string     `json:"url,omitempty"`
	Username   string     `json:"username,omitempty"`
}

PostRegistriesTestRequest is an object the document declares inline.

type PostRegistriesTestResponse ¶

type PostRegistriesTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostRegistriesTestAnswer
	*PostRegistriesTestAnswer
}

PostRegistriesTestResponse is the result of PostRegistriesTest.

Answer is the PostRegistriesTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostRegistriesTestResponse) Answered ¶

func (r PostRegistriesTestResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostRegistriesTestResponse) Record ¶

Record is the PostRegistriesTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostRolesRequest ¶

type PostRolesRequest struct {
	Description    string          `json:"description,omitempty"`
	EnvironmentIds []EnvironmentID `json:"environmentIds,omitzero"`
	Name           string          `json:"name"`
	Permissions    map[string]any  `json:"permissions"`
}

PostRolesRequest is an object the document declares inline.

type PostRolesResponse ¶

type PostRolesResponse struct {
	HttpResponse *http.Response
}

PostRolesResponse is the result of PostRoles.

type PostSchedulesByTypeByIdRunAnswer ¶

type PostSchedulesByTypeByIdRunAnswer struct {
	Message string `json:"message"`
	Success bool   `json:"success"`
}

PostSchedulesByTypeByIdRunAnswer is an object the document declares inline.

type PostSchedulesByTypeByIdRunResponse ¶

type PostSchedulesByTypeByIdRunResponse struct {
	HttpResponse *http.Response
	Answer       *PostSchedulesByTypeByIdRunAnswer
	*PostSchedulesByTypeByIdRunAnswer
}

PostSchedulesByTypeByIdRunResponse is the result of PostSchedulesByTypeByIdRun.

Answer is the PostSchedulesByTypeByIdRunAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSchedulesByTypeByIdRunResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSchedulesByTypeByIdRunResponse) Record ¶

Record is the PostSchedulesByTypeByIdRunAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSchedulesByTypeByIdToggleAnswer ¶

type PostSchedulesByTypeByIdToggleAnswer struct {
	Enabled bool `json:"enabled"`
	Success bool `json:"success"`
}

PostSchedulesByTypeByIdToggleAnswer is an object the document declares inline.

type PostSchedulesByTypeByIdToggleResponse ¶

type PostSchedulesByTypeByIdToggleResponse struct {
	HttpResponse *http.Response
	Answer       *PostSchedulesByTypeByIdToggleAnswer
	*PostSchedulesByTypeByIdToggleAnswer
}

PostSchedulesByTypeByIdToggleResponse is the result of PostSchedulesByTypeByIdToggle.

Answer is the PostSchedulesByTypeByIdToggleAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSchedulesByTypeByIdToggleResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSchedulesByTypeByIdToggleResponse) Record ¶

Record is the PostSchedulesByTypeByIdToggleAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSchedulesSystemByIdToggleAnswer ¶

type PostSchedulesSystemByIdToggleAnswer struct {
	Enabled bool `json:"enabled"`
	Success bool `json:"success"`
}

PostSchedulesSystemByIdToggleAnswer is an object the document declares inline.

type PostSchedulesSystemByIdToggleResponse ¶

type PostSchedulesSystemByIdToggleResponse struct {
	HttpResponse *http.Response
	Answer       *PostSchedulesSystemByIdToggleAnswer
	*PostSchedulesSystemByIdToggleAnswer
}

PostSchedulesSystemByIdToggleResponse is the result of PostSchedulesSystemByIdToggle.

Answer is the PostSchedulesSystemByIdToggleAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSchedulesSystemByIdToggleResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSchedulesSystemByIdToggleResponse) Record ¶

Record is the PostSchedulesSystemByIdToggleAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSecretProvidersAnswer ¶

type PostSecretProvidersAnswer struct {
	// when it was made, as the server writes it
	CreatedAt Time               `json:"createdAt,omitzero"`
	Id        SecretProviderID   `json:"id"`
	Name      string             `json:"name"`
	Type      SecretProviderType `json:"type"`

	// when it was last changed, which is written another way once it has been
	UpdatedAt Time `json:"updatedAt,omitzero"`
}

PostSecretProvidersAnswer is an object the document declares inline.

func (PostSecretProvidersAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostSecretProvidersAnswer) GetName ¶

func (m PostSecretProvidersAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostSecretProvidersByIdProbeAnswer ¶

type PostSecretProvidersByIdProbeAnswer struct {
	BulkKeys     []string `json:"bulkKeys,omitzero"`
	Error        string   `json:"error,omitempty"`
	Ok           bool     `json:"ok"`
	ResolvedRefs []string `json:"resolvedRefs,omitzero"`
}

PostSecretProvidersByIdProbeAnswer is an object the document declares inline.

type PostSecretProvidersByIdProbeRequest ¶

type PostSecretProvidersByIdProbeRequest struct {
	Refs     []string `json:"refs,omitzero"`
	Selector string   `json:"selector,omitempty"`
}

PostSecretProvidersByIdProbeRequest is an object the document declares inline.

type PostSecretProvidersByIdProbeResponse ¶

type PostSecretProvidersByIdProbeResponse struct {
	HttpResponse *http.Response
	Answer       *PostSecretProvidersByIdProbeAnswer
	*PostSecretProvidersByIdProbeAnswer
}

PostSecretProvidersByIdProbeResponse is the result of PostSecretProvidersByIdProbe.

Answer is the PostSecretProvidersByIdProbeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSecretProvidersByIdProbeResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSecretProvidersByIdProbeResponse) Record ¶

Record is the PostSecretProvidersByIdProbeAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSecretProvidersByIdTestAnswer ¶

type PostSecretProvidersByIdTestAnswer struct {
	Error string `json:"error,omitempty"`
	Ok    bool   `json:"ok"`
}

PostSecretProvidersByIdTestAnswer is an object the document declares inline.

type PostSecretProvidersByIdTestRequest ¶

type PostSecretProvidersByIdTestRequest struct {
	Config map[string]any `json:"config,omitzero"`
}

PostSecretProvidersByIdTestRequest is an object the document declares inline.

type PostSecretProvidersByIdTestResponse ¶

type PostSecretProvidersByIdTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostSecretProvidersByIdTestAnswer
	*PostSecretProvidersByIdTestAnswer
}

PostSecretProvidersByIdTestResponse is the result of PostSecretProvidersByIdTest.

Answer is the PostSecretProvidersByIdTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSecretProvidersByIdTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSecretProvidersByIdTestResponse) Record ¶

Record is the PostSecretProvidersByIdTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSecretProvidersRequest ¶

type PostSecretProvidersRequest struct {
	Config map[string]any     `json:"config"`
	Name   string             `json:"name"`
	Type   SecretProviderType `json:"type"`
}

PostSecretProvidersRequest is an object the document declares inline.

type PostSecretProvidersResponse ¶

type PostSecretProvidersResponse struct {
	HttpResponse *http.Response
	Answer       *PostSecretProvidersAnswer
	*PostSecretProvidersAnswer
}

PostSecretProvidersResponse is the result of PostSecretProviders.

Answer is the PostSecretProvidersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSecretProvidersResponse) Answered ¶

func (r PostSecretProvidersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSecretProvidersResponse) Record ¶

Record is the PostSecretProvidersAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSecretProvidersTestAnswer ¶

type PostSecretProvidersTestAnswer struct {
	Error string `json:"error,omitempty"`
	Ok    bool   `json:"ok"`
}

PostSecretProvidersTestAnswer is an object the document declares inline.

type PostSecretProvidersTestRequest ¶

type PostSecretProvidersTestRequest struct {
	Config map[string]any     `json:"config"`
	Type   SecretProviderType `json:"type"`
}

PostSecretProvidersTestRequest is an object the document declares inline.

type PostSecretProvidersTestResponse ¶

type PostSecretProvidersTestResponse struct {
	HttpResponse *http.Response
	Answer       *PostSecretProvidersTestAnswer
	*PostSecretProvidersTestAnswer
}

PostSecretProvidersTestResponse is the result of PostSecretProvidersTest.

Answer is the PostSecretProvidersTestAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSecretProvidersTestResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSecretProvidersTestResponse) Record ¶

Record is the PostSecretProvidersTestAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSelfUpdateRequest ¶

type PostSelfUpdateRequest struct {
	NewImage string `json:"newImage"`
}

PostSelfUpdateRequest is an object the document declares inline.

type PostSelfUpdateResponse ¶

type PostSelfUpdateResponse struct {
	HttpResponse *http.Response
}

PostSelfUpdateResponse is the result of PostSelfUpdate.

type PostSettingsGeneralAnswer ¶

type PostSettingsGeneralAnswer struct {
	ActionIconSize            string   `json:"actionIconSize,omitempty"`
	AnimateIcons              bool     `json:"animateIcons"`
	ColoredActionButtons      bool     `json:"coloredActionButtons"`
	CompactPorts              bool     `json:"compactPorts"`
	ConfirmDestructive        bool     `json:"confirmDestructive"`
	DarkTheme                 string   `json:"darkTheme,omitempty"`
	DateFormat                string   `json:"dateFormat,omitempty"`
	DefaultBackupImage        string   `json:"defaultBackupImage,omitempty"`
	DefaultComposeTemplate    string   `json:"defaultComposeTemplate,omitempty"`
	DefaultGrypeArgs          string   `json:"defaultGrypeArgs,omitempty"`
	DefaultGrypeImage         string   `json:"defaultGrypeImage,omitempty"`
	DefaultScannerDns         []string `json:"defaultScannerDns,omitzero"`
	DefaultScannerNetworkMode string   `json:"defaultScannerNetworkMode,omitempty"`
	DefaultTimezone           string   `json:"defaultTimezone,omitempty"`
	DefaultTrivyArgs          string   `json:"defaultTrivyArgs,omitempty"`
	DefaultTrivyImage         string   `json:"defaultTrivyImage,omitempty"`
	DeployLogReconcileCron    string   `json:"deployLogReconcileCron,omitempty"`
	DeployLogReconcileEnabled bool     `json:"deployLogReconcileEnabled"`
	DownloadFormat            string   `json:"downloadFormat,omitempty"`
	EditorFont                string   `json:"editorFont,omitempty"`
	EditorIndentGuides        bool     `json:"editorIndentGuides"`
	EditorTheme               string   `json:"editorTheme,omitempty"`
	EventCleanupCron          string   `json:"eventCleanupCron,omitempty"`
	EventCleanupEnabled       bool     `json:"eventCleanupEnabled"`
	EventCollectionMode       string   `json:"eventCollectionMode,omitempty"`
	EventPollInterval         int      `json:"eventPollInterval,omitempty"`
	EventRetentionDays        int      `json:"eventRetentionDays,omitempty"`

	// paths, as the list the server takes and answers
	ExternalStackPaths        []string `json:"externalStackPaths,omitzero"`
	Font                      string   `json:"font,omitempty"`
	FontSize                  string   `json:"fontSize,omitempty"`
	FormatLogTimestamps       bool     `json:"formatLogTimestamps"`
	GridFontSize              string   `json:"gridFontSize,omitempty"`
	HighlightUpdates          bool     `json:"highlightUpdates"`
	HonorProxyLabels          bool     `json:"honorProxyLabels"`
	LabelFilterMode           string   `json:"labelFilterMode,omitempty"`
	LightTheme                string   `json:"lightTheme,omitempty"`
	LogBufferSizeKb           int      `json:"logBufferSizeKb,omitempty"`
	LogMaxLines               int      `json:"logMaxLines,omitempty"`
	MetricsCollectionInterval int      `json:"metricsCollectionInterval,omitempty"`
	PrimaryStackLocation      string   `json:"primaryStackLocation,omitempty"`
	ProtectScannerImages      bool     `json:"protectScannerImages"`
	ScanRetentionCron         string   `json:"scanRetentionCron,omitempty"`
	ScanRetentionEnabled      bool     `json:"scanRetentionEnabled"`
	ScanRetentionGraceDays    int      `json:"scanRetentionGraceDays,omitempty"`
	ScanRetentionKeep         int      `json:"scanRetentionKeep,omitempty"`
	ScannerCleanupCron        string   `json:"scannerCleanupCron,omitempty"`
	ScannerCleanupEnabled     bool     `json:"scannerCleanupEnabled"`
	ScheduleCleanupCron       string   `json:"scheduleCleanupCron,omitempty"`
	ScheduleCleanupEnabled    bool     `json:"scheduleCleanupEnabled"`
	ScheduleRetentionDays     int      `json:"scheduleRetentionDays,omitempty"`
	ShowExposedPorts          bool     `json:"showExposedPorts"`
	ShowGitCommitHash         bool     `json:"showGitCommitHash"`
	ShowImageChangelogLinks   bool     `json:"showImageChangelogLinks"`
	ShowStoppedContainers     bool     `json:"showStoppedContainers"`
	ShowWhatsNew              bool     `json:"showWhatsNew"`
	StackLogOperations        []string `json:"stackLogOperations,omitzero"`
	TerminalFont              string   `json:"terminalFont,omitempty"`
	TimeFormat                string   `json:"timeFormat,omitempty"`
	UseSelfhstIcons           bool     `json:"useSelfhstIcons"`
}

PostSettingsGeneralAnswer is an object the document declares inline.

type PostSettingsGeneralRequest ¶

type PostSettingsGeneralRequest struct {
	ActionIconSize            string   `json:"actionIconSize,omitempty"`
	AnimateIcons              *bool    `json:"animateIcons,omitempty"`
	ColoredActionButtons      *bool    `json:"coloredActionButtons,omitempty"`
	CompactPorts              *bool    `json:"compactPorts,omitempty"`
	ConfirmDestructive        *bool    `json:"confirmDestructive,omitempty"`
	DarkTheme                 string   `json:"darkTheme,omitempty"`
	DateFormat                string   `json:"dateFormat,omitempty"`
	DefaultBackupImage        string   `json:"defaultBackupImage,omitempty"`
	DefaultComposeTemplate    string   `json:"defaultComposeTemplate,omitempty"`
	DefaultGrypeArgs          string   `json:"defaultGrypeArgs,omitempty"`
	DefaultGrypeImage         string   `json:"defaultGrypeImage,omitempty"`
	DefaultScannerDns         []string `json:"defaultScannerDns,omitzero"`
	DefaultScannerNetworkMode string   `json:"defaultScannerNetworkMode,omitempty"`
	DefaultTimezone           string   `json:"defaultTimezone,omitempty"`
	DefaultTrivyArgs          string   `json:"defaultTrivyArgs,omitempty"`
	DefaultTrivyImage         string   `json:"defaultTrivyImage,omitempty"`
	DeployLogReconcileCron    string   `json:"deployLogReconcileCron,omitempty"`
	DeployLogReconcileEnabled *bool    `json:"deployLogReconcileEnabled,omitempty"`
	DownloadFormat            string   `json:"downloadFormat,omitempty"`
	EditorFont                string   `json:"editorFont,omitempty"`
	EditorIndentGuides        *bool    `json:"editorIndentGuides,omitempty"`
	EditorTheme               string   `json:"editorTheme,omitempty"`
	EventCleanupCron          string   `json:"eventCleanupCron,omitempty"`
	EventCleanupEnabled       *bool    `json:"eventCleanupEnabled,omitempty"`
	EventCollectionMode       string   `json:"eventCollectionMode,omitempty"`
	EventPollInterval         int      `json:"eventPollInterval,omitempty"`
	EventRetentionDays        int      `json:"eventRetentionDays,omitempty"`

	// paths, as the list the server takes and answers
	ExternalStackPaths        []string `json:"externalStackPaths,omitzero"`
	Font                      string   `json:"font,omitempty"`
	FontSize                  string   `json:"fontSize,omitempty"`
	FormatLogTimestamps       *bool    `json:"formatLogTimestamps,omitempty"`
	GridFontSize              string   `json:"gridFontSize,omitempty"`
	HighlightUpdates          *bool    `json:"highlightUpdates,omitempty"`
	HonorProxyLabels          *bool    `json:"honorProxyLabels,omitempty"`
	LabelFilterMode           string   `json:"labelFilterMode,omitempty"`
	LightTheme                string   `json:"lightTheme,omitempty"`
	LogBufferSizeKb           int      `json:"logBufferSizeKb,omitempty"`
	LogMaxLines               int      `json:"logMaxLines,omitempty"`
	MetricsCollectionInterval int      `json:"metricsCollectionInterval,omitempty"`
	PrimaryStackLocation      string   `json:"primaryStackLocation,omitempty"`
	ProtectScannerImages      *bool    `json:"protectScannerImages,omitempty"`
	ScanRetentionCron         string   `json:"scanRetentionCron,omitempty"`
	ScanRetentionEnabled      *bool    `json:"scanRetentionEnabled,omitempty"`
	ScanRetentionGraceDays    int      `json:"scanRetentionGraceDays,omitempty"`
	ScanRetentionKeep         int      `json:"scanRetentionKeep,omitempty"`
	ScannerCleanupCron        string   `json:"scannerCleanupCron,omitempty"`
	ScannerCleanupEnabled     *bool    `json:"scannerCleanupEnabled,omitempty"`
	ScheduleCleanupCron       string   `json:"scheduleCleanupCron,omitempty"`
	ScheduleCleanupEnabled    *bool    `json:"scheduleCleanupEnabled,omitempty"`
	ScheduleRetentionDays     int      `json:"scheduleRetentionDays,omitempty"`
	ShowExposedPorts          *bool    `json:"showExposedPorts,omitempty"`
	ShowGitCommitHash         *bool    `json:"showGitCommitHash,omitempty"`
	ShowImageChangelogLinks   *bool    `json:"showImageChangelogLinks,omitempty"`
	ShowStoppedContainers     *bool    `json:"showStoppedContainers,omitempty"`
	ShowWhatsNew              *bool    `json:"showWhatsNew,omitempty"`
	StackLogOperations        []string `json:"stackLogOperations,omitzero"`
	TerminalFont              string   `json:"terminalFont,omitempty"`
	TimeFormat                string   `json:"timeFormat,omitempty"`
	UseSelfhstIcons           *bool    `json:"useSelfhstIcons,omitempty"`
}

PostSettingsGeneralRequest is an object the document declares inline.

type PostSettingsGeneralResponse ¶

type PostSettingsGeneralResponse struct {
	HttpResponse *http.Response
	Answer       *PostSettingsGeneralAnswer
	*PostSettingsGeneralAnswer
}

PostSettingsGeneralResponse is the result of PostSettingsGeneral.

Answer is the PostSettingsGeneralAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSettingsGeneralResponse) Answered ¶

func (r PostSettingsGeneralResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSettingsGeneralResponse) Record ¶

Record is the PostSettingsGeneralAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSettingsScannerAnswer ¶

type PostSettingsScannerAnswer struct {
	Settings *PostSettingsScannerAnswerSettings `json:"settings,omitempty"`
	Success  bool                               `json:"success"`
}

PostSettingsScannerAnswer is an object the document declares inline.

type PostSettingsScannerAnswerSettings ¶

type PostSettingsScannerAnswerSettings struct {
	GrypeArgs  string  `json:"grypeArgs"`
	GrypeImage string  `json:"grypeImage,omitempty"`
	Scanner    Scanner `json:"scanner"`
	TrivyArgs  string  `json:"trivyArgs"`
	TrivyImage string  `json:"trivyImage,omitempty"`
}

PostSettingsScannerAnswerSettings is an object the document declares inline.

type PostSettingsScannerRequest ¶

type PostSettingsScannerRequest struct {
	EnvId      EnvironmentID `json:"envId,omitempty"`
	GrypeArgs  string        `json:"grypeArgs,omitempty"`
	GrypeImage string        `json:"grypeImage,omitempty"`
	Scanner    Scanner       `json:"scanner,omitempty"`
	TrivyArgs  string        `json:"trivyArgs,omitempty"`
	TrivyImage string        `json:"trivyImage,omitempty"`
}

PostSettingsScannerRequest is an object the document declares inline.

type PostSettingsScannerResponse ¶

type PostSettingsScannerResponse struct {
	HttpResponse *http.Response
	Answer       *PostSettingsScannerAnswer
	*PostSettingsScannerAnswer
}

PostSettingsScannerResponse is the result of PostSettingsScanner.

Answer is the PostSettingsScannerAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSettingsScannerResponse) Answered ¶

func (r PostSettingsScannerResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSettingsScannerResponse) Record ¶

Record is the PostSettingsScannerAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSettingsSemverAnswer ¶

type PostSettingsSemverAnswer struct {
	Success bool `json:"success"`
}

PostSettingsSemverAnswer is an object the document declares inline.

type PostSettingsSemverRequest ¶

type PostSettingsSemverRequest struct {
	Enabled           *bool  `json:"enabled,omitempty"`
	IncludePrerelease *bool  `json:"includePrerelease,omitempty"`
	MatchFlavor       *bool  `json:"matchFlavor,omitempty"`
	MaxBump           string `json:"maxBump,omitempty"`
}

PostSettingsSemverRequest is an object the document declares inline.

type PostSettingsSemverResponse ¶

type PostSettingsSemverResponse struct {
	HttpResponse *http.Response
	Answer       *PostSettingsSemverAnswer
	*PostSettingsSemverAnswer
}

PostSettingsSemverResponse is the result of PostSettingsSemver.

Answer is the PostSettingsSemverAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSettingsSemverResponse) Answered ¶

func (r PostSettingsSemverResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSettingsSemverResponse) Record ¶

Record is the PostSettingsSemverAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksAdoptAnswer ¶

type PostStacksAdoptAnswer struct {
	Adopted []string                      `json:"adopted"`
	Failed  []PostStacksAdoptAnswerFailed `json:"failed"`
}

PostStacksAdoptAnswer is an object the document declares inline.

type PostStacksAdoptAnswerFailed ¶

type PostStacksAdoptAnswerFailed struct {
	Error string `json:"error"`
	Name  string `json:"name"`
}

PostStacksAdoptAnswerFailed is an object the document declares inline.

type PostStacksAdoptRequest ¶

type PostStacksAdoptRequest struct {
	EnvironmentId EnvironmentID                  `json:"environmentId"`
	Stacks        []PostStacksAdoptRequestStacks `json:"stacks"`
}

PostStacksAdoptRequest is an object the document declares inline.

type PostStacksAdoptRequestStacks ¶

type PostStacksAdoptRequestStacks struct {
	ComposePath string `json:"composePath"`
	Name        string `json:"name"`
}

PostStacksAdoptRequestStacks is an object the document declares inline.

type PostStacksAdoptResponse ¶

type PostStacksAdoptResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksAdoptAnswer
	*PostStacksAdoptAnswer
}

PostStacksAdoptResponse is the result of PostStacksAdopt.

Answer is the PostStacksAdoptAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksAdoptResponse) Answered ¶

func (r PostStacksAdoptResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksAdoptResponse) Record ¶

Record is the PostStacksAdoptAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksAnswer ¶

type PostStacksAnswer struct {
	// why not, when it was made and could not be brought up
	Error string `json:"error,omitempty"`

	// the job the stack is made and brought up as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it went
	JobId string `json:"jobId,omitempty"`

	// what compose printed bringing it up, when it was
	Output string `json:"output,omitempty"`

	// whether the stack was brought up as well as made
	Started bool `json:"started"`
	Success bool `json:"success"`
}

PostStacksAnswer is an object the document declares inline.

type PostStacksByNameCheckPathChangeAnswer ¶

type PostStacksByNameCheckPathChangeAnswer struct {
	CurrentComposePath string `json:"currentComposePath,omitempty"`
	FileCount          int    `json:"fileCount"`
	HasChanges         bool   `json:"hasChanges"`
	NewDir             string `json:"newDir,omitempty"`
	OldDir             string `json:"oldDir,omitempty"`
	PersistenceWarning string `json:"persistenceWarning,omitempty"`
}

PostStacksByNameCheckPathChangeAnswer is an object the document declares inline.

type PostStacksByNameCheckPathChangeOptions ¶

type PostStacksByNameCheckPathChangeOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostStacksByNameCheckPathChangeOptions holds the query and header parameters of PostStacksByNameCheckPathChange.

func (PostStacksByNameCheckPathChangeOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameCheckPathChangeOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameCheckPathChangeRequest ¶

type PostStacksByNameCheckPathChangeRequest struct {
	NewComposePath string `json:"newComposePath"`
}

PostStacksByNameCheckPathChangeRequest is an object the document declares inline.

type PostStacksByNameCheckPathChangeResponse ¶

type PostStacksByNameCheckPathChangeResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameCheckPathChangeAnswer
	*PostStacksByNameCheckPathChangeAnswer
}

PostStacksByNameCheckPathChangeResponse is the result of PostStacksByNameCheckPathChange.

Answer is the PostStacksByNameCheckPathChangeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameCheckPathChangeResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameCheckPathChangeResponse) Record ¶

Record is the PostStacksByNameCheckPathChangeAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameDeployAnswer ¶

type PostStacksByNameDeployAnswer struct {
	// why not, when it did not
	Error string `json:"error,omitempty"`

	// the job the action runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it went
	JobId string `json:"jobId,omitempty"`

	// what was done, when it succeeded
	Output string `json:"output,omitempty"`

	// whether the action did what was asked; false comes with HTTP 200 all the same
	Success bool `json:"success"`
}

PostStacksByNameDeployAnswer is an object the document declares inline.

type PostStacksByNameDeployOptions ¶

type PostStacksByNameDeployOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostStacksByNameDeployOptions holds the query and header parameters of PostStacksByNameDeploy.

func (PostStacksByNameDeployOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameDeployOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameDeployRequest ¶

type PostStacksByNameDeployRequest struct {
	Build         *bool `json:"build,omitempty"`
	ForceRecreate *bool `json:"forceRecreate,omitempty"`
	Pull          *bool `json:"pull,omitempty"`
}

PostStacksByNameDeployRequest is an object the document declares inline.

type PostStacksByNameDeployResponse ¶

type PostStacksByNameDeployResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameDeployAnswer
	*PostStacksByNameDeployAnswer
}

PostStacksByNameDeployResponse is the result of PostStacksByNameDeploy.

Answer is the PostStacksByNameDeployAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameDeployResponse) Answered ¶

func (r PostStacksByNameDeployResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameDeployResponse) Record ¶

Record is the PostStacksByNameDeployAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameDownAnswer ¶

type PostStacksByNameDownAnswer struct {
	// why not, when it did not
	Error string `json:"error,omitempty"`

	// the job the action runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it went
	JobId string `json:"jobId,omitempty"`

	// what was done, when it succeeded
	Output string `json:"output,omitempty"`

	// whether the action did what was asked; false comes with HTTP 200 all the same
	Success bool `json:"success"`
}

PostStacksByNameDownAnswer is an object the document declares inline.

type PostStacksByNameDownOptions ¶

type PostStacksByNameDownOptions struct {
	// Environment id (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostStacksByNameDownOptions holds the query and header parameters of PostStacksByNameDown.

func (PostStacksByNameDownOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameDownOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameDownRequest ¶

type PostStacksByNameDownRequest struct {
	RemoveVolumes *bool `json:"removeVolumes,omitempty"`
}

PostStacksByNameDownRequest is an object the document declares inline.

type PostStacksByNameDownResponse ¶

type PostStacksByNameDownResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameDownAnswer
	*PostStacksByNameDownAnswer
}

PostStacksByNameDownResponse is the result of PostStacksByNameDown.

Answer is the PostStacksByNameDownAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameDownResponse) Answered ¶

func (r PostStacksByNameDownResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameDownResponse) Record ¶

Record is the PostStacksByNameDownAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameEnvValidateAnswer ¶

type PostStacksByNameEnvValidateAnswer struct {
	Defined  []string `json:"defined"`
	Missing  []string `json:"missing"`
	Optional []string `json:"optional"`
	Required []string `json:"required"`
	Unused   []string `json:"unused"`
	Valid    bool     `json:"valid"`
}

PostStacksByNameEnvValidateAnswer is an object the document declares inline.

type PostStacksByNameEnvValidateOptions ¶

type PostStacksByNameEnvValidateOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostStacksByNameEnvValidateOptions holds the query and header parameters of PostStacksByNameEnvValidate.

func (PostStacksByNameEnvValidateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameEnvValidateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameEnvValidateRequest ¶

type PostStacksByNameEnvValidateRequest struct {
	Compose   string   `json:"compose,omitempty"`
	Variables []string `json:"variables,omitzero"`
}

PostStacksByNameEnvValidateRequest is an object the document declares inline.

type PostStacksByNameEnvValidateResponse ¶

type PostStacksByNameEnvValidateResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameEnvValidateAnswer
	*PostStacksByNameEnvValidateAnswer
}

PostStacksByNameEnvValidateResponse is the result of PostStacksByNameEnvValidate.

Answer is the PostStacksByNameEnvValidateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameEnvValidateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameEnvValidateResponse) Record ¶

Record is the PostStacksByNameEnvValidateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameIconAnswer ¶

type PostStacksByNameIconAnswer struct {
	Icon    string `json:"icon"`
	Success bool   `json:"success"`
}

PostStacksByNameIconAnswer is an object the document declares inline.

type PostStacksByNameIconOptions ¶

type PostStacksByNameIconOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID
}

PostStacksByNameIconOptions holds the query and header parameters of PostStacksByNameIcon.

func (PostStacksByNameIconOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameIconOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameIconRequest ¶

type PostStacksByNameIconRequest struct {
	Icon  string `json:"icon,omitempty"`
	Image string `json:"image,omitempty"`
}

PostStacksByNameIconRequest is an object the document declares inline.

type PostStacksByNameIconResponse ¶

type PostStacksByNameIconResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameIconAnswer
	*PostStacksByNameIconAnswer
}

PostStacksByNameIconResponse is the result of PostStacksByNameIcon.

Answer is the PostStacksByNameIconAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameIconResponse) Answered ¶

func (r PostStacksByNameIconResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameIconResponse) Record ¶

Record is the PostStacksByNameIconAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameRelocateAnswer ¶

type PostStacksByNameRelocateAnswer struct {
	ComposeContent string                                  `json:"composeContent"`
	EnvVars        []PostStacksByNameRelocateAnswerEnvVars `json:"envVars"`
	Errors         []string                                `json:"errors,omitzero"`
	MovedFiles     []string                                `json:"movedFiles"`
	RawEnvContent  string                                  `json:"rawEnvContent"`
	Success        bool                                    `json:"success"`
}

PostStacksByNameRelocateAnswer is an object the document declares inline.

type PostStacksByNameRelocateAnswerEnvVars ¶

type PostStacksByNameRelocateAnswerEnvVars struct {
	IsSecret bool   `json:"isSecret"`
	Key      string `json:"key"`
	Value    string `json:"value"`
}

PostStacksByNameRelocateAnswerEnvVars is an object the document declares inline.

type PostStacksByNameRelocateOptions ¶

type PostStacksByNameRelocateOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostStacksByNameRelocateOptions holds the query and header parameters of PostStacksByNameRelocate.

func (PostStacksByNameRelocateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameRelocateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameRelocateRequest ¶

type PostStacksByNameRelocateRequest struct {
	NewComposePath string `json:"newComposePath"`
	NewEnvPath     string `json:"newEnvPath,omitempty"`
	OldDir         string `json:"oldDir"`
}

PostStacksByNameRelocateRequest is an object the document declares inline.

type PostStacksByNameRelocateResponse ¶

type PostStacksByNameRelocateResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameRelocateAnswer
	*PostStacksByNameRelocateAnswer
}

PostStacksByNameRelocateResponse is the result of PostStacksByNameRelocate.

Answer is the PostStacksByNameRelocateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameRelocateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameRelocateResponse) Record ¶

Record is the PostStacksByNameRelocateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameRestartAnswer ¶

type PostStacksByNameRestartAnswer struct {
	// why not, when it did not
	Error string `json:"error,omitempty"`

	// the job the action runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it went
	JobId string `json:"jobId,omitempty"`

	// what was done, when it succeeded
	Output string `json:"output,omitempty"`

	// whether the action did what was asked; false comes with HTTP 200 all the same
	Success bool `json:"success"`
}

PostStacksByNameRestartAnswer is an object the document declares inline.

type PostStacksByNameRestartOptions ¶

type PostStacksByNameRestartOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID

	// Restart mode — "recreate" recreates containers (new IDs, re-pull), "ordered" does a stop+start honoring depends_on ordering (same IDs), anything else is a plain in-place restart
	Mode string

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostStacksByNameRestartOptions holds the query and header parameters of PostStacksByNameRestart.

func (PostStacksByNameRestartOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameRestartOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameRestartResponse ¶

type PostStacksByNameRestartResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameRestartAnswer
	*PostStacksByNameRestartAnswer
}

PostStacksByNameRestartResponse is the result of PostStacksByNameRestart.

Answer is the PostStacksByNameRestartAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameRestartResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameRestartResponse) Record ¶

Record is the PostStacksByNameRestartAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameStartAnswer ¶

type PostStacksByNameStartAnswer struct {
	// why not, when it did not
	Error string `json:"error,omitempty"`

	// the job the action runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it went
	JobId string `json:"jobId,omitempty"`

	// what was done, when it succeeded
	Output string `json:"output,omitempty"`

	// whether the action did what was asked; false comes with HTTP 200 all the same
	Success bool `json:"success"`
}

PostStacksByNameStartAnswer is an object the document declares inline.

type PostStacksByNameStartOptions ¶

type PostStacksByNameStartOptions struct {
	// Environment id (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostStacksByNameStartOptions holds the query and header parameters of PostStacksByNameStart.

func (PostStacksByNameStartOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameStartOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameStartResponse ¶

type PostStacksByNameStartResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameStartAnswer
	*PostStacksByNameStartAnswer
}

PostStacksByNameStartResponse is the result of PostStacksByNameStart.

Answer is the PostStacksByNameStartAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameStartResponse) Answered ¶

func (r PostStacksByNameStartResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameStartResponse) Record ¶

Record is the PostStacksByNameStartAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameStopAnswer ¶

type PostStacksByNameStopAnswer struct {
	// why not, when it did not
	Error string `json:"error,omitempty"`

	// the job the action runs as, for a caller that did not ask for JSON alone and so was not made to wait: GET /api/jobs/{id} says how it went
	JobId string `json:"jobId,omitempty"`

	// what was done, when it succeeded
	Output string `json:"output,omitempty"`

	// whether the action did what was asked; false comes with HTTP 200 all the same
	Success bool `json:"success"`
}

PostStacksByNameStopAnswer is an object the document declares inline.

type PostStacksByNameStopOptions ¶

type PostStacksByNameStopOptions struct {
	// Environment id (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostStacksByNameStopOptions holds the query and header parameters of PostStacksByNameStop.

func (PostStacksByNameStopOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameStopOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameStopResponse ¶

type PostStacksByNameStopResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameStopAnswer
	*PostStacksByNameStopAnswer
}

PostStacksByNameStopResponse is the result of PostStacksByNameStop.

Answer is the PostStacksByNameStopAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameStopResponse) Answered ¶

func (r PostStacksByNameStopResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameStopResponse) Record ¶

Record is the PostStacksByNameStopAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksByNameValidateAnswer ¶

type PostStacksByNameValidateAnswer struct {
	Counts   *PostStacksByNameValidateAnswerCounts    `json:"counts"`
	Findings []PostStacksByNameValidateAnswerFindings `json:"findings"`
}

PostStacksByNameValidateAnswer is an object the document declares inline.

type PostStacksByNameValidateAnswerCounts ¶

type PostStacksByNameValidateAnswerCounts struct {
	Error int `json:"error"`
	Info  int `json:"info"`
	Warn  int `json:"warn"`
}

PostStacksByNameValidateAnswerCounts is an object the document declares inline.

type PostStacksByNameValidateAnswerFindings ¶

type PostStacksByNameValidateAnswerFindings struct {
	Fix            map[string]any `json:"fix,omitzero"`
	FixDescription string         `json:"fixDescription,omitempty"`
	Hint           string         `json:"hint,omitempty"`
	Line           int            `json:"line,omitempty"`
	Message        string         `json:"message"`
	RuleId         string         `json:"ruleId"`
	Service        string         `json:"service,omitempty"`
	Severity       CheckSeverity  `json:"severity"`
}

PostStacksByNameValidateAnswerFindings is an object the document declares inline.

type PostStacksByNameValidateOptions ¶

type PostStacksByNameValidateOptions struct {
	// Environment ID for the context-aware checks (from GET /api/environments)
	Env EnvironmentID
}

PostStacksByNameValidateOptions holds the query and header parameters of PostStacksByNameValidate.

func (PostStacksByNameValidateOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostStacksByNameValidateOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostStacksByNameValidateRequest ¶

type PostStacksByNameValidateRequest struct {
	Compose      string                                 `json:"compose"`
	Config       *PostStacksByNameValidateRequestConfig `json:"config,omitempty"`
	EnvVars      map[string]any                         `json:"envVars,omitzero"`
	Existing     *bool                                  `json:"existing,omitempty"`
	ProviderKeys []string                               `json:"providerKeys,omitzero"`
}

PostStacksByNameValidateRequest is an object the document declares inline.

type PostStacksByNameValidateRequestConfig ¶

type PostStacksByNameValidateRequestConfig struct {
	Disabled []string       `json:"disabled,omitzero"`
	Severity map[string]any `json:"severity,omitzero"`
}

PostStacksByNameValidateRequestConfig is an object the document declares inline.

type PostStacksByNameValidateResponse ¶

type PostStacksByNameValidateResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksByNameValidateAnswer
	*PostStacksByNameValidateAnswer
}

PostStacksByNameValidateResponse is the result of PostStacksByNameValidate.

Answer is the PostStacksByNameValidateAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksByNameValidateResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksByNameValidateResponse) Record ¶

Record is the PostStacksByNameValidateAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksOptions ¶

type PostStacksOptions struct {
	// Target environment id (takes precedence over envId/environmentId in the body)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostStacksOptions holds the query and header parameters of PostStacks.

func (PostStacksOptions) ToHeaders ¶

func (o PostStacksOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostStacksOptions) ToQuery ¶

func (o PostStacksOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type PostStacksRequest ¶

type PostStacksRequest struct {
	Build            *bool            `json:"build,omitempty"`
	Compose          string           `json:"compose"`
	ComposePath      string           `json:"composePath,omitempty"`
	EnvId            EnvironmentID    `json:"envId,omitempty"`
	EnvPath          string           `json:"envPath,omitempty"`
	EnvVars          []map[string]any `json:"envVars,omitzero"`
	EnvironmentId    EnvironmentID    `json:"environmentId,omitempty"`
	ForceRecreate    *bool            `json:"forceRecreate,omitempty"`
	Name             string           `json:"name"`
	Pull             *bool            `json:"pull,omitempty"`
	RawEnvContent    string           `json:"rawEnvContent,omitempty"`
	SecretProviderId SecretProviderID `json:"secretProviderId,omitempty"`
	Start            *bool            `json:"start,omitempty"`
}

PostStacksRequest is an object the document declares inline.

type PostStacksResponse ¶

type PostStacksResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksAnswer
	*PostStacksAnswer
}

PostStacksResponse is the result of PostStacks.

Answer is the PostStacksAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksResponse) Answered ¶

func (r PostStacksResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksResponse) Record ¶

Record is the PostStacksAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksScanAnswer ¶

type PostStacksScanAnswer struct {
	Adopted    []string                         `json:"adopted"`
	Discovered []PostStacksScanAnswerDiscovered `json:"discovered"`
	Errors     []PostStacksScanAnswerErrors     `json:"errors"`

	// the compose files found that are stacks Dockhand has already
	Skipped []PostStacksScanAnswerSkipped `json:"skipped"`
}

PostStacksScanAnswer is an object the document declares inline.

type PostStacksScanAnswerDiscovered ¶

type PostStacksScanAnswerDiscovered struct {
	ComposePath string `json:"composePath,omitempty"`

	// the .env file beside it, when there is one
	EnvPath string `json:"envPath,omitempty"`

	// the name the stack would have: the folder's
	Name string `json:"name,omitempty"`

	// the environments a compose project of that name has containers on already
	RunningOn    []PostStacksScanAnswerDiscoveredRunningOn `json:"runningOn,omitzero"`
	ServiceCount int                                       `json:"serviceCount,omitempty"`
	SourceDir    string                                    `json:"sourceDir,omitempty"`
	Unadoptable  bool                                      `json:"unadoptable"`
}

PostStacksScanAnswerDiscovered is an object the document declares inline.

type PostStacksScanAnswerDiscoveredRunningOn ¶

type PostStacksScanAnswerDiscoveredRunningOn struct {
	ContainerCount int           `json:"containerCount,omitempty"`
	EnvId          EnvironmentID `json:"envId,omitempty"`
	EnvName        string        `json:"envName,omitempty"`
}

PostStacksScanAnswerDiscoveredRunningOn is an object the document declares inline.

type PostStacksScanAnswerErrors ¶

type PostStacksScanAnswerErrors struct {
	Error string `json:"error"`
	Path  string `json:"path"`
}

PostStacksScanAnswerErrors is an object the document declares inline.

type PostStacksScanAnswerSkipped ¶

type PostStacksScanAnswerSkipped struct {
	ComposePath string `json:"composePath,omitempty"`

	// the .env file beside it, when there is one
	EnvPath string `json:"envPath,omitempty"`

	// the name the stack would have: the folder's
	Name         string `json:"name,omitempty"`
	ServiceCount int    `json:"serviceCount,omitempty"`
	SourceDir    string `json:"sourceDir,omitempty"`
}

PostStacksScanAnswerSkipped is an object the document declares inline.

type PostStacksScanRequest ¶

type PostStacksScanRequest struct {
	Path string `json:"path,omitempty"`
}

PostStacksScanRequest is an object the document declares inline.

type PostStacksScanResponse ¶

type PostStacksScanResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksScanAnswer
	*PostStacksScanAnswer
}

PostStacksScanResponse is the result of PostStacksScan.

Answer is the PostStacksScanAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksScanResponse) Answered ¶

func (r PostStacksScanResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksScanResponse) Record ¶

Record is the PostStacksScanAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostStacksValidatePathAnswer ¶

type PostStacksValidatePathAnswer struct {
	Error string `json:"error,omitempty"`

	// the path as Dockhand resolved it, when it is one that can be used
	ResolvedPath string `json:"resolvedPath,omitempty"`
	Valid        bool   `json:"valid"`
}

PostStacksValidatePathAnswer is an object the document declares inline.

type PostStacksValidatePathRequest ¶

type PostStacksValidatePathRequest struct {
	Path string `json:"path"`
}

PostStacksValidatePathRequest is an object the document declares inline.

type PostStacksValidatePathResponse ¶

type PostStacksValidatePathResponse struct {
	HttpResponse *http.Response
	Answer       *PostStacksValidatePathAnswer
	*PostStacksValidatePathAnswer
}

PostStacksValidatePathResponse is the result of PostStacksValidatePath.

Answer is the PostStacksValidatePathAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostStacksValidatePathResponse) Answered ¶

func (r PostStacksValidatePathResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostStacksValidatePathResponse) Record ¶

Record is the PostStacksValidatePathAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostSystemFilesAnswer ¶

type PostSystemFilesAnswer struct {
	Path    string `json:"path"`
	Success bool   `json:"success"`
}

PostSystemFilesAnswer is an object the document declares inline.

type PostSystemFilesRequest ¶

type PostSystemFilesRequest struct {
	Path string `json:"path"`
}

PostSystemFilesRequest is an object the document declares inline.

type PostSystemFilesResponse ¶

type PostSystemFilesResponse struct {
	HttpResponse *http.Response
	Answer       *PostSystemFilesAnswer
	*PostSystemFilesAnswer
}

PostSystemFilesResponse is the result of PostSystemFiles.

Answer is the PostSystemFilesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostSystemFilesResponse) Answered ¶

func (r PostSystemFilesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostSystemFilesResponse) Record ¶

Record is the PostSystemFilesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostTagsAnswer ¶

type PostTagsAnswer struct {
	Color string `json:"color"`
	Icon  string `json:"icon,omitempty"`
	Id    TagID  `json:"id"`
	Name  string `json:"name"`
}

PostTagsAnswer is an object the document declares inline.

func (PostTagsAnswer) GetId ¶

func (m PostTagsAnswer) GetId() TagID

GetId is the record's Id, for code that handles records of several types alike.

func (PostTagsAnswer) GetName ¶

func (m PostTagsAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostTagsRequest ¶

type PostTagsRequest struct {
	Color string `json:"color,omitempty"`
	Icon  string `json:"icon,omitempty"`
	Name  string `json:"name"`
}

PostTagsRequest is an object the document declares inline.

type PostTagsResponse ¶

type PostTagsResponse struct {
	HttpResponse *http.Response
	Answer       *PostTagsAnswer
	*PostTagsAnswer
}

PostTagsResponse is the result of PostTags.

Answer is the PostTagsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostTagsResponse) Answered ¶

func (r PostTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostTagsResponse) Record ¶

func (r PostTagsResponse) Record() (PostTagsAnswer, error)

Record is the PostTagsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostTemplatesComposeAnswer ¶

type PostTemplatesComposeAnswer struct {
	Compose string `json:"compose"`
}

PostTemplatesComposeAnswer is an object the document declares inline.

type PostTemplatesComposeRequest ¶

type PostTemplatesComposeRequest struct {
	Template *PostTemplatesComposeRequestTemplate `json:"template"`
}

PostTemplatesComposeRequest is an object the document declares inline.

type PostTemplatesComposeRequestTemplate ¶

type PostTemplatesComposeRequestTemplate struct {
	Env           []PostTemplatesComposeRequestTemplateEnv       `json:"env,omitzero"`
	Id            string                                         `json:"id,omitempty"`
	Image         string                                         `json:"image,omitempty"`
	Network       string                                         `json:"network,omitempty"`
	Ports         []string                                       `json:"ports,omitzero"`
	Repository    *PostTemplatesComposeRequestTemplateRepository `json:"repository,omitempty"`
	RestartPolicy string                                         `json:"restartPolicy,omitempty"`
	Title         string                                         `json:"title,omitempty"`
	Type          string                                         `json:"type,omitempty"`
	Volumes       []PostTemplatesComposeRequestTemplateVolumes   `json:"volumes,omitzero"`
}

PostTemplatesComposeRequestTemplate is an object the document declares inline.

type PostTemplatesComposeRequestTemplateEnv ¶

type PostTemplatesComposeRequestTemplateEnv struct {
	Default string `json:"default,omitempty"`
	Label   string `json:"label,omitempty"`
	Name    string `json:"name,omitempty"`
}

PostTemplatesComposeRequestTemplateEnv is an object the document declares inline.

type PostTemplatesComposeRequestTemplateRepository ¶

type PostTemplatesComposeRequestTemplateRepository struct {
	Stackfile string `json:"stackfile,omitempty"`
	Url       string `json:"url,omitempty"`
}

PostTemplatesComposeRequestTemplateRepository is an object the document declares inline.

type PostTemplatesComposeRequestTemplateVolumes ¶

type PostTemplatesComposeRequestTemplateVolumes struct {
	// the place on the host, when the template names one
	Bind      string `json:"bind,omitempty"`
	Container string `json:"container,omitempty"`
}

PostTemplatesComposeRequestTemplateVolumes is an object the document declares inline.

type PostTemplatesComposeResponse ¶

type PostTemplatesComposeResponse struct {
	HttpResponse *http.Response
	Answer       *PostTemplatesComposeAnswer
	*PostTemplatesComposeAnswer
}

PostTemplatesComposeResponse is the result of PostTemplatesCompose.

Answer is the PostTemplatesComposeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostTemplatesComposeResponse) Answered ¶

func (r PostTemplatesComposeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostTemplatesComposeResponse) Record ¶

Record is the PostTemplatesComposeAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostTemplatesSourcesAnswer ¶

type PostTemplatesSourcesAnswer struct {
	// one of the sources Dockhand comes with
	Builtin   bool             `json:"builtin"`
	Enabled   bool             `json:"enabled"`
	Id        TemplateSourceID `json:"id"`
	Name      string           `json:"name"`
	SortOrder int              `json:"sortOrder,omitempty"`

	// the id Dockhand keeps the source under
	SourceId string `json:"sourceId,omitempty"`
	Url      string `json:"url"`
}

PostTemplatesSourcesAnswer is an object the document declares inline.

func (PostTemplatesSourcesAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PostTemplatesSourcesAnswer) GetName ¶

func (m PostTemplatesSourcesAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PostTemplatesSourcesRequest ¶

type PostTemplatesSourcesRequest struct {
	Name string `json:"name"`
	Url  string `json:"url"`
}

PostTemplatesSourcesRequest is an object the document declares inline.

type PostTemplatesSourcesResponse ¶

type PostTemplatesSourcesResponse struct {
	HttpResponse *http.Response
	Answer       *PostTemplatesSourcesAnswer
	*PostTemplatesSourcesAnswer
}

PostTemplatesSourcesResponse is the result of PostTemplatesSources.

Answer is the PostTemplatesSourcesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostTemplatesSourcesResponse) Answered ¶

func (r PostTemplatesSourcesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostTemplatesSourcesResponse) Record ¶

Record is the PostTemplatesSourcesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostUsersAnswer ¶

type PostUsersAnswer struct {
	// sent false for a user made by a caller that was already let in
	AutoLoggedIn bool   `json:"autoLoggedIn"`
	CreatedAt    Time   `json:"createdAt,omitzero"`
	DisplayName  string `json:"displayName,omitempty"`
	Email        string `json:"email,omitempty"`
	Id           UserID `json:"id"`
	IsActive     bool   `json:"isActive"`
	IsAdmin      bool   `json:"isAdmin"`
	Username     string `json:"username"`
}

PostUsersAnswer is an object the document declares inline.

type PostUsersByIdMfaRequest ¶

type PostUsersByIdMfaRequest struct {
	Action string `json:"action"`
	Token  string `json:"token,omitempty"`
}

PostUsersByIdMfaRequest is an object the document declares inline.

type PostUsersByIdMfaResponse ¶

type PostUsersByIdMfaResponse struct {
	HttpResponse *http.Response
}

PostUsersByIdMfaResponse is the result of PostUsersByIdMfa.

type PostUsersByIdRolesRequest ¶

type PostUsersByIdRolesRequest struct {
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	RoleId        RoleID        `json:"roleId"`
}

PostUsersByIdRolesRequest is an object the document declares inline.

type PostUsersByIdRolesResponse ¶

type PostUsersByIdRolesResponse struct {
	HttpResponse *http.Response
}

PostUsersByIdRolesResponse is the result of PostUsersByIdRoles.

type PostUsersRequest ¶

type PostUsersRequest struct {
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Password    string `json:"password"`
	Username    string `json:"username"`
}

PostUsersRequest is an object the document declares inline.

type PostUsersResponse ¶

type PostUsersResponse struct {
	HttpResponse *http.Response
	Answer       *PostUsersAnswer
	*PostUsersAnswer
}

PostUsersResponse is the result of PostUsers.

Answer is the PostUsersAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostUsersResponse) Answered ¶

func (r PostUsersResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostUsersResponse) Record ¶

func (r PostUsersResponse) Record() (PostUsersAnswer, error)

Record is the PostUsersAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostVolumesAnswer ¶

type PostVolumesAnswer struct {
	Name    string `json:"name"`
	Success bool   `json:"success"`
}

PostVolumesAnswer is an object the document declares inline.

type PostVolumesByNameBrowseReleaseAnswer ¶

type PostVolumesByNameBrowseReleaseAnswer struct {
	Success bool `json:"success"`
}

PostVolumesByNameBrowseReleaseAnswer is an object the document declares inline.

type PostVolumesByNameBrowseReleaseOptions ¶

type PostVolumesByNameBrowseReleaseOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostVolumesByNameBrowseReleaseOptions holds the query and header parameters of PostVolumesByNameBrowseRelease.

func (PostVolumesByNameBrowseReleaseOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostVolumesByNameBrowseReleaseOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostVolumesByNameBrowseReleaseResponse ¶

type PostVolumesByNameBrowseReleaseResponse struct {
	HttpResponse *http.Response
	Answer       *PostVolumesByNameBrowseReleaseAnswer
	*PostVolumesByNameBrowseReleaseAnswer
}

PostVolumesByNameBrowseReleaseResponse is the result of PostVolumesByNameBrowseRelease.

Answer is the PostVolumesByNameBrowseReleaseAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostVolumesByNameBrowseReleaseResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostVolumesByNameBrowseReleaseResponse) Record ¶

Record is the PostVolumesByNameBrowseReleaseAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostVolumesByNameCloneAnswer ¶

type PostVolumesByNameCloneAnswer struct {
	Name    string `json:"name"`
	Success bool   `json:"success"`
}

PostVolumesByNameCloneAnswer is an object the document declares inline.

type PostVolumesByNameCloneOptions ¶

type PostVolumesByNameCloneOptions struct {
	// Environment ID the volume belongs to (from GET /api/environments)
	Env EnvironmentID
}

PostVolumesByNameCloneOptions holds the query and header parameters of PostVolumesByNameClone.

func (PostVolumesByNameCloneOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostVolumesByNameCloneOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostVolumesByNameCloneRequest ¶

type PostVolumesByNameCloneRequest struct {
	Name string `json:"name"`
}

PostVolumesByNameCloneRequest is an object the document declares inline.

type PostVolumesByNameCloneResponse ¶

type PostVolumesByNameCloneResponse struct {
	HttpResponse *http.Response
	Answer       *PostVolumesByNameCloneAnswer
	*PostVolumesByNameCloneAnswer
}

PostVolumesByNameCloneResponse is the result of PostVolumesByNameClone.

Answer is the PostVolumesByNameCloneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostVolumesByNameCloneResponse) Answered ¶

func (r PostVolumesByNameCloneResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostVolumesByNameCloneResponse) Record ¶

Record is the PostVolumesByNameCloneAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostVolumesOptions ¶

type PostVolumesOptions struct {
	// Environment ID to create the volume in (from GET /api/environments)
	Env EnvironmentID
}

PostVolumesOptions holds the query and header parameters of PostVolumes.

func (PostVolumesOptions) ToHeaders ¶

func (o PostVolumesOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PostVolumesOptions) ToQuery ¶

func (o PostVolumesOptions) ToQuery() *client.QueryParams

ToQuery returns the query parameters the options set.

type PostVolumesRequest ¶

type PostVolumesRequest struct {
	Driver     string         `json:"driver,omitempty"`
	DriverOpts map[string]any `json:"driverOpts,omitzero"`
	Labels     map[string]any `json:"labels,omitzero"`
	Name       string         `json:"name"`
}

PostVolumesRequest is an object the document declares inline.

type PostVolumesResponse ¶

type PostVolumesResponse struct {
	HttpResponse *http.Response
	Answer       *PostVolumesAnswer
	*PostVolumesAnswer
}

PostVolumesResponse is the result of PostVolumes.

Answer is the PostVolumesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostVolumesResponse) Answered ¶

func (r PostVolumesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostVolumesResponse) Record ¶

Record is the PostVolumesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PostVulnerabilitiesScanAllAnswer ¶

type PostVulnerabilitiesScanAllAnswer struct {
	Cancelled bool   `json:"cancelled"`
	Error     string `json:"error,omitempty"`

	// how many could not be
	Failed int `json:"failed,omitempty"`

	// the job the scans run as, for a caller that did not ask for JSON alone
	JobId string `json:"jobId,omitempty"`

	// how many images were scanned
	Scanned int `json:"scanned,omitempty"`

	// false, with why in error, for an environment there is none of or none given: answered with 200 all the same
	Success bool `json:"success"`

	// how many images the environment has
	Total int `json:"total,omitempty"`
}

PostVulnerabilitiesScanAllAnswer is an object the document declares inline.

type PostVulnerabilitiesScanAllOptions ¶

type PostVulnerabilitiesScanAllOptions struct {
	// ID of the environment whose images to scan (from GET /api/environments)
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PostVulnerabilitiesScanAllOptions holds the query and header parameters of PostVulnerabilitiesScanAll.

func (PostVulnerabilitiesScanAllOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PostVulnerabilitiesScanAllOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PostVulnerabilitiesScanAllResponse ¶

type PostVulnerabilitiesScanAllResponse struct {
	HttpResponse *http.Response
	Answer       *PostVulnerabilitiesScanAllAnswer
	*PostVulnerabilitiesScanAllAnswer
}

PostVulnerabilitiesScanAllResponse is the result of PostVulnerabilitiesScanAll.

Answer is the PostVulnerabilitiesScanAllAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PostVulnerabilitiesScanAllResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PostVulnerabilitiesScanAllResponse) Record ¶

Record is the PostVulnerabilitiesScanAllAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutAuthLdapByIdAnswer ¶

type PutAuthLdapByIdAnswer struct {
	BaseDn    string `json:"baseDn"`
	Enabled   bool   `json:"enabled"`
	Id        int    `json:"id"`
	Name      string `json:"name"`
	ServerUrl string `json:"serverUrl"`
}

PutAuthLdapByIdAnswer is an object the document declares inline.

func (PutAuthLdapByIdAnswer) GetId ¶

func (m PutAuthLdapByIdAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (PutAuthLdapByIdAnswer) GetName ¶

func (m PutAuthLdapByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutAuthLdapByIdRequest ¶

type PutAuthLdapByIdRequest struct {
	AdminGroup           string         `json:"adminGroup,omitempty"`
	BaseDn               string         `json:"baseDn,omitempty"`
	BindDn               string         `json:"bindDn,omitempty"`
	BindPassword         string         `json:"bindPassword,omitempty"`
	DisplayNameAttribute string         `json:"displayNameAttribute,omitempty"`
	EmailAttribute       string         `json:"emailAttribute,omitempty"`
	Enabled              *bool          `json:"enabled,omitempty"`
	GroupBaseDn          string         `json:"groupBaseDn,omitempty"`
	GroupFilter          string         `json:"groupFilter,omitempty"`
	Name                 string         `json:"name,omitempty"`
	RoleMappings         map[string]any `json:"roleMappings,omitzero"`
	ServerUrl            string         `json:"serverUrl,omitempty"`
	TlsCa                string         `json:"tlsCa,omitempty"`
	TlsEnabled           *bool          `json:"tlsEnabled,omitempty"`
	UserFilter           string         `json:"userFilter,omitempty"`
	UsernameAttribute    string         `json:"usernameAttribute,omitempty"`
}

PutAuthLdapByIdRequest is an object the document declares inline.

type PutAuthLdapByIdResponse ¶

type PutAuthLdapByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutAuthLdapByIdAnswer
	*PutAuthLdapByIdAnswer
}

PutAuthLdapByIdResponse is the result of PutAuthLdapById.

Answer is the PutAuthLdapByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutAuthLdapByIdResponse) Answered ¶

func (r PutAuthLdapByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutAuthLdapByIdResponse) Record ¶

Record is the PutAuthLdapByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutAuthOidcByIdAnswer ¶

type PutAuthOidcByIdAnswer struct {
	// the claim named for an administrator, with adminValue; null when none is set
	AdminClaim string `json:"adminClaim,omitempty"`
	AdminValue string `json:"adminValue,omitempty"`
	ClientId   string `json:"clientId"`

	// eight asterisks, never the secret
	ClientSecret      string `json:"clientSecret,omitempty"`
	CreatedAt         Time   `json:"createdAt,omitzero"`
	DisplayNameClaim  string `json:"displayNameClaim,omitempty"`
	EmailClaim        string `json:"emailClaim,omitempty"`
	Enabled           bool   `json:"enabled"`
	Id                int    `json:"id"`
	IssuerUrl         string `json:"issuerUrl"`
	Name              string `json:"name"`
	RedirectUri       string `json:"redirectUri,omitempty"`
	RoleMappingsClaim string `json:"roleMappingsClaim,omitempty"`

	// the scopes named, with spaces between: openid profile email unless given
	Scopes        string `json:"scopes,omitempty"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
	UsernameClaim string `json:"usernameClaim,omitempty"`
}

PutAuthOidcByIdAnswer is an object the document declares inline.

func (PutAuthOidcByIdAnswer) GetId ¶

func (m PutAuthOidcByIdAnswer) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (PutAuthOidcByIdAnswer) GetName ¶

func (m PutAuthOidcByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutAuthOidcByIdRequest ¶

type PutAuthOidcByIdRequest struct {
	AdminClaim        string         `json:"adminClaim,omitempty"`
	AdminValue        string         `json:"adminValue,omitempty"`
	ClientId          string         `json:"clientId,omitempty"`
	ClientSecret      string         `json:"clientSecret,omitempty"`
	DisplayNameClaim  string         `json:"displayNameClaim,omitempty"`
	EmailClaim        string         `json:"emailClaim,omitempty"`
	Enabled           *bool          `json:"enabled,omitempty"`
	IssuerUrl         string         `json:"issuerUrl,omitempty"`
	Name              string         `json:"name,omitempty"`
	RedirectUri       string         `json:"redirectUri,omitempty"`
	RoleMappings      map[string]any `json:"roleMappings,omitzero"`
	RoleMappingsClaim string         `json:"roleMappingsClaim,omitempty"`
	Scopes            string         `json:"scopes,omitempty"`
	UsernameClaim     string         `json:"usernameClaim,omitempty"`
}

PutAuthOidcByIdRequest is an object the document declares inline.

type PutAuthOidcByIdResponse ¶

type PutAuthOidcByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutAuthOidcByIdAnswer
	*PutAuthOidcByIdAnswer
}

PutAuthOidcByIdResponse is the result of PutAuthOidcById.

Answer is the PutAuthOidcByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutAuthOidcByIdResponse) Answered ¶

func (r PutAuthOidcByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutAuthOidcByIdResponse) Record ¶

Record is the PutAuthOidcByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutAuthSettingsAnswer ¶

type PutAuthSettingsAnswer struct {
	AuthEnabled     bool   `json:"authEnabled"`
	CreatedAt       Time   `json:"createdAt,omitzero"`
	DefaultProvider string `json:"defaultProvider,omitempty"`
	Id              int    `json:"id,omitempty"`

	// how long a session lasts, in seconds: from 3600 to 604800 whatever was asked for, or 0 for one that never ends
	SessionTimeout int  `json:"sessionTimeout,omitempty"`
	UpdatedAt      Time `json:"updatedAt,omitzero"`
}

PutAuthSettingsAnswer is an object the document declares inline.

type PutAuthSettingsRequest ¶

type PutAuthSettingsRequest struct {
	AuthEnabled     *bool  `json:"authEnabled,omitempty"`
	DefaultProvider string `json:"defaultProvider,omitempty"`
	SessionTimeout  int    `json:"sessionTimeout,omitempty"`
}

PutAuthSettingsRequest is an object the document declares inline.

type PutAuthSettingsResponse ¶

type PutAuthSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *PutAuthSettingsAnswer
	*PutAuthSettingsAnswer
}

PutAuthSettingsResponse is the result of PutAuthSettings.

Answer is the PutAuthSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutAuthSettingsResponse) Answered ¶

func (r PutAuthSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutAuthSettingsResponse) Record ¶

Record is the PutAuthSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutBackupConfigsByIdAnswer ¶ added in v0.2.0

type PutBackupConfigsByIdAnswer struct {
	AllVolumes    bool                `json:"allVolumes"`
	CreatedAt     Time                `json:"createdAt,omitzero"`
	DestinationId BackupDestinationID `json:"destinationId,omitempty"`
	Enabled       bool                `json:"enabled"`

	// the environment the container or stack is on; null for one saved with none, which cannot be run
	EnvironmentId EnvironmentID  `json:"environmentId,omitempty"`
	Id            BackupConfigID `json:"id,omitempty"`
	LastBackupAt  Time           `json:"lastBackupAt,omitzero"`

	// success, warning, skipped or failed; null for one never run
	LastBackupStatus string `json:"lastBackupStatus,omitempty"`

	// more of how it is backed up, as JSON written out as text; null for none
	Options string `json:"options,omitempty"`

	// how many snapshots are kept, as JSON written out as text: keepLast, keepDaily, keepWeekly, keepMonthly, keepYearly; null to keep every one
	Retention string `json:"retention,omitempty"`

	// when it runs by itself, as cron; null or empty for one that only runs when asked
	Schedule string `json:"schedule,omitempty"`

	// the volumes to back up when not all of them, as a JSON list written out as text; null for none
	SelectedVolumes  string `json:"selectedVolumes,omitempty"`
	StopBeforeBackup bool   `json:"stopBeforeBackup"`

	// as a JSON list written out as text; null for none
	Tags       string `json:"tags,omitempty"`
	TargetName string `json:"targetName,omitempty"`

	// container or stack, as it was given: any other word is kept and then backs up nothing
	Type      string `json:"type,omitempty"`
	UpdatedAt Time   `json:"updatedAt,omitzero"`
}

PutBackupConfigsByIdAnswer is an object the document declares inline.

type PutBackupConfigsByIdRequest ¶

type PutBackupConfigsByIdRequest struct {
	AllVolumes       *bool                                 `json:"allVolumes,omitempty"`
	DestinationId    BackupDestinationID                   `json:"destinationId,omitempty"`
	Enabled          *bool                                 `json:"enabled,omitempty"`
	Options          map[string]any                        `json:"options,omitzero"`
	Retention        *PutBackupConfigsByIdRequestRetention `json:"retention,omitempty"`
	Schedule         string                                `json:"schedule,omitempty"`
	SelectedVolumes  []string                              `json:"selectedVolumes,omitzero"`
	StopBeforeBackup *bool                                 `json:"stopBeforeBackup,omitempty"`
	Tags             []string                              `json:"tags,omitzero"`
}

PutBackupConfigsByIdRequest is an object the document declares inline.

type PutBackupConfigsByIdRequestRetention ¶

type PutBackupConfigsByIdRequestRetention struct {
	KeepDaily   int `json:"keepDaily,omitempty"`
	KeepLast    int `json:"keepLast,omitempty"`
	KeepMonthly int `json:"keepMonthly,omitempty"`
	KeepWeekly  int `json:"keepWeekly,omitempty"`
	KeepYearly  int `json:"keepYearly,omitempty"`
}

PutBackupConfigsByIdRequestRetention is an object the document declares inline.

type PutBackupConfigsByIdResponse ¶

type PutBackupConfigsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutBackupConfigsByIdAnswer
	*PutBackupConfigsByIdAnswer
}

PutBackupConfigsByIdResponse is the result of PutBackupConfigsById.

Answer is the PutBackupConfigsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutBackupConfigsByIdResponse) Answered ¶ added in v0.2.0

func (r PutBackupConfigsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutBackupConfigsByIdResponse) Record ¶ added in v0.2.0

Record is the PutBackupConfigsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutBackupDestinationsByIdAnswer ¶ added in v0.2.0

type PutBackupDestinationsByIdAnswer struct {
	// more that restic is given for a backup; left out of the list
	BackupFlags string `json:"backupFlags,omitempty"`
	CreatedAt   Time   `json:"createdAt,omitzero"`

	// what the store is signed in to with, by the names restic reads them under; sent where one destination is read, made or changed, and left out of the list
	EnvVars map[string]string `json:"envVars,omitzero"`

	// the flags of a backup and of a restore together, as JSON written out as text; null for none. Sent, it is taken as the flags of a backup
	Flags            string              `json:"flags,omitempty"`
	HasCacert        bool                `json:"hasCacert"`
	HasTlsClientCert bool                `json:"hasTlsClientCert"`
	HostPath         string              `json:"hostPath,omitempty"`
	Id               BackupDestinationID `json:"id,omitempty"`
	LastTestAt       Time                `json:"lastTestAt,omitzero"`
	LastTestError    string              `json:"lastTestError,omitempty"`

	// how the last try of it went: success, failed or needs_init; null for one never tried
	LastTestStatus string `json:"lastTestStatus,omitempty"`
	Name           string `json:"name,omitempty"`

	// how the store is looked after by itself, as JSON written out as text: whether and when it is pruned, checked and verified
	Policies string `json:"policies,omitempty"`

	// where the backups are kept, as restic names it: a folder's path, or an address that opens with rest:, s3:, b2:, azure: or gs:
	Repository string `json:"repository,omitempty"`

	// more that restic is given for a restore; left out of the list
	RestoreFlags string `json:"restoreFlags,omitempty"`
	UpdatedAt    Time   `json:"updatedAt,omitzero"`
}

PutBackupDestinationsByIdAnswer is an object the document declares inline.

func (PutBackupDestinationsByIdAnswer) GetId ¶ added in v0.2.0

GetId is the record's Id, for code that handles records of several types alike.

func (PutBackupDestinationsByIdAnswer) GetName ¶ added in v0.2.0

GetName is the record's Name, for code that handles records of several types alike.

type PutBackupDestinationsByIdRequest ¶

type PutBackupDestinationsByIdRequest struct {
	BackupFlags   string         `json:"backupFlags,omitempty"`
	Cacert        string         `json:"cacert,omitempty"`
	EnvVars       map[string]any `json:"envVars,omitzero"`
	Flags         string         `json:"flags,omitempty"`
	HostPath      string         `json:"hostPath,omitempty"`
	Name          string         `json:"name,omitempty"`
	Password      string         `json:"password,omitempty"`
	Policies      string         `json:"policies,omitempty"`
	Repository    string         `json:"repository,omitempty"`
	RestoreFlags  string         `json:"restoreFlags,omitempty"`
	TlsClientCert string         `json:"tlsClientCert,omitempty"`
}

PutBackupDestinationsByIdRequest is an object the document declares inline.

type PutBackupDestinationsByIdResponse ¶

type PutBackupDestinationsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutBackupDestinationsByIdAnswer
	*PutBackupDestinationsByIdAnswer
}

PutBackupDestinationsByIdResponse is the result of PutBackupDestinationsById.

Answer is the PutBackupDestinationsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutBackupDestinationsByIdResponse) Answered ¶ added in v0.2.0

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutBackupDestinationsByIdResponse) Record ¶ added in v0.2.0

Record is the PutBackupDestinationsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutConfigSetsByIdAnswer ¶

type PutConfigSetsByIdAnswer struct {
	CreatedAt     Time                             `json:"createdAt"`
	Description   string                           `json:"description,omitempty"`
	EnvVars       []PutConfigSetsByIdAnswerEnvVars `json:"envVars,omitzero"`
	Id            ConfigSetID                      `json:"id"`
	Labels        []PutConfigSetsByIdAnswerLabels  `json:"labels,omitzero"`
	Name          string                           `json:"name"`
	NetworkMode   string                           `json:"networkMode"`
	Ports         []PutConfigSetsByIdAnswerPorts   `json:"ports,omitzero"`
	RestartPolicy string                           `json:"restartPolicy"`
	UpdatedAt     Time                             `json:"updatedAt"`
	Volumes       []PutConfigSetsByIdAnswerVolumes `json:"volumes,omitzero"`
}

PutConfigSetsByIdAnswer is an object the document declares inline.

func (PutConfigSetsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutConfigSetsByIdAnswer) GetName ¶

func (m PutConfigSetsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutConfigSetsByIdAnswerEnvVars ¶

type PutConfigSetsByIdAnswerEnvVars struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PutConfigSetsByIdAnswerEnvVars is an object the document declares inline.

type PutConfigSetsByIdAnswerLabels ¶

type PutConfigSetsByIdAnswerLabels struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PutConfigSetsByIdAnswerLabels is an object the document declares inline.

type PutConfigSetsByIdAnswerPorts ¶

type PutConfigSetsByIdAnswerPorts struct {
	ContainerPort string `json:"containerPort"`
	HostPort      string `json:"hostPort"`
	Protocol      string `json:"protocol"`
}

PutConfigSetsByIdAnswerPorts is an object the document declares inline.

type PutConfigSetsByIdAnswerVolumes ¶

type PutConfigSetsByIdAnswerVolumes struct {
	ContainerPath string `json:"containerPath"`
	HostPath      string `json:"hostPath"`
	Mode          string `json:"mode"`
}

PutConfigSetsByIdAnswerVolumes is an object the document declares inline.

type PutConfigSetsByIdRequest ¶

type PutConfigSetsByIdRequest struct {
	Description   string                            `json:"description,omitempty"`
	EnvVars       []PutConfigSetsByIdRequestEnvVars `json:"envVars,omitzero"`
	Labels        []PutConfigSetsByIdRequestLabels  `json:"labels,omitzero"`
	Name          string                            `json:"name,omitempty"`
	NetworkMode   string                            `json:"networkMode,omitempty"`
	Ports         []PutConfigSetsByIdRequestPorts   `json:"ports,omitzero"`
	RestartPolicy string                            `json:"restartPolicy,omitempty"`
	Volumes       []PutConfigSetsByIdRequestVolumes `json:"volumes,omitzero"`
}

PutConfigSetsByIdRequest is an object the document declares inline.

type PutConfigSetsByIdRequestEnvVars ¶

type PutConfigSetsByIdRequestEnvVars struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PutConfigSetsByIdRequestEnvVars is an object the document declares inline.

type PutConfigSetsByIdRequestLabels ¶

type PutConfigSetsByIdRequestLabels struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

PutConfigSetsByIdRequestLabels is an object the document declares inline.

type PutConfigSetsByIdRequestPorts ¶

type PutConfigSetsByIdRequestPorts struct {
	ContainerPort string `json:"containerPort"`
	HostPort      string `json:"hostPort"`
	Protocol      string `json:"protocol"`
}

PutConfigSetsByIdRequestPorts is an object the document declares inline.

type PutConfigSetsByIdRequestVolumes ¶

type PutConfigSetsByIdRequestVolumes struct {
	ContainerPath string `json:"containerPath"`
	HostPath      string `json:"hostPath"`
	Mode          string `json:"mode"`
}

PutConfigSetsByIdRequestVolumes is an object the document declares inline.

type PutConfigSetsByIdResponse ¶

type PutConfigSetsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutConfigSetsByIdAnswer
	*PutConfigSetsByIdAnswer
}

PutConfigSetsByIdResponse is the result of PutConfigSetsById.

Answer is the PutConfigSetsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutConfigSetsByIdResponse) Answered ¶

func (r PutConfigSetsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutConfigSetsByIdResponse) Record ¶

Record is the PutConfigSetsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutContainerTagsByNameAnswer ¶

type PutContainerTagsByNameAnswer struct {
	TagIds []TagID `json:"tagIds"`
}

PutContainerTagsByNameAnswer is an object the document declares inline.

type PutContainerTagsByNameOptions ¶

type PutContainerTagsByNameOptions struct {
	// Environment id
	Env EnvironmentID
}

PutContainerTagsByNameOptions holds the query and header parameters of PutContainerTagsByName.

func (PutContainerTagsByNameOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PutContainerTagsByNameOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutContainerTagsByNameRequest ¶

type PutContainerTagsByNameRequest struct {
	TagIds []TagID `json:"tagIds"`
}

PutContainerTagsByNameRequest is an object the document declares inline.

type PutContainerTagsByNameResponse ¶

type PutContainerTagsByNameResponse struct {
	HttpResponse *http.Response
	Answer       *PutContainerTagsByNameAnswer
	*PutContainerTagsByNameAnswer
}

PutContainerTagsByNameResponse is the result of PutContainerTagsByName.

Answer is the PutContainerTagsByNameAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutContainerTagsByNameResponse) Answered ¶

func (r PutContainerTagsByNameResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutContainerTagsByNameResponse) Record ¶

Record is the PutContainerTagsByNameAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutContainersByIdFilesContentAnswer ¶

type PutContainersByIdFilesContentAnswer struct {
	Path    string `json:"path"`
	Success bool   `json:"success"`
}

PutContainersByIdFilesContentAnswer is an object the document declares inline.

type PutContainersByIdFilesContentOptions ¶

type PutContainersByIdFilesContentOptions struct {
	// The target environment ID the container lives in (from GET /api/environments)
	Env EnvironmentID

	// Absolute file path inside the container
	Path string
}

PutContainersByIdFilesContentOptions holds the query and header parameters of PutContainersByIdFilesContent.

func (PutContainersByIdFilesContentOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PutContainersByIdFilesContentOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutContainersByIdFilesContentRequest ¶

type PutContainersByIdFilesContentRequest struct {
	Content string `json:"content"`
}

PutContainersByIdFilesContentRequest is an object the document declares inline.

type PutContainersByIdFilesContentResponse ¶

type PutContainersByIdFilesContentResponse struct {
	HttpResponse *http.Response
	Answer       *PutContainersByIdFilesContentAnswer
	*PutContainersByIdFilesContentAnswer
}

PutContainersByIdFilesContentResponse is the result of PutContainersByIdFilesContent.

Answer is the PutContainersByIdFilesContentAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutContainersByIdFilesContentResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutContainersByIdFilesContentResponse) Record ¶

Record is the PutContainersByIdFilesContentAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutEnvironmentsByIdAnswer ¶

type PutEnvironmentsByIdAnswer struct {
	CollectActivity bool `json:"collectActivity"`
	CollectMetrics  bool `json:"collectMetrics"`

	// how the host is reached: socket, direct, hawser-standard or hawser-edge
	ConnectionType ConnectionType `json:"connectionType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`

	// an agent's token is kept for the host; the token itself is never sent
	HasHawserToken bool `json:"hasHawserToken"`

	// a TLS key is kept for the host; the key itself is never sent
	HasTlsKey       bool   `json:"hasTlsKey"`
	HawserAgentId   string `json:"hawserAgentId,omitempty"`
	HawserAgentName string `json:"hawserAgentName,omitempty"`

	// when an agent that calls in was last heard from; empty for every other connection
	HawserLastSeen   Time   `json:"hawserLastSeen,omitzero"`
	HawserVersion    string `json:"hawserVersion,omitempty"`
	HighlightChanges bool   `json:"highlightChanges"`

	// the host or its agent, for every connection but a socket
	Host     string              `json:"host,omitempty"`
	Icon     string              `json:"icon,omitempty"`
	Id       EnvironmentID       `json:"id,omitempty"`
	Labels   []string            `json:"labels,omitzero"`
	Name     string              `json:"name,omitempty"`
	Port     int                 `json:"port,omitempty"`
	Protocol EnvironmentProtocol `json:"protocol,omitempty"`
	PublicIp string              `json:"publicIp,omitempty"`

	// the Docker socket, for a socket connection; sent for the others too, and means nothing there
	SocketPath    string `json:"socketPath,omitempty"`
	TlsCa         string `json:"tlsCa,omitempty"`
	TlsCert       string `json:"tlsCert,omitempty"`
	TlsSkipVerify bool   `json:"tlsSkipVerify"`
	UpdatedAt     Time   `json:"updatedAt,omitzero"`
}

PutEnvironmentsByIdAnswer is an object the document declares inline.

func (PutEnvironmentsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutEnvironmentsByIdAnswer) GetName ¶

func (m PutEnvironmentsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutEnvironmentsByIdImagePruneAnswer ¶

type PutEnvironmentsByIdImagePruneAnswer struct {
	Success bool `json:"success"`
}

PutEnvironmentsByIdImagePruneAnswer is an object the document declares inline.

type PutEnvironmentsByIdImagePruneResponse ¶

type PutEnvironmentsByIdImagePruneResponse struct {
	HttpResponse *http.Response
	Answer       *PutEnvironmentsByIdImagePruneAnswer
	*PutEnvironmentsByIdImagePruneAnswer
}

PutEnvironmentsByIdImagePruneResponse is the result of PutEnvironmentsByIdImagePrune.

Answer is the PutEnvironmentsByIdImagePruneAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutEnvironmentsByIdImagePruneResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutEnvironmentsByIdImagePruneResponse) Record ¶

Record is the PutEnvironmentsByIdImagePruneAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutEnvironmentsByIdNotificationsByNotificationIdAnswer ¶

type PutEnvironmentsByIdNotificationsByNotificationIdAnswer struct {
	// whether the channel itself is switched on: a link that is on sends nothing through a channel that is off
	ChannelEnabled bool           `json:"channelEnabled"`
	ChannelName    string         `json:"channelName,omitempty"`
	ChannelType    string         `json:"channelType,omitempty"`
	CreatedAt      Time           `json:"createdAt,omitzero"`
	Enabled        bool           `json:"enabled"`
	EnvironmentId  EnvironmentID  `json:"environmentId,omitempty"`
	EventTypes     []string       `json:"eventTypes,omitzero"`
	Id             int            `json:"id"`
	NotificationId NotificationID `json:"notificationId"`
	UpdatedAt      Time           `json:"updatedAt,omitzero"`
}

PutEnvironmentsByIdNotificationsByNotificationIdAnswer is an object the document declares inline.

type PutEnvironmentsByIdNotificationsByNotificationIdRequest ¶

type PutEnvironmentsByIdNotificationsByNotificationIdRequest struct {
	Enabled    *bool    `json:"enabled,omitempty"`
	EventTypes []string `json:"eventTypes,omitzero"`
}

PutEnvironmentsByIdNotificationsByNotificationIdRequest is an object the document declares inline.

type PutEnvironmentsByIdNotificationsByNotificationIdResponse ¶

type PutEnvironmentsByIdNotificationsByNotificationIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutEnvironmentsByIdNotificationsByNotificationIdAnswer
	*PutEnvironmentsByIdNotificationsByNotificationIdAnswer
}

PutEnvironmentsByIdNotificationsByNotificationIdResponse is the result of PutEnvironmentsByIdNotificationsByNotificationId.

Answer is the PutEnvironmentsByIdNotificationsByNotificationIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutEnvironmentsByIdNotificationsByNotificationIdResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutEnvironmentsByIdNotificationsByNotificationIdResponse) Record ¶

Record is the PutEnvironmentsByIdNotificationsByNotificationIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutEnvironmentsByIdRequest ¶

type PutEnvironmentsByIdRequest struct {
	CollectActivity  *bool               `json:"collectActivity,omitempty"`
	CollectMetrics   *bool               `json:"collectMetrics,omitempty"`
	ConnectionType   ConnectionType      `json:"connectionType,omitempty"`
	HawserToken      string              `json:"hawserToken,omitempty"`
	HighlightChanges *bool               `json:"highlightChanges,omitempty"`
	Host             string              `json:"host,omitempty"`
	Icon             string              `json:"icon,omitempty"`
	Labels           []string            `json:"labels,omitzero"`
	Name             string              `json:"name,omitempty"`
	Port             int                 `json:"port,omitempty"`
	Protocol         EnvironmentProtocol `json:"protocol,omitempty"`
	PublicIp         string              `json:"publicIp,omitempty"`
	SocketPath       string              `json:"socketPath,omitempty"`
	TlsCa            string              `json:"tlsCa,omitempty"`
	TlsCert          string              `json:"tlsCert,omitempty"`
	TlsKey           string              `json:"tlsKey,omitempty"`
	TlsSkipVerify    *bool               `json:"tlsSkipVerify,omitempty"`
}

PutEnvironmentsByIdRequest is an object the document declares inline.

type PutEnvironmentsByIdResponse ¶

type PutEnvironmentsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutEnvironmentsByIdAnswer
	*PutEnvironmentsByIdAnswer
}

PutEnvironmentsByIdResponse is the result of PutEnvironmentsById.

Answer is the PutEnvironmentsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutEnvironmentsByIdResponse) Answered ¶

func (r PutEnvironmentsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutEnvironmentsByIdResponse) Record ¶

Record is the PutEnvironmentsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutGitCredentialsByIdAnswer ¶

type PutGitCredentialsByIdAnswer struct {
	AuthType    GitAuthType     `json:"authType"`
	CreatedAt   Time            `json:"createdAt,omitzero"`
	HasPassword bool            `json:"hasPassword"`
	HasSshKey   bool            `json:"hasSshKey"`
	Id          GitCredentialID `json:"id"`
	Name        string          `json:"name"`
	UpdatedAt   Time            `json:"updatedAt,omitzero"`
	Username    string          `json:"username,omitempty"`
}

PutGitCredentialsByIdAnswer is an object the document declares inline.

func (PutGitCredentialsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutGitCredentialsByIdAnswer) GetName ¶

func (m PutGitCredentialsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutGitCredentialsByIdRequest ¶

type PutGitCredentialsByIdRequest struct {
	AuthType      GitAuthType `json:"authType,omitempty"`
	Name          string      `json:"name,omitempty"`
	Password      string      `json:"password,omitempty"`
	SshPassphrase string      `json:"sshPassphrase,omitempty"`
	SshPrivateKey string      `json:"sshPrivateKey,omitempty"`
	Username      string      `json:"username,omitempty"`
}

PutGitCredentialsByIdRequest is an object the document declares inline.

type PutGitCredentialsByIdResponse ¶

type PutGitCredentialsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutGitCredentialsByIdAnswer
	*PutGitCredentialsByIdAnswer
}

PutGitCredentialsByIdResponse is the result of PutGitCredentialsById.

Answer is the PutGitCredentialsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutGitCredentialsByIdResponse) Answered ¶

func (r PutGitCredentialsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutGitCredentialsByIdResponse) Record ¶

Record is the PutGitCredentialsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutGitRepositoriesByIdAnswer ¶

type PutGitRepositoriesByIdAnswer struct {
	AutoUpdate         bool   `json:"autoUpdate"`
	AutoUpdateCron     string `json:"autoUpdateCron,omitempty"`
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`
	Branch             string `json:"branch"`

	// left from when a repository was itself deployed: always compose.yaml, and nothing sets it
	ComposePath  string          `json:"composePath,omitempty"`
	CreatedAt    Time            `json:"createdAt,omitzero"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`

	// left from when a repository was itself deployed: always null, and nothing sets it
	EnvironmentId EnvironmentID   `json:"environmentId,omitempty"`
	Id            GitRepositoryID `json:"id"`

	// the commit the repository's own copy is at, shortened
	LastCommit string `json:"lastCommit,omitempty"`

	// when the repository's own copy was last fetched, which no git stack uses
	LastSync  Time   `json:"lastSync,omitzero"`
	Name      string `json:"name"`
	SyncError string `json:"syncError,omitempty"`

	// pending for a copy never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`
	UpdatedAt  Time   `json:"updatedAt,omitzero"`
	Url        string `json:"url"`

	// always false: nothing in the API switches a repository's own webhook on
	WebhookEnabled bool   `json:"webhookEnabled"`
	WebhookSecret  string `json:"webhookSecret,omitempty"`
}

PutGitRepositoriesByIdAnswer is an object the document declares inline.

func (PutGitRepositoriesByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutGitRepositoriesByIdAnswer) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type PutGitRepositoriesByIdRequest ¶

type PutGitRepositoriesByIdRequest struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Name         string          `json:"name,omitempty"`
	Url          string          `json:"url,omitempty"`
}

PutGitRepositoriesByIdRequest is an object the document declares inline.

type PutGitRepositoriesByIdResponse ¶

type PutGitRepositoriesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutGitRepositoriesByIdAnswer
	*PutGitRepositoriesByIdAnswer
}

PutGitRepositoriesByIdResponse is the result of PutGitRepositoriesById.

Answer is the PutGitRepositoriesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutGitRepositoriesByIdResponse) Answered ¶

func (r PutGitRepositoriesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutGitRepositoriesByIdResponse) Record ¶

Record is the PutGitRepositoriesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutGitStacksByIdAnswer ¶

type PutGitStacksByIdAnswer struct {
	// whether the stack is fetched and, when something changed, deployed on a schedule
	AutoUpdate     bool   `json:"autoUpdate"`
	AutoUpdateCron string `json:"autoUpdateCron,omitempty"`

	// a word for the schedule, as the web interface offers them: the cron beside it is what the schedule goes by
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`

	// the branch this stack follows; null for the repository's own
	Branch        string `json:"branch,omitempty"`
	BuildOnDeploy bool   `json:"buildOnDeploy"`

	// the compose file's path in the repository
	ComposePath string `json:"composePath,omitempty"`

	// the folder of the repository that is copied beside the compose file; null for the folder the compose file is in
	ContextDir string `json:"contextDir,omitempty"`
	CreatedAt  Time   `json:"createdAt,omitzero"`

	// one more .env file in the repository to fill the compose file in from; null for none
	EnvFilePath string `json:"envFilePath,omitempty"`

	// the environment the stack is deployed on; null for one made with none
	EnvironmentId EnvironmentID `json:"environmentId,omitempty"`
	ForceRedeploy bool          `json:"forceRedeploy"`
	Id            GitStackID    `json:"id,omitempty"`

	// the commit last fetched, shortened
	LastCommit   string `json:"lastCommit,omitempty"`
	LastSync     Time   `json:"lastSync,omitzero"`
	NoBuildCache bool   `json:"noBuildCache"`

	// the repository the stack is deployed from
	Repository   *PutGitStacksByIdAnswerRepository `json:"repository,omitempty"`
	RepositoryId GitRepositoryID                   `json:"repositoryId,omitempty"`
	RepullImages bool                              `json:"repullImages"`
	StackName    string                            `json:"stackName,omitempty"`
	SyncError    string                            `json:"syncError,omitempty"`

	// pending for a stack never fetched, then synced or error
	SyncStatus string `json:"syncStatus,omitempty"`

	// the files last copied from the repository, each with a hash, as JSON in a text; absent in the list
	SyncedFiles    string `json:"syncedFiles,omitempty"`
	UpdatedAt      Time   `json:"updatedAt,omitzero"`
	WebhookEnabled bool   `json:"webhookEnabled"`

	// the webhook's secret, sent back whole as it was given; null for none
	WebhookSecret string `json:"webhookSecret,omitempty"`
}

PutGitStacksByIdAnswer is an object the document declares inline.

type PutGitStacksByIdAnswerRepository ¶

type PutGitStacksByIdAnswerRepository struct {
	Branch       string          `json:"branch,omitempty"`
	CredentialId GitCredentialID `json:"credentialId,omitempty"`
	Id           GitRepositoryID `json:"id,omitempty"`
	Name         string          `json:"name,omitempty"`
	Url          string          `json:"url,omitempty"`
}

PutGitStacksByIdAnswerRepository is an object the document declares inline.

the repository the stack is deployed from

func (PutGitStacksByIdAnswerRepository) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutGitStacksByIdAnswerRepository) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type PutGitStacksByIdRequest ¶

type PutGitStacksByIdRequest struct {
	AutoUpdate     *bool  `json:"autoUpdate,omitempty"`
	AutoUpdateCron string `json:"autoUpdateCron,omitempty"`

	// a word for the schedule: the cron beside it is what the schedule goes by
	AutoUpdateSchedule string `json:"autoUpdateSchedule,omitempty"`

	// the branch this stack follows instead of the repository's own
	Branch        string `json:"branch,omitempty"`
	BuildOnDeploy *bool  `json:"buildOnDeploy,omitempty"`

	// the compose file's path in the repository; compose.yaml unless said
	ComposePath string `json:"composePath,omitempty"`

	// the folder of the repository that is copied beside the compose file
	ContextDir string `json:"contextDir,omitempty"`

	// deploy it at once, and answer the stack with how that went as deployResult
	DeployNow *bool `json:"deployNow,omitempty"`

	// one more .env file in the repository to fill the compose file in from
	EnvFilePath string `json:"envFilePath,omitempty"`

	// the variables Dockhand keeps for the stack, whole: the ones left out are removed, and an empty list removes them all
	EnvVars          []PutGitStacksByIdRequestEnvVars `json:"envVars,omitzero"`
	ForceRedeploy    *bool                            `json:"forceRedeploy,omitempty"`
	NoBuildCache     *bool                            `json:"noBuildCache,omitempty"`
	RepullImages     *bool                            `json:"repullImages,omitempty"`
	SecretProviderId SecretProviderID                 `json:"secretProviderId,omitempty"`
	StackName        string                           `json:"stackName,omitempty"`
	WebhookEnabled   *bool                            `json:"webhookEnabled,omitempty"`
	WebhookSecret    string                           `json:"webhookSecret,omitempty"`
}

PutGitStacksByIdRequest is an object the document declares inline.

type PutGitStacksByIdRequestEnvVars ¶

type PutGitStacksByIdRequestEnvVars struct {
	IsSecret *bool  `json:"isSecret,omitempty"`
	Key      string `json:"key,omitempty"`

	// the value; *** for a secret keeps the one it has
	Value string `json:"value,omitempty"`
}

PutGitStacksByIdRequestEnvVars is an object the document declares inline.

type PutGitStacksByIdResponse ¶

type PutGitStacksByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutGitStacksByIdAnswer
	*PutGitStacksByIdAnswer
}

PutGitStacksByIdResponse is the result of PutGitStacksById.

Answer is the PutGitStacksByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutGitStacksByIdResponse) Answered ¶

func (r PutGitStacksByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutGitStacksByIdResponse) Record ¶

Record is the PutGitStacksByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutNotificationsByIdAnswer ¶

type PutNotificationsByIdAnswer struct {
	Config     *PutNotificationsByIdAnswerConfig `json:"config,omitempty"`
	CreatedAt  Time                              `json:"createdAt,omitzero"`
	Enabled    bool                              `json:"enabled"`
	EventTypes []string                          `json:"eventTypes,omitzero"`
	Id         NotificationID                    `json:"id"`
	Name       string                            `json:"name"`
	Type       NotificationType                  `json:"type"`
	UpdatedAt  Time                              `json:"updatedAt,omitzero"`
}

PutNotificationsByIdAnswer is an object the document declares inline.

func (PutNotificationsByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutNotificationsByIdAnswer) GetName ¶

func (m PutNotificationsByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutNotificationsByIdAnswerConfig ¶

type PutNotificationsByIdAnswerConfig struct {
	FromEmail string `json:"from_email,omitempty"`
	FromName  string `json:"from_name,omitempty"`
	Host      string `json:"host,omitempty"`

	// for mail: eight asterisks where a password is kept, never the password
	Password string   `json:"password,omitempty"`
	Port     int      `json:"port,omitempty"`
	Secure   bool     `json:"secure"`
	ToEmails []string `json:"to_emails,omitzero"`

	// for a channel that is not mail: the addresses it sends to, in full, with whatever token or login each carries
	Urls     []string `json:"urls,omitzero"`
	Username string   `json:"username,omitempty"`
}

PutNotificationsByIdAnswerConfig is an object the document declares inline.

type PutNotificationsByIdRequest ¶

type PutNotificationsByIdRequest struct {
	Config     *PutNotificationsByIdRequestConfig `json:"config,omitempty"`
	Enabled    *bool                              `json:"enabled,omitempty"`
	EventTypes []string                           `json:"eventTypes,omitzero"`
	Name       string                             `json:"name,omitempty"`
}

PutNotificationsByIdRequest is an object the document declares inline.

type PutNotificationsByIdRequestConfig ¶

type PutNotificationsByIdRequestConfig struct {
	FromEmail string   `json:"from_email,omitempty"`
	FromName  string   `json:"from_name,omitempty"`
	Host      string   `json:"host,omitempty"`
	Password  string   `json:"password,omitempty"`
	Port      int      `json:"port,omitempty"`
	Secure    *bool    `json:"secure,omitempty"`
	ToEmails  []string `json:"to_emails,omitzero"`
	Urls      []string `json:"urls,omitzero"`
	Username  string   `json:"username,omitempty"`
}

PutNotificationsByIdRequestConfig is an object the document declares inline.

type PutNotificationsByIdResponse ¶

type PutNotificationsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutNotificationsByIdAnswer
	*PutNotificationsByIdAnswer
}

PutNotificationsByIdResponse is the result of PutNotificationsById.

Answer is the PutNotificationsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutNotificationsByIdResponse) Answered ¶

func (r PutNotificationsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutNotificationsByIdResponse) Record ¶

Record is the PutNotificationsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutProfileAnswer ¶

type PutProfileAnswer struct {
	Avatar      string `json:"avatar,omitempty"`
	CreatedAt   Time   `json:"createdAt"`
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Id          int    `json:"id"`
	IsAdmin     bool   `json:"isAdmin"`
	LastLogin   Time   `json:"lastLogin,omitzero"`
	MfaEnabled  bool   `json:"mfaEnabled"`
	UpdatedAt   Time   `json:"updatedAt"`
	Username    string `json:"username"`
}

PutProfileAnswer is an object the document declares inline.

type PutProfilePreferencesRequest ¶

type PutProfilePreferencesRequest struct {
	ActionIconSize       string `json:"actionIconSize,omitempty"`
	AnimateIcons         *bool  `json:"animateIcons,omitempty"`
	ColoredActionButtons *bool  `json:"coloredActionButtons,omitempty"`
	DarkTheme            string `json:"darkTheme,omitempty"`
	EditorFont           string `json:"editorFont,omitempty"`
	EditorIndentGuides   *bool  `json:"editorIndentGuides,omitempty"`
	EditorTheme          string `json:"editorTheme,omitempty"`
	Font                 string `json:"font,omitempty"`
	FontSize             string `json:"fontSize,omitempty"`
	GridFontSize         string `json:"gridFontSize,omitempty"`
	LightTheme           string `json:"lightTheme,omitempty"`
	TerminalFont         string `json:"terminalFont,omitempty"`
}

PutProfilePreferencesRequest is an object the document declares inline.

type PutProfilePreferencesResponse ¶

type PutProfilePreferencesResponse struct {
	HttpResponse *http.Response
}

PutProfilePreferencesResponse is the result of PutProfilePreferences.

type PutProfileRequest ¶

type PutProfileRequest struct {
	CurrentPassword string `json:"currentPassword,omitempty"`
	DisplayName     string `json:"displayName,omitempty"`
	Email           string `json:"email,omitempty"`
	NewPassword     string `json:"newPassword,omitempty"`
}

PutProfileRequest is an object the document declares inline.

type PutProfileResponse ¶

type PutProfileResponse struct {
	HttpResponse *http.Response
	Answer       *PutProfileAnswer
	*PutProfileAnswer
}

PutProfileResponse is the result of PutProfile.

Answer is the PutProfileAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutProfileResponse) Answered ¶

func (r PutProfileResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutProfileResponse) Record ¶

Record is the PutProfileAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutRegistriesByIdAnswer ¶

type PutRegistriesByIdAnswer struct {
	CreatedAt      Time       `json:"createdAt,omitzero"`
	HasCredentials bool       `json:"hasCredentials"`
	Id             RegistryID `json:"id"`
	IsDefault      bool       `json:"isDefault"`
	Name           string     `json:"name"`
	UpdatedAt      Time       `json:"updatedAt,omitzero"`
	Url            string     `json:"url"`

	// the user name it signs in to the registry with; null for one with no credentials
	Username string `json:"username,omitempty"`
}

PutRegistriesByIdAnswer is an object the document declares inline.

func (PutRegistriesByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutRegistriesByIdAnswer) GetName ¶

func (m PutRegistriesByIdAnswer) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutRegistriesByIdRequest ¶

type PutRegistriesByIdRequest struct {
	IsDefault *bool  `json:"isDefault,omitempty"`
	Name      string `json:"name,omitempty"`
	Password  string `json:"password,omitempty"`
	Url       string `json:"url,omitempty"`
	Username  string `json:"username,omitempty"`
}

PutRegistriesByIdRequest is an object the document declares inline.

type PutRegistriesByIdResponse ¶

type PutRegistriesByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutRegistriesByIdAnswer
	*PutRegistriesByIdAnswer
}

PutRegistriesByIdResponse is the result of PutRegistriesById.

Answer is the PutRegistriesByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutRegistriesByIdResponse) Answered ¶

func (r PutRegistriesByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutRegistriesByIdResponse) Record ¶

Record is the PutRegistriesByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutRolesByIdRequest ¶

type PutRolesByIdRequest struct {
	Description    string          `json:"description,omitempty"`
	EnvironmentIds []EnvironmentID `json:"environmentIds,omitzero"`
	Name           string          `json:"name,omitempty"`
	Permissions    map[string]any  `json:"permissions,omitzero"`
}

PutRolesByIdRequest is an object the document declares inline.

type PutRolesByIdResponse ¶

type PutRolesByIdResponse struct {
	HttpResponse *http.Response
}

PutRolesByIdResponse is the result of PutRolesById.

type PutSchedulesSettingsAnswer ¶

type PutSchedulesSettingsAnswer struct {
	HideSystemJobs bool `json:"hideSystemJobs"`
	Success        bool `json:"success"`
}

PutSchedulesSettingsAnswer is an object the document declares inline.

type PutSchedulesSettingsRequest ¶

type PutSchedulesSettingsRequest struct {
	HideSystemJobs *bool `json:"hideSystemJobs,omitempty"`
}

PutSchedulesSettingsRequest is an object the document declares inline.

type PutSchedulesSettingsResponse ¶

type PutSchedulesSettingsResponse struct {
	HttpResponse *http.Response
	Answer       *PutSchedulesSettingsAnswer
	*PutSchedulesSettingsAnswer
}

PutSchedulesSettingsResponse is the result of PutSchedulesSettings.

Answer is the PutSchedulesSettingsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutSchedulesSettingsResponse) Answered ¶

func (r PutSchedulesSettingsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutSchedulesSettingsResponse) Record ¶

Record is the PutSchedulesSettingsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutSecretProvidersByIdAnswer ¶

type PutSecretProvidersByIdAnswer struct {
	// when it was made, as the server writes it
	CreatedAt Time               `json:"createdAt,omitzero"`
	Id        SecretProviderID   `json:"id"`
	Name      string             `json:"name"`
	Type      SecretProviderType `json:"type"`

	// when it was last changed, which is written another way once it has been
	UpdatedAt Time `json:"updatedAt,omitzero"`
}

PutSecretProvidersByIdAnswer is an object the document declares inline.

func (PutSecretProvidersByIdAnswer) GetId ¶

GetId is the record's Id, for code that handles records of several types alike.

func (PutSecretProvidersByIdAnswer) GetName ¶

GetName is the record's Name, for code that handles records of several types alike.

type PutSecretProvidersByIdRequest ¶

type PutSecretProvidersByIdRequest struct {
	Config map[string]any     `json:"config,omitzero"`
	Name   string             `json:"name,omitempty"`
	Type   SecretProviderType `json:"type,omitempty"`
}

PutSecretProvidersByIdRequest is an object the document declares inline.

type PutSecretProvidersByIdResponse ¶

type PutSecretProvidersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutSecretProvidersByIdAnswer
	*PutSecretProvidersByIdAnswer
}

PutSecretProvidersByIdResponse is the result of PutSecretProvidersById.

Answer is the PutSecretProvidersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutSecretProvidersByIdResponse) Answered ¶

func (r PutSecretProvidersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutSecretProvidersByIdResponse) Record ¶

Record is the PutSecretProvidersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutSecretProvidersDefaultAnswer ¶

type PutSecretProvidersDefaultAnswer struct {
	ProviderId SecretProviderID `json:"providerId,omitempty"`
}

PutSecretProvidersDefaultAnswer is an object the document declares inline.

type PutSecretProvidersDefaultRequest ¶

type PutSecretProvidersDefaultRequest struct {
	ProviderId SecretProviderID `json:"providerId,omitempty"`
}

PutSecretProvidersDefaultRequest is an object the document declares inline.

type PutSecretProvidersDefaultResponse ¶

type PutSecretProvidersDefaultResponse struct {
	HttpResponse *http.Response
	Answer       *PutSecretProvidersDefaultAnswer
	*PutSecretProvidersDefaultAnswer
}

PutSecretProvidersDefaultResponse is the result of PutSecretProvidersDefault.

Answer is the PutSecretProvidersDefaultAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutSecretProvidersDefaultResponse) Answered ¶

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutSecretProvidersDefaultResponse) Record ¶

Record is the PutSecretProvidersDefaultAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutSettingsNavigationAnswer ¶

type PutSettingsNavigationAnswer struct {
	// the pages for everyone who chose none of their own, when that is what was changed
	Global  *PutSettingsNavigationAnswerGlobal `json:"global,omitempty"`
	Success bool                               `json:"success"`

	// the pages of the user who asked, when that is what was changed
	User *PutSettingsNavigationAnswerUser `json:"user,omitempty"`
}

PutSettingsNavigationAnswer is an object the document declares inline.

type PutSettingsNavigationAnswerGlobal ¶

type PutSettingsNavigationAnswerGlobal struct {
	// the page a click on an environment opens; null for none chosen
	EnvClickPage string `json:"envClickPage,omitempty"`

	// the page the web interface opens on; null for none chosen
	LandingPage string `json:"landingPage,omitempty"`
}

PutSettingsNavigationAnswerGlobal is an object the document declares inline.

the pages for everyone who chose none of their own, when that is what was changed

type PutSettingsNavigationAnswerUser ¶

type PutSettingsNavigationAnswerUser struct {
	// the page a click on an environment opens; null for none chosen
	EnvClickPage string `json:"envClickPage,omitempty"`

	// the page the web interface opens on; null for none chosen
	LandingPage string `json:"landingPage,omitempty"`
}

PutSettingsNavigationAnswerUser is an object the document declares inline.

the pages of the user who asked, when that is what was changed

type PutSettingsNavigationOptions ¶

type PutSettingsNavigationOptions struct {
	// Preference scope to update — "global" (default) or "user"
	Scope string
}

PutSettingsNavigationOptions holds the query and header parameters of PutSettingsNavigation.

func (PutSettingsNavigationOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PutSettingsNavigationOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutSettingsNavigationRequest ¶

type PutSettingsNavigationRequest struct {
	EnvClickPage string `json:"envClickPage,omitempty"`
	LandingPage  string `json:"landingPage,omitempty"`
}

PutSettingsNavigationRequest is an object the document declares inline.

type PutSettingsNavigationResponse ¶

type PutSettingsNavigationResponse struct {
	HttpResponse *http.Response
	Answer       *PutSettingsNavigationAnswer
	*PutSettingsNavigationAnswer
}

PutSettingsNavigationResponse is the result of PutSettingsNavigation.

Answer is the PutSettingsNavigationAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutSettingsNavigationResponse) Answered ¶

func (r PutSettingsNavigationResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutSettingsNavigationResponse) Record ¶

Record is the PutSettingsNavigationAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutStacksByNameComposeAnswer ¶

type PutStacksByNameComposeAnswer struct {
	// why not, when the file was saved and the stack could not be brought up again
	Error string `json:"error,omitempty"`

	// the job the file is saved and the stack brought up again as, for a caller that did not ask for JSON alone
	JobId string `json:"jobId,omitempty"`

	// what compose printed, when the stack was brought up again with the file
	Output  string `json:"output,omitempty"`
	Success bool   `json:"success"`
}

PutStacksByNameComposeAnswer is an object the document declares inline.

type PutStacksByNameComposeOptions ¶

type PutStacksByNameComposeOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID

	// what the caller will take for an answer. Left out, the call waits for the work and answers how it went; AcceptJob has it answered with the id of a job at once
	Accept string
}

PutStacksByNameComposeOptions holds the query and header parameters of PutStacksByNameCompose.

func (PutStacksByNameComposeOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PutStacksByNameComposeOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutStacksByNameComposeRequest ¶

type PutStacksByNameComposeRequest struct {
	Build            *bool            `json:"build,omitempty"`
	ComposePath      string           `json:"composePath,omitempty"`
	Content          string           `json:"content"`
	EnvPath          string           `json:"envPath,omitempty"`
	ForceRecreate    *bool            `json:"forceRecreate,omitempty"`
	MoveFromDir      string           `json:"moveFromDir,omitempty"`
	OldComposePath   string           `json:"oldComposePath,omitempty"`
	OldEnvPath       string           `json:"oldEnvPath,omitempty"`
	Pull             *bool            `json:"pull,omitempty"`
	Restart          *bool            `json:"restart,omitempty"`
	SecretProviderId SecretProviderID `json:"secretProviderId,omitempty"`
}

PutStacksByNameComposeRequest is an object the document declares inline.

type PutStacksByNameComposeResponse ¶

type PutStacksByNameComposeResponse struct {
	HttpResponse *http.Response
	Answer       *PutStacksByNameComposeAnswer
	*PutStacksByNameComposeAnswer
}

PutStacksByNameComposeResponse is the result of PutStacksByNameCompose.

Answer is the PutStacksByNameComposeAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutStacksByNameComposeResponse) Answered ¶

func (r PutStacksByNameComposeResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutStacksByNameComposeResponse) Record ¶

Record is the PutStacksByNameComposeAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutStacksByNameEnvAnswer ¶

type PutStacksByNameEnvAnswer struct {
	// how many variables were sent
	Count   int  `json:"count,omitempty"`
	Success bool `json:"success"`
}

PutStacksByNameEnvAnswer is an object the document declares inline.

type PutStacksByNameEnvOptions ¶

type PutStacksByNameEnvOptions struct {
	// Environment id the stack belongs to
	Env EnvironmentID
}

PutStacksByNameEnvOptions holds the query and header parameters of PutStacksByNameEnv.

func (PutStacksByNameEnvOptions) ToHeaders ¶

func (o PutStacksByNameEnvOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PutStacksByNameEnvOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutStacksByNameEnvRawAnswer ¶

type PutStacksByNameEnvRawAnswer struct {
	Deleted   bool `json:"deleted"`
	NoEnvFile bool `json:"noEnvFile"`
	Success   bool `json:"success"`
}

PutStacksByNameEnvRawAnswer is an object the document declares inline.

type PutStacksByNameEnvRawOptions ¶

type PutStacksByNameEnvRawOptions struct {
	// Environment ID the stack belongs to (from GET /api/environments)
	Env EnvironmentID
}

PutStacksByNameEnvRawOptions holds the query and header parameters of PutStacksByNameEnvRaw.

func (PutStacksByNameEnvRawOptions) ToHeaders ¶

ToHeaders returns the header parameters the options set.

func (PutStacksByNameEnvRawOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutStacksByNameEnvRawRequest ¶

type PutStacksByNameEnvRawRequest struct {
	Content string `json:"content"`
}

PutStacksByNameEnvRawRequest is an object the document declares inline.

type PutStacksByNameEnvRawResponse ¶

type PutStacksByNameEnvRawResponse struct {
	HttpResponse *http.Response
	Answer       *PutStacksByNameEnvRawAnswer
	*PutStacksByNameEnvRawAnswer
}

PutStacksByNameEnvRawResponse is the result of PutStacksByNameEnvRaw.

Answer is the PutStacksByNameEnvRawAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutStacksByNameEnvRawResponse) Answered ¶

func (r PutStacksByNameEnvRawResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutStacksByNameEnvRawResponse) Record ¶

Record is the PutStacksByNameEnvRawAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutStacksByNameEnvRequest ¶

type PutStacksByNameEnvRequest struct {
	Variables []PutStacksByNameEnvRequestVariables `json:"variables"`
}

PutStacksByNameEnvRequest is an object the document declares inline.

type PutStacksByNameEnvRequestVariables ¶

type PutStacksByNameEnvRequestVariables struct {
	IsSecret *bool  `json:"isSecret,omitempty"`
	Key      string `json:"key"`
	Value    string `json:"value"`
}

PutStacksByNameEnvRequestVariables is an object the document declares inline.

type PutStacksByNameEnvResponse ¶

type PutStacksByNameEnvResponse struct {
	HttpResponse *http.Response
	Answer       *PutStacksByNameEnvAnswer
	*PutStacksByNameEnvAnswer
}

PutStacksByNameEnvResponse is the result of PutStacksByNameEnv.

Answer is the PutStacksByNameEnvAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutStacksByNameEnvResponse) Answered ¶

func (r PutStacksByNameEnvResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutStacksByNameEnvResponse) Record ¶

Record is the PutStacksByNameEnvAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutStacksByNameTagsAnswer ¶

type PutStacksByNameTagsAnswer struct {
	TagIds []TagID `json:"tagIds"`
}

PutStacksByNameTagsAnswer is an object the document declares inline.

type PutStacksByNameTagsOptions ¶

type PutStacksByNameTagsOptions struct {
	// Environment id
	Env EnvironmentID
}

PutStacksByNameTagsOptions holds the query and header parameters of PutStacksByNameTags.

func (PutStacksByNameTagsOptions) ToHeaders ¶

func (o PutStacksByNameTagsOptions) ToHeaders() *client.Headers

ToHeaders returns the header parameters the options set.

func (PutStacksByNameTagsOptions) ToQuery ¶

ToQuery returns the query parameters the options set.

type PutStacksByNameTagsRequest ¶

type PutStacksByNameTagsRequest struct {
	TagIds []TagID `json:"tagIds"`
}

PutStacksByNameTagsRequest is an object the document declares inline.

type PutStacksByNameTagsResponse ¶

type PutStacksByNameTagsResponse struct {
	HttpResponse *http.Response
	Answer       *PutStacksByNameTagsAnswer
	*PutStacksByNameTagsAnswer
}

PutStacksByNameTagsResponse is the result of PutStacksByNameTags.

Answer is the PutStacksByNameTagsAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutStacksByNameTagsResponse) Answered ¶

func (r PutStacksByNameTagsResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutStacksByNameTagsResponse) Record ¶

Record is the PutStacksByNameTagsAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutTagsByIdAnswer ¶

type PutTagsByIdAnswer struct {
	Success bool `json:"success"`
}

PutTagsByIdAnswer is an object the document declares inline.

type PutTagsByIdRequest ¶

type PutTagsByIdRequest struct {
	Color string `json:"color,omitempty"`
	Icon  string `json:"icon,omitempty"`
	Name  string `json:"name,omitempty"`
}

PutTagsByIdRequest is an object the document declares inline.

type PutTagsByIdResponse ¶

type PutTagsByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutTagsByIdAnswer
	*PutTagsByIdAnswer
}

PutTagsByIdResponse is the result of PutTagsById.

Answer is the PutTagsByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutTagsByIdResponse) Answered ¶

func (r PutTagsByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutTagsByIdResponse) Record ¶

Record is the PutTagsByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutTemplatesSourcesAnswer ¶

type PutTemplatesSourcesAnswer struct {
	Ok bool `json:"ok"`
}

PutTemplatesSourcesAnswer is an object the document declares inline.

type PutTemplatesSourcesRequest ¶

type PutTemplatesSourcesRequest struct {
	Enabled *bool  `json:"enabled,omitempty"`
	Id      int    `json:"id"`
	Name    string `json:"name,omitempty"`
	Url     string `json:"url,omitempty"`
}

PutTemplatesSourcesRequest is an object the document declares inline.

func (PutTemplatesSourcesRequest) GetId ¶

func (m PutTemplatesSourcesRequest) GetId() int

GetId is the record's Id, for code that handles records of several types alike.

func (PutTemplatesSourcesRequest) GetName ¶

func (m PutTemplatesSourcesRequest) GetName() string

GetName is the record's Name, for code that handles records of several types alike.

type PutTemplatesSourcesResponse ¶

type PutTemplatesSourcesResponse struct {
	HttpResponse *http.Response
	Answer       *PutTemplatesSourcesAnswer
	*PutTemplatesSourcesAnswer
}

PutTemplatesSourcesResponse is the result of PutTemplatesSources.

Answer is the PutTemplatesSourcesAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutTemplatesSourcesResponse) Answered ¶

func (r PutTemplatesSourcesResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutTemplatesSourcesResponse) Record ¶

Record is the PutTemplatesSourcesAnswer answered, as a value to change and write back, or an error when the server answered none.

type PutUsersByIdAnswer ¶

type PutUsersByIdAnswer struct {
	CreatedAt   Time   `json:"createdAt"`
	DisplayName string `json:"displayName,omitempty"`
	Email       string `json:"email,omitempty"`
	Id          UserID `json:"id"`
	IsActive    bool   `json:"isActive"`
	IsAdmin     bool   `json:"isAdmin"`
	LastLogin   Time   `json:"lastLogin,omitzero"`
	MfaEnabled  bool   `json:"mfaEnabled"`
	UpdatedAt   Time   `json:"updatedAt"`
	Username    string `json:"username"`
}

PutUsersByIdAnswer is an object the document declares inline.

type PutUsersByIdRequest ¶

type PutUsersByIdRequest struct {
	ConfirmDisableAuth *bool  `json:"confirmDisableAuth,omitempty"`
	DisplayName        string `json:"displayName,omitempty"`
	Email              string `json:"email,omitempty"`
	IsActive           *bool  `json:"isActive,omitempty"`
	IsAdmin            *bool  `json:"isAdmin,omitempty"`
	Password           string `json:"password,omitempty"`
	Username           string `json:"username,omitempty"`
}

PutUsersByIdRequest is an object the document declares inline.

type PutUsersByIdResponse ¶

type PutUsersByIdResponse struct {
	HttpResponse *http.Response
	Answer       *PutUsersByIdAnswer
	*PutUsersByIdAnswer
}

PutUsersByIdResponse is the result of PutUsersById.

Answer is the PutUsersByIdAnswer answered, nil when the server answered none (a 204), which Answered tells. The same record is embedded, so res.Answer.Name may be read as res.Name; when nothing was answered the embedded record is a zero one, so that read is empty rather than a panic. Only the method sets the two; a response built by hand sets both or neither.

func (PutUsersByIdResponse) Answered ¶

func (r PutUsersByIdResponse) Answered() bool

Answered reports whether the server answered with a body that was decoded: false for a 204, or a call that failed before one came.

func (PutUsersByIdResponse) Record ¶

Record is the PutUsersByIdAnswer answered, as a value to change and write back, or an error when the server answered none.

type RegistryID ¶

type RegistryID int

RegistryID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and RegistryID(n) convert one value, client.IDs a list.

type RestartPolicy ¶

type RestartPolicy string

RestartPolicy is the "RestartPolicy" enum.

const (
	RestartPolicyNo            RestartPolicy = "no"
	RestartPolicyAlways        RestartPolicy = "always"
	RestartPolicyUnlessStopped RestartPolicy = "unless-stopped"
	RestartPolicyOnFailure     RestartPolicy = "on-failure"
)

Values of RestartPolicy.

func (RestartPolicy) Known ¶

func (v RestartPolicy) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type RoleID ¶

type RoleID int

RoleID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and RoleID(n) convert one value, client.IDs a list.

type RunStatus ¶

type RunStatus string

RunStatus is the "RunStatus" enum.

const (
	RunStatusQueued  RunStatus = "queued"
	RunStatusRunning RunStatus = "running"
	RunStatusSuccess RunStatus = "success"
	RunStatusWarning RunStatus = "warning"
	RunStatusFailed  RunStatus = "failed"
	RunStatusSkipped RunStatus = "skipped"
)

Values of RunStatus.

func (RunStatus) Known ¶

func (v RunStatus) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type ScanStage ¶

type ScanStage string

ScanStage is the "ScanStage" enum.

const (
	ScanStageComplete ScanStage = "complete"
	ScanStageError    ScanStage = "error"
)

Values of ScanStage.

func (ScanStage) Known ¶

func (v ScanStage) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type Scanner ¶

type Scanner string

Scanner is the "Scanner" enum.

const (
	ScannerNone  Scanner = "none"
	ScannerGrype Scanner = "grype"
	ScannerTrivy Scanner = "trivy"
	ScannerBoth  Scanner = "both"
)

Values of Scanner.

func (Scanner) Known ¶

func (v Scanner) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type ScheduleType ¶

type ScheduleType string

ScheduleType is the "ScheduleType" enum.

const (
	ScheduleTypeContainerUpdate    ScheduleType = "container_update"
	ScheduleTypeGitStackSync       ScheduleType = "git_stack_sync"
	ScheduleTypeSystemCleanup      ScheduleType = "system_cleanup"
	ScheduleTypeEnvUpdateCheck     ScheduleType = "env_update_check"
	ScheduleTypeImagePrune         ScheduleType = "image_prune"
	ScheduleTypeDeployLogReconcile ScheduleType = "deploy_log_reconcile"
	ScheduleTypeBackup             ScheduleType = "backup"
	ScheduleTypeRepoPrune          ScheduleType = "repo_prune"
	ScheduleTypeRepoCheck          ScheduleType = "repo_check"
	ScheduleTypeRepoVerify         ScheduleType = "repo_verify"
)

Values of ScheduleType.

func (ScheduleType) Known ¶

func (v ScheduleType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type SecretProviderID ¶

type SecretProviderID int

SecretProviderID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and SecretProviderID(n) convert one value, client.IDs a list.

type SecretProviderType ¶

type SecretProviderType string

SecretProviderType is the "SecretProviderType" enum.

const (
	SecretProviderTypeVault            SecretProviderType = "vault"
	SecretProviderTypeInfisical        SecretProviderType = "infisical"
	SecretProviderTypeDoppler          SecretProviderType = "doppler"
	SecretProviderTypeOpConnect        SecretProviderType = "op-connect"
	SecretProviderTypeOpServiceAccount SecretProviderType = "op-service-account"
	SecretProviderTypeAzureKv          SecretProviderType = "azure-kv"
	SecretProviderTypeBitwarden        SecretProviderType = "bitwarden"
	SecretProviderTypeKeepass          SecretProviderType = "keepass"
)

Values of SecretProviderType.

func (SecretProviderType) Known ¶

func (v SecretProviderType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type Severity ¶

type Severity string

Severity is the "Severity" enum.

const (
	SeverityCritical   Severity = "critical"
	SeverityHigh       Severity = "high"
	SeverityMedium     Severity = "medium"
	SeverityLow        Severity = "low"
	SeverityNegligible Severity = "negligible"
	SeverityUnknown    Severity = "unknown"
)

Values of Severity.

func (Severity) Known ¶

func (v Severity) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type SignInType ¶

type SignInType string

SignInType is the "SignInType" enum.

const (
	SignInTypeLocal SignInType = "local"
	SignInTypeOidc  SignInType = "oidc"
	SignInTypeLdap  SignInType = "ldap"
)

Values of SignInType.

func (SignInType) Known ¶

func (v SignInType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type StackSourceType ¶

type StackSourceType string

StackSourceType is the "StackSourceType" enum.

const (
	StackSourceTypeInternal StackSourceType = "internal"
	StackSourceTypeExternal StackSourceType = "external"
	StackSourceTypeGit      StackSourceType = "git"
)

Values of StackSourceType.

func (StackSourceType) Known ¶

func (v StackSourceType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type StackStatus ¶

type StackStatus string

StackStatus is the "StackStatus" enum.

const (
	StackStatusRunning StackStatus = "running"
	StackStatusPartial StackStatus = "partial"
	StackStatusStopped StackStatus = "stopped"
	StackStatusCreated StackStatus = "created"
)

Values of StackStatus.

func (StackStatus) Known ¶

func (v StackStatus) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type TagID ¶

type TagID int

TagID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and TagID(n) convert one value, client.IDs a list.

type TemplateSourceID ¶

type TemplateSourceID int

TemplateSourceID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and TemplateSourceID(n) convert one value, client.IDs a list.

type TemplateType ¶

type TemplateType string

TemplateType is the "TemplateType" enum.

const (
	TemplateTypeContainer TemplateType = "container"
	TemplateTypeStack     TemplateType = "stack"
)

Values of TemplateType.

func (TemplateType) Known ¶

func (v TemplateType) Known() bool

Known reports whether the value is one the document lists, or empty; a server may answer one it does not.

type Time ¶

type Time struct {
	time.Time
	// Unread is the text of a date no layout read, which is held as zero.
	Unread string
}

Time is a date and time as Dockhand API writes it: read from any of timeLayouts, written in the first, and left out of a body or a query when zero, which is what a null or an empty date reads as.

func (Time) As ¶

func (t Time) As(layout string) string

As is the date in the layout given, or in the first when none is: what a query carries for a parameter the service's own file picks a layout for (client.Service.SendDateAs).

func (Time) MarshalJSON ¶

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON writes the date in the first layout, or null when zero.

func (Time) String ¶

func (t Time) String() string

String is the date in the first layout, which is how a query carries it.

func (*Time) UnmarshalJSON ¶

func (t *Time) UnmarshalJSON(data []byte) error

UnmarshalJSON reads the date in any of the layouts; null and "" are zero.

func (Time) UnreadDate ¶

func (t Time) UnreadDate() string

UnreadDate is the text of a date no layout read, or "".

type UnixMilli ¶

type UnixMilli struct{ time.Time }

UnixMilli is a date and time Dockhand API writes as milliseconds since 1970: read from a number, or a string of digits, written as a number, and left out of a body or a query when zero, which is what null and 0 read as.

func (UnixMilli) MarshalJSON ¶

func (t UnixMilli) MarshalJSON() ([]byte, error)

MarshalJSON writes the date as milliseconds since 1970, or null when zero.

func (UnixMilli) String ¶

func (t UnixMilli) String() string

String is the date as milliseconds since 1970, which is how a query carries it.

func (*UnixMilli) UnmarshalJSON ¶

func (t *UnixMilli) UnmarshalJSON(data []byte) error

UnmarshalJSON reads a number of milliseconds since 1970; null and 0 are zero.

type UserID ¶

type UserID int

UserID is a kind of id the service tells apart, which the compiler keeps from every other kind; int(id) and UserID(n) convert one value, client.IDs a list.

Source Files ¶

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL