Documentation
¶
Overview ¶
Package common provides primitives to interact with the openapi HTTP API.
Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.7.0 DO NOT EDIT.
Index ¶
- type AnonKey
- type AuthConfig
- type AuthHostedPage
- type AuthHostedPageResponse
- type AuthSession
- type AuthSessionProvider
- type AuthTokenResponse
- type AuthUser
- type AuthUserStatus
- type BanUserResponse
- type BanUserResponseStatus
- type BatchFunctionDeployFailure
- type BatchFunctionDeployFailureOperation
- type BatchFunctionDeployResponse
- type CompleteUploadSessionResponse
- type CreateDatabaseRequest
- type CreateDatabaseRequestDatabaseType
- type CreateDatabaseRequestPgVersion
- type CreateDatabaseRequestRegion
- type CreateEmailTemplateRequest
- type CreateEmailTemplateRequestTemplateType
- type CreateFrontendCustomDomainRequest
- type CreateFunctionSchedulerRequest
- type CreateOAuthConfigRequest
- type CreateOAuthConfigRequestProvider
- type CreateProjectRequest
- type CreateStorageBucketRequest
- type CreateStoragePolicyRequest
- type CreateStoragePolicyRequestOperation
- type CreateUploadSessionRequest
- type CreateUploadSessionResponse
- type CreateVariableRequest
- type Database
- type DatabaseDatabaseType
- type DatabaseQueryPerformanceDatabase
- type DatabaseQueryPerformanceItem
- type DatabaseQueryPerformanceResponse
- type DatabaseStats
- type DatabaseStatsGranularity
- type DatabaseStatus
- type DeviceAuthorizationResponse
- type EmailTemplate
- type EmailTemplateTemplateType
- type Error
- type Frontend
- type FrontendCustomDomainResponse
- type FrontendCustomDomainResponseDomainStatus
- type FrontendCustomDomainResponseTlsMode
- type FrontendCustomDomainResponseVerificationStatus
- type FrontendCustomDomainStatus
- type FrontendCustomDomainTLSConfig
- type FrontendCustomDomainTLSConfigMode
- type FrontendDeployment
- type FrontendDeploymentOperation
- type FrontendDeploymentStatus
- type FrontendDomainRoutingRecord
- type FrontendDomainRoutingRecordRecordType
- type FrontendDomainVerificationRecord
- type FrontendFramework
- type FrontendStatus
- type FrontendUsageDailyEntry
- type FrontendUsageData
- type FrontendUsageHistoryResponse
- type Function
- type FunctionDeployment
- type FunctionDeploymentOperation
- type FunctionDeploymentStatus
- type FunctionInvocationRequest
- type FunctionInvocationResponse
- type FunctionRegion
- type FunctionRuntimeDeployment
- type FunctionRuntimeOption
- type FunctionRuntimesResponse
- type FunctionScheduler
- type FunctionSchedulerListResponse
- type FunctionSchedulerScheduleKind
- type FunctionStatus
- type HostedAuthPageType
- type HostedLoginEmailCheckRequest
- type HostedLoginEmailCheckResponse
- type HostedLoginOptionsResponse
- type HostedRenderablePageType
- type LiveLogLevel
- type LogActivityBucket
- type LogActivityRequest
- type LogActivityResponse
- type LogDatabaseRequestResource
- type LogDatabaseRequestResourceType
- type LogDeployment
- type LogDeploymentRequestSelector
- type LogDeploymentStage
- type LogEvent
- type LogFrontendRequestResource
- type LogFrontendRequestResourceType
- type LogFunctionRequestResource
- type LogFunctionRequestResourceType
- type LogRequestResource
- func (t LogRequestResource) AsLogDatabaseRequestResource() (LogDatabaseRequestResource, error)
- func (t LogRequestResource) AsLogFrontendRequestResource() (LogFrontendRequestResource, error)
- func (t LogRequestResource) AsLogFunctionRequestResource() (LogFunctionRequestResource, error)
- func (t LogRequestResource) Discriminator() (string, error)
- func (t *LogRequestResource) FromLogDatabaseRequestResource(v LogDatabaseRequestResource) error
- func (t *LogRequestResource) FromLogFrontendRequestResource(v LogFrontendRequestResource) error
- func (t *LogRequestResource) FromLogFunctionRequestResource(v LogFunctionRequestResource) error
- func (t LogRequestResource) MarshalJSON() ([]byte, error)
- func (t *LogRequestResource) MergeLogDatabaseRequestResource(v LogDatabaseRequestResource) error
- func (t *LogRequestResource) MergeLogFrontendRequestResource(v LogFrontendRequestResource) error
- func (t *LogRequestResource) MergeLogFunctionRequestResource(v LogFunctionRequestResource) error
- func (t *LogRequestResource) UnmarshalJSON(b []byte) error
- func (t LogRequestResource) ValueByDiscriminator() (interface{}, error)
- type LogResource
- type LogResourceType
- type LogSearchEvent
- type LogSearchRequest
- type LogSearchResponse
- type LogStreamRequest
- type MetricUsageData
- type OAuthConfig
- type OAuthConfigProvider
- type OAuthErrorResponse
- type PaginatedAuthUsers
- type PaginatedDatabases
- type PaginatedFrontendDeployments
- type PaginatedFrontends
- type PaginatedFunctionDeployments
- type PaginatedFunctions
- type PaginatedProjectCustomDomains
- type PaginatedProjectDeployments
- type PaginatedProjects
- type PaginatedProjectsStatus
- type PaginatedServiceKeys
- type PaginatedVariables
- type PlatformExchangeResponse
- type Project
- type ProjectConfig
- type ProjectConfigApplyResult
- type ProjectConfigApplyResultEntry
- type ProjectConfigApplyResultEntryAction
- type ProjectConfigApplySummary
- type ProjectConfigAuth
- type ProjectConfigAuthCORS
- type ProjectConfigAuthEmail
- type ProjectConfigAuthEmailFrom
- type ProjectConfigAuthEmailPasswordProvider
- type ProjectConfigAuthEmailSMTP
- type ProjectConfigAuthEmailVerification
- type ProjectConfigAuthManagedPages
- type ProjectConfigAuthPassword
- type ProjectConfigAuthPasswordReset
- type ProjectConfigAuthProviders
- type ProjectConfigAuthRateLimits
- type ProjectConfigAuthRedirects
- type ProjectConfigAuthSessions
- type ProjectConfigAuthSignup
- type ProjectConfigAuthTokens
- type ProjectConfigBucket
- type ProjectConfigBucketPolicy
- type ProjectConfigBucketPolicyOperation
- type ProjectConfigCustomDomain
- type ProjectConfigDatabase
- type ProjectConfigDatabaseDatabaseType
- type ProjectConfigDatabasePgVersion
- type ProjectConfigEmailTemplate
- type ProjectConfigEmailTemplates
- type ProjectConfigFrontend
- type ProjectConfigFunction
- type ProjectConfigHostedPage
- type ProjectConfigHostedPages
- type ProjectConfigMissingResource
- type ProjectConfigMissingResourceType
- type ProjectConfigOAuthProvider
- type ProjectConfigOAuthProviderProvider
- type ProjectConfigProject
- type ProjectConfigRealtime
- type ProjectConfigScheduler
- type ProjectConfigSkippedResource
- type ProjectConfigSkippedResourceType
- type ProjectConfigValidationError
- type ProjectConfigValidationErrorResponse
- type ProjectConfigVariable
- type ProjectConfigVersion
- type ProjectFrontendCustomDomain
- type ProjectFrontendCustomDomainDomainStatus
- type ProjectFrontendCustomDomainTlsMode
- type ProjectFrontendCustomDomainVerificationStatus
- type ProjectFrontendDeployment
- type ProjectFrontendDeploymentOperation
- type ProjectFrontendDeploymentStatus
- type ProjectHealthComponent
- type ProjectHealthComponentName
- type ProjectHealthCounts
- type ProjectHealthIssue
- type ProjectHealthIssueSeverity
- type ProjectHealthResource
- type ProjectHealthResourceType
- type ProjectHealthResponse
- type ProjectHealthStatus
- type ProjectPlan
- type ProjectStatus
- type ProjectUsageResponse
- type RealtimeConfig
- type RealtimePlanLimits
- type RealtimeStats
- type ResolveFunctionResponse
- type ScheduleRequest
- type ScheduleRequestKind
- type ServiceKey
- type StorageBucket
- type StorageCopyRequest
- type StorageListResponse
- type StorageMoveRequest
- type StorageObject
- type StorageObjectWithBucket
- type StoragePolicy
- type StoragePolicyOperation
- type StorageStats
- type StorageVisibilityRequest
- type TestEmailRequest
- type TestEmailResponse
- type UnbanUserResponse
- type UnbanUserResponseStatus
- type UpdateAuthConfigRequest
- type UpdateAuthHostedPageRequest
- type UpdateDatabaseTypeRequest
- type UpdateDatabaseTypeRequestDatabaseType
- type UpdateEmailTemplateRequest
- type UpdateFunctionRequest
- type UpdateFunctionSchedulerRequest
- type UpdateOAuthConfigRequest
- type UpdateProjectRequest
- type UpdateRealtimeConfigRequest
- type UpdateStorageBucketRequest
- type UpdateVariableRequest
- type UploadSessionPart
- type UploadSessionStatusResponse
- type UploadSessionStatusResponseStatus
- type UsageDataPoint
- type Variable
- type VariableStatus
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AnonKey ¶
type AnonKey struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
Id openapi_types.UUID `json:"id"`
// IsDefault Whether this is the project's configured default anon key. Only one key per project can be default.
IsDefault *bool `json:"is_default,omitempty"`
// KeyValue JWT token - use this in frontend Authorization header
KeyValue string `json:"key_value"`
Name string `json:"name"`
// Permissions Permissions granted to this anon key.
// Auth permissions: auth.signup, auth.signin, auth.refresh, auth.logout, auth.password_reset, auth.confirm_email, auth.resend_confirmation
// Storage permissions: storage.upload, storage.download, storage.list, storage.delete
// Realtime permissions: realtime.connect, realtime.subscribe, realtime.publish
// Functions permissions: functions.invoke
Permissions *[]string `json:"permissions,omitempty"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
}
AnonKey defines model for AnonKey.
type AuthConfig ¶
type AuthConfig struct {
// AccessTokenLifetime Access token lifetime in seconds
AccessTokenLifetime *int `json:"access_token_lifetime,omitempty"`
// AllowPasswordReset Enable forgot password flow
AllowPasswordReset *bool `json:"allow_password_reset,omitempty"`
// AllowedRedirectUrls Redirect allowlist used to validate post_auth_redirect_url and post_logout_redirect_url.
AllowedRedirectUrls *[]string `json:"allowed_redirect_urls,omitempty"`
// CorsAllowCredentials Allow credentials in CORS requests
CorsAllowCredentials *bool `json:"cors_allow_credentials,omitempty"`
CorsAllowedOrigins *[]string `json:"cors_allowed_origins,omitempty"`
CorsEnabled *bool `json:"cors_enabled,omitempty"`
// CorsMaxAge CORS preflight cache duration (seconds)
CorsMaxAge *int `json:"cors_max_age,omitempty"`
// DeviceVerificationUrl Optional override for the device-authorization verification page.
// When set, POST /auth/device/authorize returns this URL (with the
// user_code) as verification_uri/verification_uri_complete instead of
// the built-in managed device page. Lets a CLI surface the project's
// own RFC 8628 approval page. Empty falls back to the managed page.
DeviceVerificationUrl *string `json:"device_verification_url,omitempty"`
EmailConfirmationSubject *string `json:"email_confirmation_subject,omitempty"`
// EmailEnabled Enable transactional email sending (confirmation, reset, change notifications). Must be true when require_email_confirmation is true.
EmailEnabled *bool `json:"email_enabled,omitempty"`
EmailFromAddress *string `json:"email_from_address,omitempty"`
EmailFromName *string `json:"email_from_name,omitempty"`
EmailPasswordChangedSubject *string `json:"email_password_changed_subject,omitempty"`
EmailPasswordResetSubject *string `json:"email_password_reset_subject,omitempty"`
// EnableAnonymousSignins Allow creating users without email/password
EnableAnonymousSignins *bool `json:"enable_anonymous_signins,omitempty"`
// EnableEmailPassword Enable email/password authentication as a provider
EnableEmailPassword *bool `json:"enable_email_password,omitempty"`
// EnableSignup Master switch - allow new user signups via ANY provider
EnableSignup *bool `json:"enable_signup,omitempty"`
// InactivityTimeout Force re-login after inactivity (seconds, 0=never)
InactivityTimeout *int `json:"inactivity_timeout,omitempty"`
// ManagedAuthEnabled Enables project-hosted managed auth pages.
ManagedAuthEnabled *bool `json:"managed_auth_enabled,omitempty"`
// MaxPasswordHistory Number of previous passwords to remember (0=disabled)
MaxPasswordHistory *int `json:"max_password_history,omitempty"`
// MaxSessionDuration Force re-login after duration (seconds, 0=never)
MaxSessionDuration *int `json:"max_session_duration,omitempty"`
MinPasswordLength *int `json:"min_password_length,omitempty"`
// PasswordResetTimeout Recovery token expiry in seconds
PasswordResetTimeout *int `json:"password_reset_timeout,omitempty"`
// PlatformTokenTtl TTL in seconds for platform tokens minted via `/auth/platform/exchange`
PlatformTokenTtl *int `json:"platform_token_ttl,omitempty"`
// PostAuthRedirectUrl Default redirect target after successful hosted auth.
PostAuthRedirectUrl *string `json:"post_auth_redirect_url,omitempty"`
// PostLogoutRedirectUrl Redirect target after logout from hosted pages.
PostLogoutRedirectUrl *string `json:"post_logout_redirect_url,omitempty"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
// RateLimitSignin Signins per hour per IP
RateLimitSignin *int `json:"rate_limit_signin,omitempty"`
// RateLimitSignup Signups per hour per IP
RateLimitSignup *int `json:"rate_limit_signup,omitempty"`
// RateLimitTokenRefresh Refreshes per hour per IP
RateLimitTokenRefresh *int `json:"rate_limit_token_refresh,omitempty"`
// RefreshTokenLifetime Refresh token lifetime in seconds
RefreshTokenLifetime *int `json:"refresh_token_lifetime,omitempty"`
RequireLowercase *bool `json:"require_lowercase,omitempty"`
RequireNumbers *bool `json:"require_numbers,omitempty"`
RequireSpecialChars *bool `json:"require_special_chars,omitempty"`
RequireUppercase *bool `json:"require_uppercase,omitempty"`
SmtpHost *string `json:"smtp_host,omitempty"`
// SmtpPassword SMTP password. Stored encrypted at rest (AES-256-GCM); returned decrypted only to the authenticated project owner.
SmtpPassword *string `json:"smtp_password,omitempty"`
SmtpPort *int `json:"smtp_port,omitempty"`
SmtpUseTls *bool `json:"smtp_use_tls,omitempty"`
SmtpUsername *string `json:"smtp_username,omitempty"`
}
AuthConfig defines model for AuthConfig.
type AuthHostedPage ¶
type AuthHostedPage struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
// Css CSS content for this page type.
Css *string `json:"css,omitempty"`
// Html HTML content for this page type.
Html *string `json:"html,omitempty"`
Id *openapi_types.UUID `json:"id,omitempty"`
PageType *HostedAuthPageType `json:"page_type,omitempty"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
AuthHostedPage defines model for AuthHostedPage.
type AuthHostedPageResponse ¶
type AuthHostedPageResponse struct {
Page *AuthHostedPage `json:"page,omitempty"`
}
AuthHostedPageResponse defines model for AuthHostedPageResponse.
type AuthSession ¶
type AuthSession struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
// ExpiresAt When this session expires
ExpiresAt time.Time `json:"expires_at"`
// Id Unique session identifier
Id openapi_types.UUID `json:"id"`
// IpAddress IP address of the client when the session was created
IpAddress *string `json:"ip_address,omitempty"`
// IsActive Whether the session is currently active (not expired)
IsActive *bool `json:"is_active,omitempty"`
// IsCurrent Whether this is the session making the current request
IsCurrent *bool `json:"is_current,omitempty"`
// LastActivityAt Last activity timestamp
LastActivityAt *time.Time `json:"last_activity_at,omitempty"`
// LastIpAddress IP address of the most recent activity (token refresh)
LastIpAddress *string `json:"last_ip_address,omitempty"`
// Provider Authentication provider used to create this session
Provider AuthSessionProvider `json:"provider"`
// SessionStartedAt When the session was created
SessionStartedAt *time.Time `json:"session_started_at,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
// UserAgent Browser/device user agent string
UserAgent *string `json:"user_agent,omitempty"`
// UserId The user this session belongs to
UserId openapi_types.UUID `json:"user_id"`
}
AuthSession An authentication session for a user
type AuthSessionProvider ¶
type AuthSessionProvider string
AuthSessionProvider Authentication provider used to create this session
const ( AuthSessionProviderAnonymous AuthSessionProvider = "anonymous" AuthSessionProviderApple AuthSessionProvider = "apple" AuthSessionProviderEmail AuthSessionProvider = "email" AuthSessionProviderGithub AuthSessionProvider = "github" AuthSessionProviderGoogle AuthSessionProvider = "google" AuthSessionProviderMicrosoft AuthSessionProvider = "microsoft" )
Defines values for AuthSessionProvider.
func (AuthSessionProvider) Valid ¶
func (e AuthSessionProvider) Valid() bool
Valid indicates whether the value is a known member of the AuthSessionProvider enum.
type AuthTokenResponse ¶
type AuthTokenResponse struct {
// AccessToken JWT access token (expires after configured lifetime)
AccessToken string `json:"access_token"`
// ExpiresIn Access token lifetime in seconds
ExpiresIn int `json:"expires_in"`
// RefreshToken Long-lived token for getting new access tokens
RefreshToken string `json:"refresh_token"`
TokenType string `json:"token_type"`
User AuthUser `json:"user"`
}
AuthTokenResponse defines model for AuthTokenResponse.
type AuthUser ¶
type AuthUser struct {
// AppMetadata Application-controlled metadata (read-only for users)
AppMetadata *map[string]interface{} `json:"app_metadata,omitempty"`
// AvatarUrl User avatar URL (from OAuth provider or manually set)
AvatarUrl *string `json:"avatar_url,omitempty"`
// BannedUntil When temporary ban expires (null if not banned or permanent)
BannedUntil *time.Time `json:"banned_until,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Email openapi_types.Email `json:"email"`
EmailConfirmed *bool `json:"email_confirmed,omitempty"`
Id openapi_types.UUID `json:"id"`
LastSignInAt *time.Time `json:"last_sign_in_at,omitempty"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
Status AuthUserStatus `json:"status"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
// UserMetadata User-editable metadata
UserMetadata *map[string]interface{} `json:"user_metadata,omitempty"`
}
AuthUser defines model for AuthUser.
type AuthUserStatus ¶
type AuthUserStatus string
AuthUserStatus defines model for AuthUser.Status.
const ( AuthUserStatusActive AuthUserStatus = "active" AuthUserStatusBanned AuthUserStatus = "banned" AuthUserStatusDeleted AuthUserStatus = "deleted" )
Defines values for AuthUserStatus.
func (AuthUserStatus) Valid ¶
func (e AuthUserStatus) Valid() bool
Valid indicates whether the value is a known member of the AuthUserStatus enum.
type BanUserResponse ¶
type BanUserResponse struct {
// BannedUntil When the ban expires (null for permanent ban)
BannedUntil *time.Time `json:"banned_until,omitempty"`
Email openapi_types.Email `json:"email"`
Message string `json:"message"`
Status BanUserResponseStatus `json:"status"`
UserId openapi_types.UUID `json:"user_id"`
}
BanUserResponse Response when banning a user
type BanUserResponseStatus ¶
type BanUserResponseStatus string
BanUserResponseStatus defines model for BanUserResponse.Status.
const (
BanUserResponseStatusBanned BanUserResponseStatus = "banned"
)
Defines values for BanUserResponseStatus.
func (BanUserResponseStatus) Valid ¶
func (e BanUserResponseStatus) Valid() bool
Valid indicates whether the value is a known member of the BanUserResponseStatus enum.
type BatchFunctionDeployFailure ¶
type BatchFunctionDeployFailure struct {
Error string `json:"error"`
FunctionId *openapi_types.UUID `json:"function_id,omitempty"`
Name string `json:"name"`
Operation *BatchFunctionDeployFailureOperation `json:"operation,omitempty"`
}
BatchFunctionDeployFailure defines model for BatchFunctionDeployFailure.
type BatchFunctionDeployFailureOperation ¶
type BatchFunctionDeployFailureOperation string
BatchFunctionDeployFailureOperation defines model for BatchFunctionDeployFailure.Operation.
const ( BatchFunctionDeployFailureOperationDeploy BatchFunctionDeployFailureOperation = "deploy" BatchFunctionDeployFailureOperationUpdate BatchFunctionDeployFailureOperation = "update" )
Defines values for BatchFunctionDeployFailureOperation.
func (BatchFunctionDeployFailureOperation) Valid ¶
func (e BatchFunctionDeployFailureOperation) Valid() bool
Valid indicates whether the value is a known member of the BatchFunctionDeployFailureOperation enum.
type BatchFunctionDeployResponse ¶
type BatchFunctionDeployResponse struct {
BatchId openapi_types.UUID `json:"batch_id"`
// Data Functions whose deployment workflows were started successfully
Data []Function `json:"data"`
// Failed Functions that failed before their workflow started. Successful functions are left running; failed new functions are deleted and failed updates are rolled back where possible.
Failed *[]BatchFunctionDeployFailure `json:"failed,omitempty"`
}
BatchFunctionDeployResponse defines model for BatchFunctionDeployResponse.
type CompleteUploadSessionResponse ¶
type CompleteUploadSessionResponse struct {
Object *StorageObject `json:"object,omitempty"`
}
CompleteUploadSessionResponse Response when completing an upload
type CreateDatabaseRequest ¶
type CreateDatabaseRequest struct {
// DatabaseType Compute size tier (optional, defaults to volcano-db-xs).
// Determines autoscaling limits for the database.
DatabaseType *CreateDatabaseRequestDatabaseType `json:"database_type,omitempty"`
// Name Database name (must be unique within project)
Name string `json:"name"`
// PgVersion PostgreSQL major version
PgVersion CreateDatabaseRequestPgVersion `json:"pg_version"`
// Region AWS region for database hosting
Region CreateDatabaseRequestRegion `json:"region"`
}
CreateDatabaseRequest Create a new PostgreSQL database. Volcano automatically sets up: - Auth helpers (auth.uid(), auth.email(), auth.role()) - Database roles (anon for unauthenticated, authenticated for signed-in users) - Secure multi-tenant isolation - Ready for Row-Level Security
type CreateDatabaseRequestDatabaseType ¶
type CreateDatabaseRequestDatabaseType string
CreateDatabaseRequestDatabaseType Compute size tier (optional, defaults to volcano-db-xs). Determines autoscaling limits for the database.
const ( CreateDatabaseRequestDatabaseTypeVolcanoDb2xl CreateDatabaseRequestDatabaseType = "volcano-db-2xl" CreateDatabaseRequestDatabaseTypeVolcanoDbL CreateDatabaseRequestDatabaseType = "volcano-db-l" CreateDatabaseRequestDatabaseTypeVolcanoDbM CreateDatabaseRequestDatabaseType = "volcano-db-m" CreateDatabaseRequestDatabaseTypeVolcanoDbS CreateDatabaseRequestDatabaseType = "volcano-db-s" CreateDatabaseRequestDatabaseTypeVolcanoDbXl CreateDatabaseRequestDatabaseType = "volcano-db-xl" CreateDatabaseRequestDatabaseTypeVolcanoDbXs CreateDatabaseRequestDatabaseType = "volcano-db-xs" )
Defines values for CreateDatabaseRequestDatabaseType.
func (CreateDatabaseRequestDatabaseType) Valid ¶
func (e CreateDatabaseRequestDatabaseType) Valid() bool
Valid indicates whether the value is a known member of the CreateDatabaseRequestDatabaseType enum.
type CreateDatabaseRequestPgVersion ¶
type CreateDatabaseRequestPgVersion string
CreateDatabaseRequestPgVersion PostgreSQL major version
const ( CreateDatabaseRequestPgVersionN15 CreateDatabaseRequestPgVersion = "15" CreateDatabaseRequestPgVersionN16 CreateDatabaseRequestPgVersion = "16" )
Defines values for CreateDatabaseRequestPgVersion.
func (CreateDatabaseRequestPgVersion) Valid ¶
func (e CreateDatabaseRequestPgVersion) Valid() bool
Valid indicates whether the value is a known member of the CreateDatabaseRequestPgVersion enum.
type CreateDatabaseRequestRegion ¶
type CreateDatabaseRequestRegion string
CreateDatabaseRequestRegion AWS region for database hosting
const ( AwsApSoutheast1 CreateDatabaseRequestRegion = "aws-ap-southeast-1" AwsApSoutheast2 CreateDatabaseRequestRegion = "aws-ap-southeast-2" AwsEuCentral1 CreateDatabaseRequestRegion = "aws-eu-central-1" AwsEuWest2 CreateDatabaseRequestRegion = "aws-eu-west-2" AwsSaEast1 CreateDatabaseRequestRegion = "aws-sa-east-1" AwsUsEast1 CreateDatabaseRequestRegion = "aws-us-east-1" AwsUsEast2 CreateDatabaseRequestRegion = "aws-us-east-2" AwsUsWest2 CreateDatabaseRequestRegion = "aws-us-west-2" )
Defines values for CreateDatabaseRequestRegion.
func (CreateDatabaseRequestRegion) Valid ¶
func (e CreateDatabaseRequestRegion) Valid() bool
Valid indicates whether the value is a known member of the CreateDatabaseRequestRegion enum.
type CreateEmailTemplateRequest ¶
type CreateEmailTemplateRequest struct {
// HtmlBody HTML template body. Available placeholders:
// - {{.Token}} - The confirmation/reset token
// - {{.ProjectName}} - The project name
// - {{.Email}} - User's email address
HtmlBody string `json:"html_body"`
// Subject Email subject line
Subject string `json:"subject"`
// TemplateType Type of email template
TemplateType CreateEmailTemplateRequestTemplateType `json:"template_type"`
// TextBody Plain text template body (same placeholders as HTML)
TextBody string `json:"text_body"`
}
CreateEmailTemplateRequest defines model for CreateEmailTemplateRequest.
type CreateEmailTemplateRequestTemplateType ¶
type CreateEmailTemplateRequestTemplateType string
CreateEmailTemplateRequestTemplateType Type of email template
const ( CreateEmailTemplateRequestTemplateTypeConfirmation CreateEmailTemplateRequestTemplateType = "confirmation" CreateEmailTemplateRequestTemplateTypePasswordChanged CreateEmailTemplateRequestTemplateType = "password_changed" CreateEmailTemplateRequestTemplateTypePasswordReset CreateEmailTemplateRequestTemplateType = "password_reset" CreateEmailTemplateRequestTemplateTypeWelcome CreateEmailTemplateRequestTemplateType = "welcome" )
Defines values for CreateEmailTemplateRequestTemplateType.
func (CreateEmailTemplateRequestTemplateType) Valid ¶
func (e CreateEmailTemplateRequestTemplateType) Valid() bool
Valid indicates whether the value is a known member of the CreateEmailTemplateRequestTemplateType enum.
type CreateFrontendCustomDomainRequest ¶
type CreateFrontendCustomDomainRequest struct {
// Domain Fully-qualified domain name (hostname only, no scheme/path)
Domain string `json:"domain"`
Tls FrontendCustomDomainTLSConfig `json:"tls"`
}
CreateFrontendCustomDomainRequest defines model for CreateFrontendCustomDomainRequest.
type CreateFunctionSchedulerRequest ¶
type CreateFunctionSchedulerRequest struct {
Enabled *bool `json:"enabled,omitempty"`
Name string `json:"name"`
Payload *map[string]interface{} `json:"payload,omitempty"`
// Regions Optional single explicit deployed region. If omitted, the scheduler chooses one deployed region and invokes according to the cron expression.
Regions *[]string `json:"regions,omitempty"`
Schedule ScheduleRequest `json:"schedule"`
}
CreateFunctionSchedulerRequest defines model for CreateFunctionSchedulerRequest.
type CreateOAuthConfigRequest ¶
type CreateOAuthConfigRequest struct {
// ClientId Required for non-device providers. Must not be provided for `provider=device`; server always auto-generates it.
ClientId *string `json:"client_id,omitempty"`
// ClientSecret Required for non-device providers. Must not be provided for `provider=device`; server always auto-generates it.
ClientSecret *string `json:"client_secret,omitempty"`
Provider CreateOAuthConfigRequestProvider `json:"provider"`
// RedirectUrl Required for non-device providers. Not used for `provider=device`.
RedirectUrl *string `json:"redirect_url,omitempty"`
// Scopes Optional for non-device providers, uses provider defaults if omitted. Not used for `provider=device`.
Scopes *[]string `json:"scopes,omitempty"`
}
CreateOAuthConfigRequest defines model for CreateOAuthConfigRequest.
type CreateOAuthConfigRequestProvider ¶
type CreateOAuthConfigRequestProvider string
CreateOAuthConfigRequestProvider defines model for CreateOAuthConfigRequest.Provider.
const ( CreateOAuthConfigRequestProviderApple CreateOAuthConfigRequestProvider = "apple" CreateOAuthConfigRequestProviderDevice CreateOAuthConfigRequestProvider = "device" CreateOAuthConfigRequestProviderGithub CreateOAuthConfigRequestProvider = "github" CreateOAuthConfigRequestProviderGoogle CreateOAuthConfigRequestProvider = "google" CreateOAuthConfigRequestProviderMicrosoft CreateOAuthConfigRequestProvider = "microsoft" )
Defines values for CreateOAuthConfigRequestProvider.
func (CreateOAuthConfigRequestProvider) Valid ¶
func (e CreateOAuthConfigRequestProvider) Valid() bool
Valid indicates whether the value is a known member of the CreateOAuthConfigRequestProvider enum.
type CreateProjectRequest ¶
type CreateProjectRequest struct {
// AllRegions Optional region policy.
// - `true` (default): project functions deploy to all configured regions
// - `false`: project deploys only to `selected_regions`
AllRegions *bool `json:"all_regions,omitempty"`
// Name Project name (must be unique).
// Can only contain letters, numbers, underscores, and hyphens.
Name string `json:"name"`
// SelectedRegions Optional region subset. Requires `all_regions=false`.
// Region names must be a subset of platform `AWS_REGIONS`.
SelectedRegions *[]string `json:"selected_regions,omitempty"`
}
CreateProjectRequest Request to create a new project
type CreateStorageBucketRequest ¶
type CreateStorageBucketRequest struct {
// AllowedMimeTypes Allowed MIME types (e.g., ["image/png", "image/jpeg"])
AllowedMimeTypes *[]string `json:"allowed_mime_types,omitempty"`
// FileSizeLimit Maximum file size in bytes
FileSizeLimit *int64 `json:"file_size_limit,omitempty"`
// Name Bucket name (alphanumeric, dashes, underscores)
Name string `json:"name"`
}
CreateStorageBucketRequest defines model for CreateStorageBucketRequest.
type CreateStoragePolicyRequest ¶
type CreateStoragePolicyRequest struct {
// Definition Policy expression
Definition string `json:"definition"`
// Name Policy name
Name string `json:"name"`
// Operation Operation this policy applies to
Operation CreateStoragePolicyRequestOperation `json:"operation"`
}
CreateStoragePolicyRequest defines model for CreateStoragePolicyRequest.
type CreateStoragePolicyRequestOperation ¶
type CreateStoragePolicyRequestOperation string
CreateStoragePolicyRequestOperation Operation this policy applies to
const ( CreateStoragePolicyRequestOperationDELETE CreateStoragePolicyRequestOperation = "DELETE" CreateStoragePolicyRequestOperationINSERT CreateStoragePolicyRequestOperation = "INSERT" CreateStoragePolicyRequestOperationSELECT CreateStoragePolicyRequestOperation = "SELECT" CreateStoragePolicyRequestOperationUPDATE CreateStoragePolicyRequestOperation = "UPDATE" )
Defines values for CreateStoragePolicyRequestOperation.
func (CreateStoragePolicyRequestOperation) Valid ¶
func (e CreateStoragePolicyRequestOperation) Valid() bool
Valid indicates whether the value is a known member of the CreateStoragePolicyRequestOperation enum.
type CreateUploadSessionRequest ¶
type CreateUploadSessionRequest struct {
// ContentType MIME type of the file
ContentType string `json:"content_type"`
// ObjectPath Target file path within the bucket
ObjectPath string `json:"object_path"`
// PartSize Part size in bytes (default: 25MB, min: 5MB, max: 25MB)
PartSize *int64 `json:"part_size,omitempty"`
// TotalSize Total file size in bytes (max 5TB)
TotalSize int64 `json:"total_size"`
}
CreateUploadSessionRequest Request to create a resumable upload session
type CreateUploadSessionResponse ¶
type CreateUploadSessionResponse struct {
// ExpiresAt When the session expires (7 days from creation)
ExpiresAt *time.Time `json:"expires_at,omitempty"`
// PartSize Actual part size to use
PartSize *int64 `json:"part_size,omitempty"`
// SessionId Upload session ID
SessionId *string `json:"session_id,omitempty"`
// TotalParts Number of parts to upload
TotalParts *int `json:"total_parts,omitempty"`
}
CreateUploadSessionResponse Response when creating an upload session
type CreateVariableRequest ¶
CreateVariableRequest defines model for CreateVariableRequest.
type Database ¶
type Database struct {
// ConnectionString Secure PostgreSQL connection URI for your database.
//
// The database is identified by the globally-unique username
// (`volcano_client_{database_id}`) already in this URI; the
// `application_name` parameter only selects the access mode:
// - `volcano_full_access` — Full admin access (DDL, migrations)
// - `volcano_user_access:{user_id}` — User impersonation (RLS enforced)
// - `volcano_user_access` — Anonymous access (anon role, RLS enforced)
ConnectionString *string `json:"connection_string,omitempty"`
CreatedAt time.Time `json:"created_at"`
// DatabaseType Database size tier that determines available RAM and scaling limits.
DatabaseType *DatabaseDatabaseType `json:"database_type,omitempty"`
Id openapi_types.UUID `json:"id"`
// LastInvokedAt Most recent request timestamp for this database
LastInvokedAt *time.Time `json:"last_invoked_at,omitempty"`
// Name Database name
Name string `json:"name"`
// PgVersion PostgreSQL major version
PgVersion *string `json:"pg_version,omitempty"`
ProjectId openapi_types.UUID `json:"project_id"`
// ProvisioningStartedAt Timestamp when the current provisioning phase started
ProvisioningStartedAt *time.Time `json:"provisioning_started_at,omitempty"`
// Region AWS region where database is hosted
Region *string `json:"region,omitempty"`
// Status Database provisioning status
Status DatabaseStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
Database PostgreSQL database with automatic scalability and security features.
type DatabaseDatabaseType ¶
type DatabaseDatabaseType string
DatabaseDatabaseType Database size tier that determines available RAM and scaling limits.
const ( DatabaseDatabaseTypeVolcanoDb2xl DatabaseDatabaseType = "volcano-db-2xl" DatabaseDatabaseTypeVolcanoDbL DatabaseDatabaseType = "volcano-db-l" DatabaseDatabaseTypeVolcanoDbM DatabaseDatabaseType = "volcano-db-m" DatabaseDatabaseTypeVolcanoDbS DatabaseDatabaseType = "volcano-db-s" DatabaseDatabaseTypeVolcanoDbXl DatabaseDatabaseType = "volcano-db-xl" DatabaseDatabaseTypeVolcanoDbXs DatabaseDatabaseType = "volcano-db-xs" )
Defines values for DatabaseDatabaseType.
func (DatabaseDatabaseType) Valid ¶
func (e DatabaseDatabaseType) Valid() bool
Valid indicates whether the value is a known member of the DatabaseDatabaseType enum.
type DatabaseQueryPerformanceDatabase ¶ added in v0.0.5
type DatabaseQueryPerformanceDatabase struct {
Id openapi_types.UUID `json:"id"`
Name string `json:"name"`
}
DatabaseQueryPerformanceDatabase defines model for DatabaseQueryPerformanceDatabase.
type DatabaseQueryPerformanceItem ¶ added in v0.0.5
type DatabaseQueryPerformanceItem struct {
Calls int64 `json:"calls"`
Database DatabaseQueryPerformanceDatabase `json:"database"`
MaxExecTimeSeconds float64 `json:"max_exec_time_seconds"`
MeanExecTimeSeconds float64 `json:"mean_exec_time_seconds"`
MinExecTimeSeconds float64 `json:"min_exec_time_seconds"`
// Query Normalized and obfuscated representative query text.
Query string `json:"query"`
// QueryId pg_stat_statements query identifier.
QueryId string `json:"query_id"`
// Role Database role used for the query.
Role string `json:"role"`
RowsProcessed int64 `json:"rows_processed"`
// TotalExecTimeSeconds Cumulative total execution time from pg_stat_statements in seconds.
TotalExecTimeSeconds float64 `json:"total_exec_time_seconds"`
}
DatabaseQueryPerformanceItem defines model for DatabaseQueryPerformanceItem.
type DatabaseQueryPerformanceResponse ¶ added in v0.0.5
type DatabaseQueryPerformanceResponse struct {
Data []DatabaseQueryPerformanceItem `json:"data"`
}
DatabaseQueryPerformanceResponse defines model for DatabaseQueryPerformanceResponse.
type DatabaseStats ¶
type DatabaseStats struct {
// ActiveTimeSeconds Total active compute time in seconds
ActiveTimeSeconds float64 `json:"active_time_seconds"`
// ComputeTimeSeconds Total CPU seconds consumed
ComputeTimeSeconds float64 `json:"compute_time_seconds"`
// DataTransferBytes Total data transferred in bytes
DataTransferBytes int64 `json:"data_transfer_bytes"`
// DataWrittenBytes Total data written in bytes
DataWrittenBytes int64 `json:"data_written_bytes"`
// Granularity Granularity of the aggregated metrics
Granularity *DatabaseStatsGranularity `json:"granularity,omitempty"`
// StorageBytes Total storage used in bytes (data + WAL)
StorageBytes int64 `json:"storage_bytes"`
// TimeRange Time range of the metrics (e.g., "2024-01-01T00:00:00Z to 2024-01-02T00:00:00Z")
TimeRange *string `json:"time_range,omitempty"`
}
DatabaseStats defines model for DatabaseStats.
type DatabaseStatsGranularity ¶
type DatabaseStatsGranularity string
DatabaseStatsGranularity Granularity of the aggregated metrics
const ( Daily DatabaseStatsGranularity = "daily" Hourly DatabaseStatsGranularity = "hourly" Monthly DatabaseStatsGranularity = "monthly" )
Defines values for DatabaseStatsGranularity.
func (DatabaseStatsGranularity) Valid ¶
func (e DatabaseStatsGranularity) Valid() bool
Valid indicates whether the value is a known member of the DatabaseStatsGranularity enum.
type DatabaseStatus ¶
type DatabaseStatus string
DatabaseStatus Database provisioning status
const ( DatabaseStatusActive DatabaseStatus = "active" DatabaseStatusDeleting DatabaseStatus = "deleting" DatabaseStatusFailed DatabaseStatus = "failed" DatabaseStatusProvisioning DatabaseStatus = "provisioning" )
Defines values for DatabaseStatus.
func (DatabaseStatus) Valid ¶
func (e DatabaseStatus) Valid() bool
Valid indicates whether the value is a known member of the DatabaseStatus enum.
type DeviceAuthorizationResponse ¶
type DeviceAuthorizationResponse struct {
DeviceCode string `json:"device_code"`
ExpiresIn int `json:"expires_in"`
Interval int `json:"interval"`
UserCode string `json:"user_code"`
// VerificationUri Browser verification URL. Points at the project's managed device
// approval page served by this API:
// `/projects/{projectId}/auth/hosted?action=device&anon_key=...`.
// Requires the project to have managed auth enabled and a default anon
// key. A custom CLI may ignore this and direct users to its own
// RFC 8628-compatible page instead (see the device-auth guide).
VerificationUri string `json:"verification_uri"`
// VerificationUriComplete Same as `verification_uri` but with the `user_code` prefilled
// (`&user_code=...`). This is the URL most device clients open.
VerificationUriComplete string `json:"verification_uri_complete"`
}
DeviceAuthorizationResponse defines model for DeviceAuthorizationResponse.
type EmailTemplate ¶
type EmailTemplate struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
// HtmlBody HTML template with placeholders
HtmlBody string `json:"html_body"`
Id *openapi_types.UUID `json:"id,omitempty"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
Subject string `json:"subject"`
TemplateType EmailTemplateTemplateType `json:"template_type"`
// TextBody Plain text template with placeholders
TextBody string `json:"text_body"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
EmailTemplate Custom email template
type EmailTemplateTemplateType ¶
type EmailTemplateTemplateType string
EmailTemplateTemplateType defines model for EmailTemplate.TemplateType.
const ( EmailTemplateTemplateTypeConfirmation EmailTemplateTemplateType = "confirmation" EmailTemplateTemplateTypePasswordChanged EmailTemplateTemplateType = "password_changed" EmailTemplateTemplateTypePasswordReset EmailTemplateTemplateType = "password_reset" EmailTemplateTemplateTypeWelcome EmailTemplateTemplateType = "welcome" )
Defines values for EmailTemplateTemplateType.
func (EmailTemplateTemplateType) Valid ¶
func (e EmailTemplateTemplateType) Valid() bool
Valid indicates whether the value is a known member of the EmailTemplateTemplateType enum.
type Frontend ¶
type Frontend struct {
// AppRoot Optional relative POSIX path from the uploaded archive root to the Next.js app that is deployed.
AppRoot *string `json:"app_root,omitempty"`
CreatedAt time.Time `json:"created_at"`
// CurrentDeploymentId Identifier of the latest frontend deployment operation
CurrentDeploymentId *openapi_types.UUID `json:"current_deployment_id,omitempty"`
// CustomDomain Active custom domain hostname when configured
CustomDomain *string `json:"custom_domain,omitempty"`
// CustomDomainStatus Current custom domain lifecycle status
CustomDomainStatus *FrontendCustomDomainStatus `json:"custom_domain_status,omitempty"`
DeployedRegions []string `json:"deployed_regions"`
Framework FrontendFramework `json:"framework"`
Id openapi_types.UUID `json:"id"`
LastInvokedAt *time.Time `json:"last_invoked_at,omitempty"`
Name string `json:"name"`
ProjectId openapi_types.UUID `json:"project_id"`
// ProvisioningStartedAt Timestamp when the current provisioning phase started
ProvisioningStartedAt *time.Time `json:"provisioning_started_at,omitempty"`
SiteUrl *string `json:"site_url,omitempty"`
Status FrontendStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
Frontend defines model for Frontend.
type FrontendCustomDomainResponse ¶
type FrontendCustomDomainResponse struct {
CreatedAt time.Time `json:"created_at"`
Domain string `json:"domain"`
DomainStatus FrontendCustomDomainResponseDomainStatus `json:"domain_status"`
EffectiveUrls []string `json:"effective_urls"`
RequiredRoutingRecord *FrontendDomainRoutingRecord `json:"required_routing_record,omitempty"`
TlsMode FrontendCustomDomainResponseTlsMode `json:"tls_mode"`
UpdatedAt time.Time `json:"updated_at"`
VerificationRecords *[]FrontendDomainVerificationRecord `json:"verification_records,omitempty"`
VerificationStatus FrontendCustomDomainResponseVerificationStatus `json:"verification_status"`
}
FrontendCustomDomainResponse defines model for FrontendCustomDomainResponse.
type FrontendCustomDomainResponseDomainStatus ¶
type FrontendCustomDomainResponseDomainStatus string
FrontendCustomDomainResponseDomainStatus defines model for FrontendCustomDomainResponse.DomainStatus.
const ( FrontendCustomDomainResponseDomainStatusActive FrontendCustomDomainResponseDomainStatus = "active" FrontendCustomDomainResponseDomainStatusDeleted FrontendCustomDomainResponseDomainStatus = "deleted" FrontendCustomDomainResponseDomainStatusDetaching FrontendCustomDomainResponseDomainStatus = "detaching" FrontendCustomDomainResponseDomainStatusFailed FrontendCustomDomainResponseDomainStatus = "failed" FrontendCustomDomainResponseDomainStatusPendingVerification FrontendCustomDomainResponseDomainStatus = "pending_verification" FrontendCustomDomainResponseDomainStatusProvisioning FrontendCustomDomainResponseDomainStatus = "provisioning" )
Defines values for FrontendCustomDomainResponseDomainStatus.
func (FrontendCustomDomainResponseDomainStatus) Valid ¶
func (e FrontendCustomDomainResponseDomainStatus) Valid() bool
Valid indicates whether the value is a known member of the FrontendCustomDomainResponseDomainStatus enum.
type FrontendCustomDomainResponseTlsMode ¶
type FrontendCustomDomainResponseTlsMode string
FrontendCustomDomainResponseTlsMode defines model for FrontendCustomDomainResponse.TlsMode.
const ( FrontendCustomDomainResponseTlsModeByoc FrontendCustomDomainResponseTlsMode = "byoc" FrontendCustomDomainResponseTlsModeManaged FrontendCustomDomainResponseTlsMode = "managed" )
Defines values for FrontendCustomDomainResponseTlsMode.
func (FrontendCustomDomainResponseTlsMode) Valid ¶
func (e FrontendCustomDomainResponseTlsMode) Valid() bool
Valid indicates whether the value is a known member of the FrontendCustomDomainResponseTlsMode enum.
type FrontendCustomDomainResponseVerificationStatus ¶
type FrontendCustomDomainResponseVerificationStatus string
FrontendCustomDomainResponseVerificationStatus defines model for FrontendCustomDomainResponse.VerificationStatus.
const ( FrontendCustomDomainResponseVerificationStatusPending FrontendCustomDomainResponseVerificationStatus = "pending" FrontendCustomDomainResponseVerificationStatusVerified FrontendCustomDomainResponseVerificationStatus = "verified" )
Defines values for FrontendCustomDomainResponseVerificationStatus.
func (FrontendCustomDomainResponseVerificationStatus) Valid ¶
func (e FrontendCustomDomainResponseVerificationStatus) Valid() bool
Valid indicates whether the value is a known member of the FrontendCustomDomainResponseVerificationStatus enum.
type FrontendCustomDomainStatus ¶
type FrontendCustomDomainStatus string
FrontendCustomDomainStatus Current custom domain lifecycle status
const ( FrontendCustomDomainStatusActive FrontendCustomDomainStatus = "active" FrontendCustomDomainStatusDeleted FrontendCustomDomainStatus = "deleted" FrontendCustomDomainStatusDetaching FrontendCustomDomainStatus = "detaching" FrontendCustomDomainStatusFailed FrontendCustomDomainStatus = "failed" FrontendCustomDomainStatusPendingVerification FrontendCustomDomainStatus = "pending_verification" FrontendCustomDomainStatusProvisioning FrontendCustomDomainStatus = "provisioning" )
Defines values for FrontendCustomDomainStatus.
func (FrontendCustomDomainStatus) Valid ¶
func (e FrontendCustomDomainStatus) Valid() bool
Valid indicates whether the value is a known member of the FrontendCustomDomainStatus enum.
type FrontendCustomDomainTLSConfig ¶
type FrontendCustomDomainTLSConfig struct {
// CertificateChainPem Optional PEM-encoded certificate chain.
CertificateChainPem *string `json:"certificate_chain_pem,omitempty"`
// CertificatePem Required. PEM-encoded certificate.
CertificatePem string `json:"certificate_pem"`
// Mode BYOC is mandatory for custom domain creation.
Mode FrontendCustomDomainTLSConfigMode `json:"mode"`
// PrivateKeyPem Required. PEM-encoded private key.
PrivateKeyPem string `json:"private_key_pem"`
}
FrontendCustomDomainTLSConfig defines model for FrontendCustomDomainTLSConfig.
type FrontendCustomDomainTLSConfigMode ¶
type FrontendCustomDomainTLSConfigMode string
FrontendCustomDomainTLSConfigMode BYOC is mandatory for custom domain creation.
const (
FrontendCustomDomainTLSConfigModeByoc FrontendCustomDomainTLSConfigMode = "byoc"
)
Defines values for FrontendCustomDomainTLSConfigMode.
func (FrontendCustomDomainTLSConfigMode) Valid ¶
func (e FrontendCustomDomainTLSConfigMode) Valid() bool
Valid indicates whether the value is a known member of the FrontendCustomDomainTLSConfigMode enum.
type FrontendDeployment ¶
type FrontendDeployment struct {
ArtifactBucket *string `json:"artifact_bucket,omitempty"`
ArtifactKey *string `json:"artifact_key,omitempty"`
ArtifactVersion *string `json:"artifact_version,omitempty"`
CloudformationStackId *string `json:"cloudformation_stack_id,omitempty"`
CloudformationStackUrl *string `json:"cloudformation_stack_url,omitempty"`
CloudwatchLogGroup *string `json:"cloudwatch_log_group,omitempty"`
// CodebuildBuildCount Number of completed CodeBuild builds included in codebuild_duration_seconds.
CodebuildBuildCount *int `json:"codebuild_build_count,omitempty"`
CodebuildDurationRecordedAt *time.Time `json:"codebuild_duration_recorded_at,omitempty"`
// CodebuildDurationSeconds Total CodeBuild build duration recorded for this deployment, in seconds.
CodebuildDurationSeconds *int64 `json:"codebuild_duration_seconds,omitempty"`
CreatedAt time.Time `json:"created_at"`
ErrorMessage *string `json:"error_message,omitempty"`
FrontendId openapi_types.UUID `json:"frontend_id"`
Id openapi_types.UUID `json:"id"`
Operation FrontendDeploymentOperation `json:"operation"`
ProjectId openapi_types.UUID `json:"project_id"`
SiteUrl *string `json:"site_url,omitempty"`
Status FrontendDeploymentStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
FrontendDeployment defines model for FrontendDeployment.
type FrontendDeploymentOperation ¶
type FrontendDeploymentOperation string
FrontendDeploymentOperation defines model for FrontendDeployment.Operation.
const ( FrontendDeploymentOperationDelete FrontendDeploymentOperation = "delete" FrontendDeploymentOperationDeploy FrontendDeploymentOperation = "deploy" FrontendDeploymentOperationRedeploy FrontendDeploymentOperation = "redeploy" )
Defines values for FrontendDeploymentOperation.
func (FrontendDeploymentOperation) Valid ¶
func (e FrontendDeploymentOperation) Valid() bool
Valid indicates whether the value is a known member of the FrontendDeploymentOperation enum.
type FrontendDeploymentStatus ¶
type FrontendDeploymentStatus string
FrontendDeploymentStatus defines model for FrontendDeployment.Status.
const ( FrontendDeploymentStatusActive FrontendDeploymentStatus = "active" FrontendDeploymentStatusDeleted FrontendDeploymentStatus = "deleted" FrontendDeploymentStatusDeleting FrontendDeploymentStatus = "deleting" FrontendDeploymentStatusFailed FrontendDeploymentStatus = "failed" FrontendDeploymentStatusProvisioning FrontendDeploymentStatus = "provisioning" )
Defines values for FrontendDeploymentStatus.
func (FrontendDeploymentStatus) Valid ¶
func (e FrontendDeploymentStatus) Valid() bool
Valid indicates whether the value is a known member of the FrontendDeploymentStatus enum.
type FrontendDomainRoutingRecord ¶
type FrontendDomainRoutingRecord struct {
Name string `json:"name"`
RecordType FrontendDomainRoutingRecordRecordType `json:"record_type"`
Value string `json:"value"`
}
FrontendDomainRoutingRecord defines model for FrontendDomainRoutingRecord.
type FrontendDomainRoutingRecordRecordType ¶
type FrontendDomainRoutingRecordRecordType string
FrontendDomainRoutingRecordRecordType defines model for FrontendDomainRoutingRecord.RecordType.
const (
CNAME FrontendDomainRoutingRecordRecordType = "CNAME"
)
Defines values for FrontendDomainRoutingRecordRecordType.
func (FrontendDomainRoutingRecordRecordType) Valid ¶
func (e FrontendDomainRoutingRecordRecordType) Valid() bool
Valid indicates whether the value is a known member of the FrontendDomainRoutingRecordRecordType enum.
type FrontendDomainVerificationRecord ¶
type FrontendDomainVerificationRecord struct {
Name string `json:"name"`
Type string `json:"type"`
Value string `json:"value"`
}
FrontendDomainVerificationRecord defines model for FrontendDomainVerificationRecord.
type FrontendFramework ¶
type FrontendFramework string
FrontendFramework defines model for Frontend.Framework.
const (
Nextjs FrontendFramework = "nextjs"
)
Defines values for FrontendFramework.
func (FrontendFramework) Valid ¶
func (e FrontendFramework) Valid() bool
Valid indicates whether the value is a known member of the FrontendFramework enum.
type FrontendStatus ¶
type FrontendStatus string
FrontendStatus defines model for Frontend.Status.
const ( FrontendStatusActive FrontendStatus = "active" FrontendStatusDeleting FrontendStatus = "deleting" FrontendStatusFailed FrontendStatus = "failed" FrontendStatusProvisioning FrontendStatus = "provisioning" )
Defines values for FrontendStatus.
func (FrontendStatus) Valid ¶
func (e FrontendStatus) Valid() bool
Valid indicates whether the value is a known member of the FrontendStatus enum.
type FrontendUsageDailyEntry ¶ added in v0.0.4
type FrontendUsageDailyEntry struct {
// Day UTC date (YYYY-MM-DD) the counts cover.
Day openapi_types.Date `json:"day"`
// Errors 5xx responses served on this day.
Errors int64 `json:"errors"`
// PageViews Navigable-document responses served on this day (text/html or Sec-Fetch-Dest=document) — strict subset of `requests`.
PageViews int64 `json:"page_views"`
// Requests Total requests served on this day.
Requests int64 `json:"requests"`
}
FrontendUsageDailyEntry One day of request and error counts for a single frontend.
type FrontendUsageData ¶
type FrontendUsageData struct {
// FrontendId Frontend ID
FrontendId openapi_types.UUID `json:"frontend_id"`
// FrontendName Frontend name at the time usage was fetched
FrontendName *string `json:"frontend_name,omitempty"`
// Requests Total requests for this frontend in the current usage month
Requests int64 `json:"requests"`
}
FrontendUsageData Monthly frontend request totals grouped by frontend.
type FrontendUsageHistoryResponse ¶ added in v0.0.4
type FrontendUsageHistoryResponse struct {
Daily []FrontendUsageDailyEntry `json:"daily"`
// Days Number of daily entries returned (always equal to the `days` query param after clamping).
Days int `json:"days"`
FrontendId openapi_types.UUID `json:"frontend_id"`
TotalErrors int64 `json:"total_errors"`
TotalPageViews int64 `json:"total_page_views"`
TotalRequests int64 `json:"total_requests"`
}
FrontendUsageHistoryResponse Zero-filled daily series of request + error counts for a single frontend, oldest first.
type Function ¶
type Function struct {
AwsFunctionArn *string `json:"aws_function_arn,omitempty"`
CreatedAt time.Time `json:"created_at"`
// CurrentDeploymentId Identifier of the latest function deployment operation
CurrentDeploymentId *openapi_types.UUID `json:"current_deployment_id,omitempty"`
// DeployedRegions Regions where this function is currently deployed
DeployedRegions []string `json:"deployed_regions"`
Handler *string `json:"handler,omitempty"`
Id openapi_types.UUID `json:"id"`
// InvokeUrl Canonical GeoDNS endpoint URL for invoking this function (always HTTPS)
InvokeUrl *string `json:"invoke_url,omitempty"`
// IsPublic Function visibility for anon-key invocation.
// - `false` (default): only auth user tokens and service keys can invoke
// - `true`: anon keys with `functions.invoke` can invoke
IsPublic bool `json:"is_public"`
// LastInvokedAt Most recent successful invocation timestamp
LastInvokedAt *time.Time `json:"last_invoked_at,omitempty"`
Name string `json:"name"`
ProjectId openapi_types.UUID `json:"project_id"`
// ProvisioningStartedAt Timestamp when the current provisioning phase started
ProvisioningStartedAt *time.Time `json:"provisioning_started_at,omitempty"`
Runtime *string `json:"runtime,omitempty"`
Status FunctionStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
Function defines model for Function.
type FunctionDeployment ¶
type FunctionDeployment struct {
ArtifactBucket *string `json:"artifact_bucket,omitempty"`
ArtifactKey *string `json:"artifact_key,omitempty"`
ArtifactVersion *string `json:"artifact_version,omitempty"`
BatchId *openapi_types.UUID `json:"batch_id,omitempty"`
// CodebuildBuildCount Number of completed CodeBuild builds included in codebuild_duration_seconds.
CodebuildBuildCount *int `json:"codebuild_build_count,omitempty"`
CodebuildDurationRecordedAt *time.Time `json:"codebuild_duration_recorded_at,omitempty"`
// CodebuildDurationSeconds Total CodeBuild build duration recorded for this deployment, in seconds.
CodebuildDurationSeconds *int64 `json:"codebuild_duration_seconds,omitempty"`
CompileLogGroup *string `json:"compile_log_group,omitempty"`
CompileLogStream *string `json:"compile_log_stream,omitempty"`
CompletedAt *time.Time `json:"completed_at,omitempty"`
CreatedAt time.Time `json:"created_at"`
ErrorMessage *string `json:"error_message,omitempty"`
FunctionId openapi_types.UUID `json:"function_id"`
Id openapi_types.UUID `json:"id"`
Operation FunctionDeploymentOperation `json:"operation"`
ProjectId openapi_types.UUID `json:"project_id"`
PublishLogGroup *string `json:"publish_log_group,omitempty"`
PublishLogStream *string `json:"publish_log_stream,omitempty"`
Status FunctionDeploymentStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
FunctionDeployment defines model for FunctionDeployment.
type FunctionDeploymentOperation ¶
type FunctionDeploymentOperation string
FunctionDeploymentOperation defines model for FunctionDeployment.Operation.
const ( FunctionDeploymentOperationDelete FunctionDeploymentOperation = "delete" FunctionDeploymentOperationDeploy FunctionDeploymentOperation = "deploy" FunctionDeploymentOperationUpdate FunctionDeploymentOperation = "update" )
Defines values for FunctionDeploymentOperation.
func (FunctionDeploymentOperation) Valid ¶
func (e FunctionDeploymentOperation) Valid() bool
Valid indicates whether the value is a known member of the FunctionDeploymentOperation enum.
type FunctionDeploymentStatus ¶
type FunctionDeploymentStatus string
FunctionDeploymentStatus defines model for FunctionDeployment.Status.
const ( FunctionDeploymentStatusActive FunctionDeploymentStatus = "active" FunctionDeploymentStatusDeleted FunctionDeploymentStatus = "deleted" FunctionDeploymentStatusDeleting FunctionDeploymentStatus = "deleting" FunctionDeploymentStatusFailed FunctionDeploymentStatus = "failed" FunctionDeploymentStatusProvisioning FunctionDeploymentStatus = "provisioning" )
Defines values for FunctionDeploymentStatus.
func (FunctionDeploymentStatus) Valid ¶
func (e FunctionDeploymentStatus) Valid() bool
Valid indicates whether the value is a known member of the FunctionDeploymentStatus enum.
type FunctionInvocationRequest ¶
type FunctionInvocationRequest struct {
// Payload Payload to send to the Lambda function.
//
// If invoked with auth user token, Volcano automatically injects `__volcano_auth` context:
// “`javascript
// {
// ...yourPayload,
// __volcano_auth: {
// user_id: "uuid",
// email: "user@example.com",
// project_id: "uuid",
// role: "authenticated" | "anonymous"
// }
// }
// “`
Payload *map[string]interface{} `json:"payload,omitempty"`
}
FunctionInvocationRequest defines model for FunctionInvocationRequest.
type FunctionInvocationResponse ¶
type FunctionInvocationResponse map[string]interface{}
FunctionInvocationResponse Raw function response body returned by the invoked function.
type FunctionRegion ¶ added in v0.0.4
type FunctionRegion struct {
// Code AWS region identifier accepted by function APIs.
Code string `json:"code"`
// Flag Country flag emoji associated with the region's geography.
Flag string `json:"flag"`
// Label Human-readable region label suitable for display in pickers.
Label string `json:"label"`
}
FunctionRegion defines model for FunctionRegion.
type FunctionRuntimeDeployment ¶
type FunctionRuntimeDeployment struct {
// DependencyManifests Dependency manifest files the CLI should include for hosted builds.
DependencyManifests []string `json:"dependency_manifests"`
// Entrypoint Archive path the CLI should use for a single-file function source.
Entrypoint string `json:"entrypoint"`
// FileExtensions Source file extensions the CLI can use to detect this runtime.
FileExtensions []string `json:"file_extensions"`
// Handler Handler symbol the CLI should submit when deploying this runtime.
Handler string `json:"handler"`
}
FunctionRuntimeDeployment defines model for FunctionRuntimeDeployment.
type FunctionRuntimeOption ¶
type FunctionRuntimeOption struct {
// Default Whether this runtime is the CLI default for its language.
Default bool `json:"default"`
Deployment FunctionRuntimeDeployment `json:"deployment"`
// Language Runtime language family used by the CLI to choose defaults from source files.
Language string `json:"language"`
// Name Runtime identifier accepted by function APIs.
Name string `json:"name"`
}
FunctionRuntimeOption defines model for FunctionRuntimeOption.
type FunctionRuntimesResponse ¶
type FunctionRuntimesResponse struct {
Runtimes []FunctionRuntimeOption `json:"runtimes"`
}
FunctionRuntimesResponse defines model for FunctionRuntimesResponse.
type FunctionScheduler ¶
type FunctionScheduler struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
CronExpression *string `json:"cron_expression,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
FunctionId *openapi_types.UUID `json:"function_id,omitempty"`
Id *openapi_types.UUID `json:"id,omitempty"`
LastCompletedAt *time.Time `json:"last_completed_at,omitempty"`
LastError *string `json:"last_error,omitempty"`
LastStartedAt *time.Time `json:"last_started_at,omitempty"`
Name *string `json:"name,omitempty"`
NextRunAt *time.Time `json:"next_run_at,omitempty"`
Payload *map[string]interface{} `json:"payload,omitempty"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
Regions *[]string `json:"regions,omitempty"`
RegionsExplicit *bool `json:"regions_explicit,omitempty"`
ScheduleKind *FunctionSchedulerScheduleKind `json:"schedule_kind,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
FunctionScheduler defines model for FunctionScheduler.
type FunctionSchedulerListResponse ¶
type FunctionSchedulerListResponse struct {
Data []FunctionScheduler `json:"data"`
HasMore bool `json:"has_more"`
Limit int `json:"limit"`
Page int `json:"page"`
Total int `json:"total"`
}
FunctionSchedulerListResponse defines model for FunctionSchedulerListResponse.
type FunctionSchedulerScheduleKind ¶
type FunctionSchedulerScheduleKind string
FunctionSchedulerScheduleKind defines model for FunctionScheduler.ScheduleKind.
const (
FunctionSchedulerScheduleKindCron FunctionSchedulerScheduleKind = "cron"
)
Defines values for FunctionSchedulerScheduleKind.
func (FunctionSchedulerScheduleKind) Valid ¶
func (e FunctionSchedulerScheduleKind) Valid() bool
Valid indicates whether the value is a known member of the FunctionSchedulerScheduleKind enum.
type FunctionStatus ¶
type FunctionStatus string
FunctionStatus defines model for Function.Status.
const ( FunctionStatusActive FunctionStatus = "active" FunctionStatusDeleting FunctionStatus = "deleting" FunctionStatusFailed FunctionStatus = "failed" FunctionStatusProvisioning FunctionStatus = "provisioning" )
Defines values for FunctionStatus.
func (FunctionStatus) Valid ¶
func (e FunctionStatus) Valid() bool
Valid indicates whether the value is a known member of the FunctionStatus enum.
type HostedAuthPageType ¶
type HostedAuthPageType string
HostedAuthPageType defines model for HostedAuthPageType.
const ( HostedAuthPageTypeLogin HostedAuthPageType = "login" HostedAuthPageTypeResetPassword HostedAuthPageType = "reset-password" )
Defines values for HostedAuthPageType.
func (HostedAuthPageType) Valid ¶
func (e HostedAuthPageType) Valid() bool
Valid indicates whether the value is a known member of the HostedAuthPageType enum.
type HostedLoginEmailCheckRequest ¶
type HostedLoginEmailCheckRequest struct {
Email openapi_types.Email `json:"email"`
}
HostedLoginEmailCheckRequest defines model for HostedLoginEmailCheckRequest.
type HostedLoginEmailCheckResponse ¶
type HostedLoginEmailCheckResponse struct {
Exists *bool `json:"exists,omitempty"`
}
HostedLoginEmailCheckResponse defines model for HostedLoginEmailCheckResponse.
type HostedLoginOptionsResponse ¶
type HostedLoginOptionsResponse struct {
EmailPasswordEnabled *bool `json:"email_password_enabled,omitempty"`
EnableSignup *bool `json:"enable_signup,omitempty"`
OauthProviders *[]string `json:"oauth_providers,omitempty"`
PostAuthRedirectUrl *string `json:"post_auth_redirect_url,omitempty"`
RequireEmailConfirmation *bool `json:"require_email_confirmation,omitempty"`
}
HostedLoginOptionsResponse defines model for HostedLoginOptionsResponse.
type HostedRenderablePageType ¶
type HostedRenderablePageType string
HostedRenderablePageType defines model for HostedRenderablePageType.
const (
HostedRenderablePageTypeResetPassword HostedRenderablePageType = "reset-password"
)
Defines values for HostedRenderablePageType.
func (HostedRenderablePageType) Valid ¶
func (e HostedRenderablePageType) Valid() bool
Valid indicates whether the value is a known member of the HostedRenderablePageType enum.
type LiveLogLevel ¶ added in v0.0.4
type LiveLogLevel string
LiveLogLevel Canonical lowercase function runtime log level.
const ( LiveLogLevelDebug LiveLogLevel = "debug" LiveLogLevelError LiveLogLevel = "error" LiveLogLevelFatal LiveLogLevel = "fatal" LiveLogLevelInfo LiveLogLevel = "info" LiveLogLevelTrace LiveLogLevel = "trace" LiveLogLevelWarn LiveLogLevel = "warn" )
Defines values for LiveLogLevel.
func (LiveLogLevel) Valid ¶ added in v0.0.4
func (e LiveLogLevel) Valid() bool
Valid indicates whether the value is a known member of the LiveLogLevel enum.
type LogActivityBucket ¶ added in v0.0.4
type LogActivityBucket struct {
// Counts Counts grouped by activity dimension.
Counts struct {
// Levels Counts by normalized log level.
Levels map[string]int `json:"levels"`
// Regions Counts by event region.
Regions map[string]int `json:"regions"`
// ResourceIds Counts by resource ID.
ResourceIds map[string]int `json:"resource_ids"`
} `json:"counts"`
// EndTime Bucket end time.
EndTime time.Time `json:"end_time"`
// StartTime Bucket start time.
StartTime time.Time `json:"start_time"`
// Total Total events in this bucket.
Total int `json:"total"`
}
LogActivityBucket Log-event counts for one activity time bucket.
type LogActivityRequest ¶ added in v0.0.4
type LogActivityRequest struct {
// BucketCount Number of activity buckets to return.
BucketCount *int `json:"bucket_count,omitempty"`
// EndTime End time.
EndTime *time.Time `json:"end_time,omitempty"`
// Levels Canonical lowercase log levels to filter by. If omitted, empty, or all levels are selected, no level filter is applied.
Levels *[]LiveLogLevel `json:"levels,omitempty"`
// Q Optional free-text search query for log messages.
Q *string `json:"q,omitempty"`
// Regions Regions to filter by, for example `["us-east-1", "eu-west-1"]`. If omitted or empty, aggregate all deployed regions.
Regions *[]string `json:"regions,omitempty"`
// Resource Resource selectors for project log reads.
Resource LogRequestResource `json:"resource"`
// StartTime Start time.
StartTime *time.Time `json:"start_time,omitempty"`
}
LogActivityRequest Activity request for bucketed log counts.
type LogActivityResponse ¶ added in v0.0.4
type LogActivityResponse struct {
Data []LogActivityBucket `json:"data"`
// Total Total events counted across all buckets.
Total int `json:"total"`
}
LogActivityResponse Bucketed runtime log activity.
type LogDatabaseRequestResource ¶ added in v0.0.4
type LogDatabaseRequestResource struct {
// Ids Optional database identifiers. Omit or send an empty array to include every database in the project.
Ids *[]openapi_types.UUID `json:"ids,omitempty"`
// Type Resource type to read logs for.
Type LogDatabaseRequestResourceType `json:"type"`
}
LogDatabaseRequestResource Database runtime log resource selector. Deployment logs are not supported for databases.
type LogDatabaseRequestResourceType ¶ added in v0.0.4
type LogDatabaseRequestResourceType string
LogDatabaseRequestResourceType Resource type to read logs for.
const (
LogDatabaseRequestResourceTypeDatabase LogDatabaseRequestResourceType = "database"
)
Defines values for LogDatabaseRequestResourceType.
func (LogDatabaseRequestResourceType) Valid ¶ added in v0.0.4
func (e LogDatabaseRequestResourceType) Valid() bool
Valid indicates whether the value is a known member of the LogDatabaseRequestResourceType enum.
type LogDeployment ¶ added in v0.0.4
type LogDeployment struct {
// Id Deployment ID associated with the log event.
Id openapi_types.UUID `json:"id"`
// Stage Deployment stage that produced the log event, when available.
Stage *LogDeploymentStage `json:"stage,omitempty"`
}
LogDeployment Deployment context associated with a historical deployment log event.
type LogDeploymentRequestSelector ¶ added in v0.0.4
type LogDeploymentRequestSelector struct {
// Ids Optional deployment identifiers. Omit or send an empty array to include every deployment for the selected resources.
Ids *[]openapi_types.UUID `json:"ids,omitempty"`
}
LogDeploymentRequestSelector Deployment log selector for deployable resources.
type LogDeploymentStage ¶ added in v0.0.4
type LogDeploymentStage string
LogDeploymentStage Deployment stage that produced the log event, when available.
const ( Compile LogDeploymentStage = "compile" Publish LogDeploymentStage = "publish" )
Defines values for LogDeploymentStage.
func (LogDeploymentStage) Valid ¶ added in v0.0.4
func (e LogDeploymentStage) Valid() bool
Valid indicates whether the value is a known member of the LogDeploymentStage enum.
type LogEvent ¶
type LogEvent struct {
// Deployment Deployment context associated with a historical deployment log event.
Deployment *LogDeployment `json:"deployment,omitempty"`
// Id Opaque stable log event ID for pagination, deduplication, and display.
Id *string `json:"id,omitempty"`
// InvocationId Function invocation ID associated with this log event, when available.
InvocationId *string `json:"invocation_id,omitempty"`
// Level Canonical lowercase function runtime log level.
Level *LiveLogLevel `json:"level,omitempty"`
// Message Display log message.
Message string `json:"message"`
// Metadata Parsed JSON fields and other indexed metadata, when available.
Metadata *map[string]interface{} `json:"metadata,omitempty"`
// RawMessage Original log line/message after platform sanitization.
RawMessage *string `json:"raw_message,omitempty"`
// Region Region where this log event originated.
Region *string `json:"region,omitempty"`
// Resource Resource that owns a historical log event.
Resource *LogResource `json:"resource,omitempty"`
// Timestamp Event timestamp.
Timestamp time.Time `json:"timestamp"`
}
LogEvent Normalized historical log event returned by paginated log APIs.
type LogFrontendRequestResource ¶ added in v0.0.4
type LogFrontendRequestResource struct {
// Deployments Deployment log selector for deployable resources.
Deployments *LogDeploymentRequestSelector `json:"deployments,omitempty"`
// Ids Optional frontend identifiers. Omit or send an empty array to include every frontend in the project.
Ids *[]openapi_types.UUID `json:"ids,omitempty"`
// Type Resource type to read logs for.
Type LogFrontendRequestResourceType `json:"type"`
}
LogFrontendRequestResource Frontend log resource selector.
type LogFrontendRequestResourceType ¶ added in v0.0.4
type LogFrontendRequestResourceType string
LogFrontendRequestResourceType Resource type to read logs for.
const (
LogFrontendRequestResourceTypeFrontend LogFrontendRequestResourceType = "frontend"
)
Defines values for LogFrontendRequestResourceType.
func (LogFrontendRequestResourceType) Valid ¶ added in v0.0.4
func (e LogFrontendRequestResourceType) Valid() bool
Valid indicates whether the value is a known member of the LogFrontendRequestResourceType enum.
type LogFunctionRequestResource ¶ added in v0.0.4
type LogFunctionRequestResource struct {
// Deployments Deployment log selector for deployable resources.
Deployments *LogDeploymentRequestSelector `json:"deployments,omitempty"`
// Ids Optional function identifiers. Omit or send an empty array to include every function in the project.
Ids *[]openapi_types.UUID `json:"ids,omitempty"`
// Type Resource type to read logs for.
Type LogFunctionRequestResourceType `json:"type"`
}
LogFunctionRequestResource Edge Function log resource selector.
type LogFunctionRequestResourceType ¶ added in v0.0.4
type LogFunctionRequestResourceType string
LogFunctionRequestResourceType Resource type to read logs for.
const (
LogFunctionRequestResourceTypeFunction LogFunctionRequestResourceType = "function"
)
Defines values for LogFunctionRequestResourceType.
func (LogFunctionRequestResourceType) Valid ¶ added in v0.0.4
func (e LogFunctionRequestResourceType) Valid() bool
Valid indicates whether the value is a known member of the LogFunctionRequestResourceType enum.
type LogRequestResource ¶ added in v0.0.4
type LogRequestResource struct {
// contains filtered or unexported fields
}
LogRequestResource Resource selectors for project log reads.
func (LogRequestResource) AsLogDatabaseRequestResource ¶ added in v0.0.4
func (t LogRequestResource) AsLogDatabaseRequestResource() (LogDatabaseRequestResource, error)
AsLogDatabaseRequestResource returns the union data inside the LogRequestResource as a LogDatabaseRequestResource
func (LogRequestResource) AsLogFrontendRequestResource ¶ added in v0.0.4
func (t LogRequestResource) AsLogFrontendRequestResource() (LogFrontendRequestResource, error)
AsLogFrontendRequestResource returns the union data inside the LogRequestResource as a LogFrontendRequestResource
func (LogRequestResource) AsLogFunctionRequestResource ¶ added in v0.0.4
func (t LogRequestResource) AsLogFunctionRequestResource() (LogFunctionRequestResource, error)
AsLogFunctionRequestResource returns the union data inside the LogRequestResource as a LogFunctionRequestResource
func (LogRequestResource) Discriminator ¶ added in v0.0.4
func (t LogRequestResource) Discriminator() (string, error)
func (*LogRequestResource) FromLogDatabaseRequestResource ¶ added in v0.0.4
func (t *LogRequestResource) FromLogDatabaseRequestResource(v LogDatabaseRequestResource) error
FromLogDatabaseRequestResource overwrites any union data inside the LogRequestResource as the provided LogDatabaseRequestResource
func (*LogRequestResource) FromLogFrontendRequestResource ¶ added in v0.0.4
func (t *LogRequestResource) FromLogFrontendRequestResource(v LogFrontendRequestResource) error
FromLogFrontendRequestResource overwrites any union data inside the LogRequestResource as the provided LogFrontendRequestResource
func (*LogRequestResource) FromLogFunctionRequestResource ¶ added in v0.0.4
func (t *LogRequestResource) FromLogFunctionRequestResource(v LogFunctionRequestResource) error
FromLogFunctionRequestResource overwrites any union data inside the LogRequestResource as the provided LogFunctionRequestResource
func (LogRequestResource) MarshalJSON ¶ added in v0.0.4
func (t LogRequestResource) MarshalJSON() ([]byte, error)
func (*LogRequestResource) MergeLogDatabaseRequestResource ¶ added in v0.0.4
func (t *LogRequestResource) MergeLogDatabaseRequestResource(v LogDatabaseRequestResource) error
MergeLogDatabaseRequestResource performs a merge with any union data inside the LogRequestResource, using the provided LogDatabaseRequestResource
func (*LogRequestResource) MergeLogFrontendRequestResource ¶ added in v0.0.4
func (t *LogRequestResource) MergeLogFrontendRequestResource(v LogFrontendRequestResource) error
MergeLogFrontendRequestResource performs a merge with any union data inside the LogRequestResource, using the provided LogFrontendRequestResource
func (*LogRequestResource) MergeLogFunctionRequestResource ¶ added in v0.0.4
func (t *LogRequestResource) MergeLogFunctionRequestResource(v LogFunctionRequestResource) error
MergeLogFunctionRequestResource performs a merge with any union data inside the LogRequestResource, using the provided LogFunctionRequestResource
func (*LogRequestResource) UnmarshalJSON ¶ added in v0.0.4
func (t *LogRequestResource) UnmarshalJSON(b []byte) error
func (LogRequestResource) ValueByDiscriminator ¶ added in v0.0.4
func (t LogRequestResource) ValueByDiscriminator() (interface{}, error)
type LogResource ¶ added in v0.0.4
type LogResource struct {
// Id Resource ID that owns the log event.
Id openapi_types.UUID `json:"id"`
// Name Resource name associated with the log event, when available.
Name *string `json:"name,omitempty"`
// Type Resource type that owns the log event.
Type LogResourceType `json:"type"`
}
LogResource Resource that owns a historical log event.
type LogResourceType ¶ added in v0.0.4
type LogResourceType string
LogResourceType Resource type that owns the log event.
const ( LogResourceTypeDatabase LogResourceType = "database" LogResourceTypeFrontend LogResourceType = "frontend" LogResourceTypeFunction LogResourceType = "function" )
Defines values for LogResourceType.
func (LogResourceType) Valid ¶ added in v0.0.4
func (e LogResourceType) Valid() bool
Valid indicates whether the value is a known member of the LogResourceType enum.
type LogSearchEvent ¶ added in v0.0.4
type LogSearchEvent struct {
// Deployment Deployment context associated with a historical deployment log event.
Deployment *LogDeployment `json:"deployment,omitempty"`
// Id Opaque stable log event ID for pagination, deduplication, and display.
Id string `json:"id"`
// InvocationId Function invocation ID associated with this log event, when available.
InvocationId *string `json:"invocation_id,omitempty"`
// Level Canonical lowercase function runtime log level.
Level *LiveLogLevel `json:"level,omitempty"`
// Message Display log message.
Message string `json:"message"`
// Metadata Parsed JSON fields and other indexed metadata, when available.
Metadata *map[string]interface{} `json:"metadata,omitempty"`
// RawMessage Original log line/message after platform sanitization.
RawMessage *string `json:"raw_message,omitempty"`
// Region Region where this log event originated.
Region *string `json:"region,omitempty"`
// Resource Resource that owns a historical log event.
Resource LogResource `json:"resource"`
// Timestamp Event timestamp.
Timestamp time.Time `json:"timestamp"`
}
LogSearchEvent defines model for LogSearchEvent.
type LogSearchRequest ¶ added in v0.0.4
type LogSearchRequest struct {
// Cursor Opaque pagination cursor from the previous response's `next_cursor`.
Cursor *string `json:"cursor,omitempty"`
// EndTime End time.
EndTime *time.Time `json:"end_time,omitempty"`
// Levels Canonical lowercase log levels to filter by. If omitted, empty, or all levels are selected, no level filter is applied.
Levels *[]LiveLogLevel `json:"levels,omitempty"`
// Limit Maximum number of records to return.
Limit *int `json:"limit,omitempty"`
// Q Optional free-text search query for log messages.
Q *string `json:"q,omitempty"`
// Regions Regions to filter by, for example `["us-east-1", "eu-west-1"]`. If omitted or empty, search all deployed regions.
Regions *[]string `json:"regions,omitempty"`
// Resource Resource selectors for project log reads.
Resource LogRequestResource `json:"resource"`
// StartTime Start time.
StartTime *time.Time `json:"start_time,omitempty"`
}
LogSearchRequest Search request for project logs.
type LogSearchResponse ¶ added in v0.0.4
type LogSearchResponse struct {
// Data Array of log events sorted by timestamp, newest first.
Data []LogSearchEvent `json:"data"`
// HasMore Whether there are more log events available.
HasMore bool `json:"has_more"`
// Limit Number of items requested per page.
Limit int `json:"limit"`
// NextCursor Opaque cursor for the next page. Send this value as `cursor` on the next request.
NextCursor *string `json:"next_cursor,omitempty"`
}
LogSearchResponse Paginated project runtime log search response.
type LogStreamRequest ¶ added in v0.0.4
type LogStreamRequest struct {
// Levels Canonical lowercase log levels to filter by. If omitted, empty, or all levels are selected, no level filter is applied.
Levels *[]LiveLogLevel `json:"levels,omitempty"`
// Limit Maximum number of records to deliver on connect or reconnect before following new events.
Limit *int `json:"limit,omitempty"`
// Regions Regions to filter by, for example `["us-east-1", "eu-west-1"]`. If omitted or empty, stream all deployed regions.
Regions *[]string `json:"regions,omitempty"`
// Resource Resource selectors for project log reads.
Resource LogRequestResource `json:"resource"`
// StartTime Start time.
StartTime *time.Time `json:"start_time,omitempty"`
}
LogStreamRequest Stream request for live project logs. Text search, pagination cursors, and fixed end times are not supported.
type MetricUsageData ¶
type MetricUsageData struct {
// AllTime Lifetime cumulative usage across every month for this metric
AllTime int64 `json:"all_time"`
// Daily Last 30 days of daily usage points
Daily []UsageDataPoint `json:"daily"`
// Hourly Last 24 hours of hourly usage points
Hourly []UsageDataPoint `json:"hourly"`
// Metric Metric name (for example, "Function & Frontend Invocations", "Frontend Requests",
// "CodeBuild Build Seconds", "Bandwidth Ingress (Bytes)", "Bandwidth Egress (Bytes)",
// "Bandwidth Total (Bytes)", or "Database Storage (Bytes)"). Byte-based metrics are
// reported in bytes. "Bandwidth Total (Bytes)" is derived (ingress + egress) and
// is not billed separately. "Database Storage (Bytes)" is a current observed gauge,
// not a cumulative counter.
Metric string `json:"metric"`
// Total Total usage for the current usage month
Total int64 `json:"total"`
}
MetricUsageData Usage data for one metric across totals, daily, and hourly windows.
type OAuthConfig ¶
type OAuthConfig struct {
ClientId *string `json:"client_id,omitempty"`
// ClientSecret Masked in responses (shows only first/last 4 chars)
ClientSecret *string `json:"client_secret,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Id *openapi_types.UUID `json:"id,omitempty"`
Provider *OAuthConfigProvider `json:"provider,omitempty"`
RedirectUrl *string `json:"redirect_url,omitempty"`
Scopes *[]string `json:"scopes,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
OAuthConfig defines model for OAuthConfig.
type OAuthConfigProvider ¶
type OAuthConfigProvider string
OAuthConfigProvider defines model for OAuthConfig.Provider.
const ( OAuthConfigProviderApple OAuthConfigProvider = "apple" OAuthConfigProviderDevice OAuthConfigProvider = "device" OAuthConfigProviderGithub OAuthConfigProvider = "github" OAuthConfigProviderGoogle OAuthConfigProvider = "google" OAuthConfigProviderMicrosoft OAuthConfigProvider = "microsoft" )
Defines values for OAuthConfigProvider.
func (OAuthConfigProvider) Valid ¶
func (e OAuthConfigProvider) Valid() bool
Valid indicates whether the value is a known member of the OAuthConfigProvider enum.
type OAuthErrorResponse ¶
type OAuthErrorResponse struct {
Error string `json:"error"`
ErrorDescription *string `json:"error_description,omitempty"`
}
OAuthErrorResponse defines model for OAuthErrorResponse.
type PaginatedAuthUsers ¶
type PaginatedAuthUsers struct {
Data []AuthUser `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedAuthUsers defines model for PaginatedAuthUsers.
type PaginatedDatabases ¶
type PaginatedDatabases struct {
Data []Database `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedDatabases defines model for PaginatedDatabases.
type PaginatedFrontendDeployments ¶
type PaginatedFrontendDeployments struct {
Data []FrontendDeployment `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedFrontendDeployments defines model for PaginatedFrontendDeployments.
type PaginatedFrontends ¶
type PaginatedFrontends struct {
Data []Frontend `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedFrontends defines model for PaginatedFrontends.
type PaginatedFunctionDeployments ¶
type PaginatedFunctionDeployments struct {
Data []FunctionDeployment `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedFunctionDeployments defines model for PaginatedFunctionDeployments.
type PaginatedFunctions ¶
type PaginatedFunctions struct {
Data []Function `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedFunctions defines model for PaginatedFunctions.
type PaginatedProjectCustomDomains ¶ added in v0.0.4
type PaginatedProjectCustomDomains struct {
Data []ProjectFrontendCustomDomain `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedProjectCustomDomains defines model for PaginatedProjectCustomDomains.
type PaginatedProjectDeployments ¶ added in v0.0.4
type PaginatedProjectDeployments struct {
Data []ProjectFrontendDeployment `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedProjectDeployments defines model for PaginatedProjectDeployments.
type PaginatedProjects ¶
type PaginatedProjects struct {
// CurrentSyncId Identifier of the latest variable propagation sync.
CurrentSyncId *openapi_types.UUID `json:"current_sync_id,omitempty"`
Data []Project `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// ProvisioningStartedAt Timestamp when the current variable propagation phase started.
ProvisioningStartedAt *time.Time `json:"provisioning_started_at,omitempty"`
// Status Latest project variable propagation status.
Status *PaginatedProjectsStatus `json:"status,omitempty"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedProjects defines model for PaginatedProjects.
type PaginatedProjectsStatus ¶
type PaginatedProjectsStatus string
PaginatedProjectsStatus Latest project variable propagation status.
const ( PaginatedProjectsStatusActive PaginatedProjectsStatus = "active" PaginatedProjectsStatusFailed PaginatedProjectsStatus = "failed" PaginatedProjectsStatusProvisioning PaginatedProjectsStatus = "provisioning" )
Defines values for PaginatedProjectsStatus.
func (PaginatedProjectsStatus) Valid ¶
func (e PaginatedProjectsStatus) Valid() bool
Valid indicates whether the value is a known member of the PaginatedProjectsStatus enum.
type PaginatedServiceKeys ¶
type PaginatedServiceKeys struct {
Data []ServiceKey `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedServiceKeys defines model for PaginatedServiceKeys.
type PaginatedVariables ¶
type PaginatedVariables struct {
Data []Variable `json:"data"`
// HasMore Whether there are more pages available
HasMore bool `json:"has_more"`
// Limit Number of items per page
Limit int `json:"limit"`
// Next URL path to next page (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Page Current page number (1-indexed)
Page int `json:"page"`
// Total Total number of items across all pages
Total int `json:"total"`
}
PaginatedVariables defines model for PaginatedVariables.
type PlatformExchangeResponse ¶
type PlatformExchangeResponse struct {
ExpiresAt time.Time `json:"expires_at"`
Token string `json:"token"`
TokenId openapi_types.UUID `json:"token_id"`
UserId string `json:"user_id"`
}
PlatformExchangeResponse defines model for PlatformExchangeResponse.
type Project ¶
type Project struct {
// AllRegions Region policy for function deployment.
// - `true`: deploy functions to all configured platform regions
// - `false`: deploy only to `selected_regions`
AllRegions bool `json:"all_regions"`
AwsApplicationName *string `json:"aws_application_name,omitempty"`
CreatedAt time.Time `json:"created_at"`
Id openapi_types.UUID `json:"id"`
// LastInvokedAt Most recent activity timestamp across project resources
LastInvokedAt *time.Time `json:"last_invoked_at,omitempty"`
// LogoUrl Relative API path that serves the project logo when one has been
// uploaded. The path is versioned with a `?v=` cache-busting query
// param that changes on each upload. Absent when the project has no
// logo. The logo image is stored in the project's S3 folder.
LogoUrl *string `json:"logo_url,omitempty"`
Name string `json:"name"`
// Plan Platform plan applied to the project when available
Plan *ProjectPlan `json:"plan,omitempty"`
// SelectedRegions Effective region set for this project (normalized and deduplicated)
SelectedRegions []string `json:"selected_regions"`
Status ProjectStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
Project defines model for Project.
type ProjectConfig ¶ added in v0.0.5
type ProjectConfig struct {
// Auth Authentication settings, grouped like the dashboard auth-settings tabs.
Auth *ProjectConfigAuth `json:"auth,omitempty"`
Buckets *[]ProjectConfigBucket `json:"buckets,omitempty"`
Databases *[]ProjectConfigDatabase `json:"databases,omitempty"`
Frontends *[]ProjectConfigFrontend `json:"frontends,omitempty"`
Functions *[]ProjectConfigFunction `json:"functions,omitempty"`
// Project Project-level settings. `name` renames the project.
Project *ProjectConfigProject `json:"project,omitempty"`
Realtime *ProjectConfigRealtime `json:"realtime,omitempty"`
// Variables Fully synced when declared - variables absent from this list are deleted.
Variables *[]ProjectConfigVariable `json:"variables,omitempty"`
// Version Manifest schema version. Must be 1.
Version ProjectConfigVersion `json:"version"`
}
ProjectConfig Declarative project configuration manifest (the JSON form of volcano-config.yaml). Omitted sections are left untouched. Within declared entries, omitted optional fields keep their current server values (patch semantics). Declared collection keys are fully synced to the manifest: `variables`, `buckets[].policies`, `auth.providers.oauth`, `auth.email.templates`, and `functions[].schedulers` are reconciled to exactly match, deleting resources absent from the manifest. Functions, frontends, databases, and buckets are never created or deleted through this manifest; entries referencing resources that do not exist are skipped and reported.
type ProjectConfigApplyResult ¶ added in v0.0.5
type ProjectConfigApplyResult struct {
// DryRun True when the request was a dry run and no changes were made.
DryRun *bool `json:"dry_run,omitempty"`
// Missing Existing functions, frontends, databases, or buckets that have no
// entry in the corresponding declared manifest section.
Missing []ProjectConfigMissingResource `json:"missing"`
Results []ProjectConfigApplyResultEntry `json:"results"`
// Skipped Manifest entries referencing functions, frontends, databases, or
// buckets that do not exist. Their configuration was not applied;
// deploy/create the resource first, then re-apply.
Skipped []ProjectConfigSkippedResource `json:"skipped"`
Summary ProjectConfigApplySummary `json:"summary"`
}
ProjectConfigApplyResult Per-resource report for a project config apply (or dry run).
type ProjectConfigApplyResultEntry ¶ added in v0.0.5
type ProjectConfigApplyResultEntry struct {
Action ProjectConfigApplyResultEntryAction `json:"action"`
// Error Error detail when action is `error`.
Error *string `json:"error,omitempty"`
// Name Resource name or key within the section. Empty for singleton sections.
Name *string `json:"name,omitempty"`
// Notice Optional operational note (e.g. disabling realtime drops active connections).
Notice *string `json:"notice,omitempty"`
// Section Manifest section the entry belongs to (e.g. variables, buckets, auth.providers.oauth).
Section string `json:"section"`
}
ProjectConfigApplyResultEntry defines model for ProjectConfigApplyResultEntry.
type ProjectConfigApplyResultEntryAction ¶ added in v0.0.5
type ProjectConfigApplyResultEntryAction string
ProjectConfigApplyResultEntryAction defines model for ProjectConfigApplyResultEntry.Action.
const ( ProjectConfigApplyResultEntryActionCreated ProjectConfigApplyResultEntryAction = "created" ProjectConfigApplyResultEntryActionDeleted ProjectConfigApplyResultEntryAction = "deleted" ProjectConfigApplyResultEntryActionError ProjectConfigApplyResultEntryAction = "error" ProjectConfigApplyResultEntryActionUnchanged ProjectConfigApplyResultEntryAction = "unchanged" ProjectConfigApplyResultEntryActionUpdated ProjectConfigApplyResultEntryAction = "updated" )
Defines values for ProjectConfigApplyResultEntryAction.
func (ProjectConfigApplyResultEntryAction) Valid ¶ added in v0.0.5
func (e ProjectConfigApplyResultEntryAction) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigApplyResultEntryAction enum.
type ProjectConfigApplySummary ¶ added in v0.0.5
type ProjectConfigApplySummary struct {
Created int `json:"created"`
Deleted int `json:"deleted"`
Errors int `json:"errors"`
Missing int `json:"missing"`
Skipped int `json:"skipped"`
Unchanged int `json:"unchanged"`
Updated int `json:"updated"`
}
ProjectConfigApplySummary defines model for ProjectConfigApplySummary.
type ProjectConfigAuth ¶ added in v0.0.5
type ProjectConfigAuth struct {
Cors *ProjectConfigAuthCORS `json:"cors,omitempty"`
Email *ProjectConfigAuthEmail `json:"email,omitempty"`
EmailVerification *ProjectConfigAuthEmailVerification `json:"email_verification,omitempty"`
ManagedPages *ProjectConfigAuthManagedPages `json:"managed_pages,omitempty"`
Password *ProjectConfigAuthPassword `json:"password,omitempty"`
PasswordReset *ProjectConfigAuthPasswordReset `json:"password_reset,omitempty"`
Providers *ProjectConfigAuthProviders `json:"providers,omitempty"`
// RateLimits Rate limits per hour.
RateLimits *ProjectConfigAuthRateLimits `json:"rate_limits,omitempty"`
Sessions *ProjectConfigAuthSessions `json:"sessions,omitempty"`
Signup *ProjectConfigAuthSignup `json:"signup,omitempty"`
// Tokens Token lifetimes in seconds.
Tokens *ProjectConfigAuthTokens `json:"tokens,omitempty"`
}
ProjectConfigAuth Authentication settings, grouped like the dashboard auth-settings tabs.
type ProjectConfigAuthCORS ¶ added in v0.0.5
type ProjectConfigAuthCORS struct {
AllowCredentials *bool `json:"allow_credentials,omitempty"`
AllowedOrigins *[]string `json:"allowed_origins,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
MaxAge *int `json:"max_age,omitempty"`
}
ProjectConfigAuthCORS defines model for ProjectConfigAuthCORS.
type ProjectConfigAuthEmail ¶ added in v0.0.5
type ProjectConfigAuthEmail struct {
// Enabled Enable transactional email sending
Enabled *bool `json:"enabled,omitempty"`
From *ProjectConfigAuthEmailFrom `json:"from,omitempty"`
Smtp *ProjectConfigAuthEmailSMTP `json:"smtp,omitempty"`
// Templates Email templates keyed by type. Fully synced when declared - template
// types absent from a declared map revert to server defaults (custom
// bodies deleted, subject overrides cleared). Custom template bodies
// require the PRO plan; subject-only changes are available on FREE.
Templates *ProjectConfigEmailTemplates `json:"templates,omitempty"`
}
ProjectConfigAuthEmail defines model for ProjectConfigAuthEmail.
type ProjectConfigAuthEmailFrom ¶ added in v0.0.5
type ProjectConfigAuthEmailFrom struct {
Address *string `json:"address,omitempty"`
Name *string `json:"name,omitempty"`
}
ProjectConfigAuthEmailFrom defines model for ProjectConfigAuthEmailFrom.
type ProjectConfigAuthEmailPasswordProvider ¶ added in v0.0.5
type ProjectConfigAuthEmailPasswordProvider struct {
Enabled *bool `json:"enabled,omitempty"`
}
ProjectConfigAuthEmailPasswordProvider defines model for ProjectConfigAuthEmailPasswordProvider.
type ProjectConfigAuthEmailSMTP ¶ added in v0.0.5
type ProjectConfigAuthEmailSMTP struct {
Host *string `json:"host,omitempty"`
// Password Write-only; omitted from config export.
Password *string `json:"password,omitempty"`
Port *int `json:"port,omitempty"`
UseTls *bool `json:"use_tls,omitempty"`
Username *string `json:"username,omitempty"`
}
ProjectConfigAuthEmailSMTP defines model for ProjectConfigAuthEmailSMTP.
type ProjectConfigAuthEmailVerification ¶ added in v0.0.5
type ProjectConfigAuthEmailVerification struct {
// ConfirmationTimeout Email confirmation token expiry in seconds
ConfirmationTimeout *int `json:"confirmation_timeout,omitempty"`
// RequireConfirmation Require users to confirm email before sign-in. Requires email sending to be enabled.
RequireConfirmation *bool `json:"require_confirmation,omitempty"`
}
ProjectConfigAuthEmailVerification defines model for ProjectConfigAuthEmailVerification.
type ProjectConfigAuthManagedPages ¶ added in v0.0.5
type ProjectConfigAuthManagedPages struct {
// Enabled Enable or disable managed auth hosted pages
Enabled *bool `json:"enabled,omitempty"`
// Pages Hosted auth pages keyed by page type (PRO plan). Upsert-only: omitted
// pages are left untouched (there is no delete for hosted pages).
Pages *ProjectConfigHostedPages `json:"pages,omitempty"`
Redirects *ProjectConfigAuthRedirects `json:"redirects,omitempty"`
}
ProjectConfigAuthManagedPages defines model for ProjectConfigAuthManagedPages.
type ProjectConfigAuthPassword ¶ added in v0.0.5
type ProjectConfigAuthPassword struct {
MinLength *int `json:"min_length,omitempty"`
RequireLowercase *bool `json:"require_lowercase,omitempty"`
RequireNumbers *bool `json:"require_numbers,omitempty"`
RequireSpecialChars *bool `json:"require_special_chars,omitempty"`
RequireUppercase *bool `json:"require_uppercase,omitempty"`
}
ProjectConfigAuthPassword defines model for ProjectConfigAuthPassword.
type ProjectConfigAuthPasswordReset ¶ added in v0.0.5
type ProjectConfigAuthPasswordReset struct {
Allow *bool `json:"allow,omitempty"`
// MaxHistory Number of previous passwords to disallow (0=disabled)
MaxHistory *int `json:"max_history,omitempty"`
// Timeout Password reset token expiry in seconds
Timeout *int `json:"timeout,omitempty"`
}
ProjectConfigAuthPasswordReset defines model for ProjectConfigAuthPasswordReset.
type ProjectConfigAuthProviders ¶ added in v0.0.5
type ProjectConfigAuthProviders struct {
EmailPassword *ProjectConfigAuthEmailPasswordProvider `json:"email_password,omitempty"`
// Oauth Fully synced when declared - providers absent from this list are deleted.
Oauth *[]ProjectConfigOAuthProvider `json:"oauth,omitempty"`
}
ProjectConfigAuthProviders defines model for ProjectConfigAuthProviders.
type ProjectConfigAuthRateLimits ¶ added in v0.0.5
type ProjectConfigAuthRateLimits struct {
PasswordReset *int `json:"password_reset,omitempty"`
Signin *int `json:"signin,omitempty"`
Signup *int `json:"signup,omitempty"`
TokenRefresh *int `json:"token_refresh,omitempty"`
}
ProjectConfigAuthRateLimits Rate limits per hour.
type ProjectConfigAuthRedirects ¶ added in v0.0.5
type ProjectConfigAuthRedirects struct {
// Allowed Redirect allowlist. Every entry must be a valid http/https URL.
Allowed *[]string `json:"allowed,omitempty"`
// DeviceVerification Optional custom device-authorization verification page URL.
DeviceVerification *string `json:"device_verification,omitempty"`
// PostAuth Must be included in `allowed` when set.
PostAuth *string `json:"post_auth,omitempty"`
// PostLogout Must be included in `allowed` when set.
PostLogout *string `json:"post_logout,omitempty"`
}
ProjectConfigAuthRedirects defines model for ProjectConfigAuthRedirects.
type ProjectConfigAuthSessions ¶ added in v0.0.5
type ProjectConfigAuthSessions struct {
// InactivityTimeout Force re-login after inactivity (seconds, 0=never)
InactivityTimeout *int `json:"inactivity_timeout,omitempty"`
// MaxSessionDuration Force re-login after duration (seconds, 0=never)
MaxSessionDuration *int `json:"max_session_duration,omitempty"`
}
ProjectConfigAuthSessions defines model for ProjectConfigAuthSessions.
type ProjectConfigAuthSignup ¶ added in v0.0.5
type ProjectConfigAuthSignup struct {
EnableAnonymousSignins *bool `json:"enable_anonymous_signins,omitempty"`
// EnableSignup Master switch for signups across ALL providers
EnableSignup *bool `json:"enable_signup,omitempty"`
}
ProjectConfigAuthSignup defines model for ProjectConfigAuthSignup.
type ProjectConfigAuthTokens ¶ added in v0.0.5
type ProjectConfigAuthTokens struct {
AccessTokenLifetime *int `json:"access_token_lifetime,omitempty"`
PlatformTokenTtl *int `json:"platform_token_ttl,omitempty"`
RefreshTokenLifetime *int `json:"refresh_token_lifetime,omitempty"`
RefreshTokenReuseInterval *int `json:"refresh_token_reuse_interval,omitempty"`
}
ProjectConfigAuthTokens Token lifetimes in seconds.
type ProjectConfigBucket ¶ added in v0.0.5
type ProjectConfigBucket struct {
AllowedMimeTypes *[]string `json:"allowed_mime_types,omitempty"`
// FileSizeLimit Maximum file size in bytes
FileSizeLimit *int64 `json:"file_size_limit,omitempty"`
Name string `json:"name"`
Policies *[]ProjectConfigBucketPolicy `json:"policies,omitempty"`
}
ProjectConfigBucket Settings for an existing storage bucket. Buckets are never created or deleted through the manifest. When `policies` is declared it is fully synced (policies absent from the list are deleted; an empty list deletes all); omitting `policies` leaves the bucket's policies untouched.
type ProjectConfigBucketPolicy ¶ added in v0.0.5
type ProjectConfigBucketPolicy struct {
// Definition Policy expression
Definition string `json:"definition"`
Name string `json:"name"`
Operation ProjectConfigBucketPolicyOperation `json:"operation"`
}
ProjectConfigBucketPolicy defines model for ProjectConfigBucketPolicy.
type ProjectConfigBucketPolicyOperation ¶ added in v0.0.5
type ProjectConfigBucketPolicyOperation string
ProjectConfigBucketPolicyOperation defines model for ProjectConfigBucketPolicy.Operation.
const ( ProjectConfigBucketPolicyOperationDELETE ProjectConfigBucketPolicyOperation = "DELETE" ProjectConfigBucketPolicyOperationINSERT ProjectConfigBucketPolicyOperation = "INSERT" ProjectConfigBucketPolicyOperationSELECT ProjectConfigBucketPolicyOperation = "SELECT" ProjectConfigBucketPolicyOperationUPDATE ProjectConfigBucketPolicyOperation = "UPDATE" )
Defines values for ProjectConfigBucketPolicyOperation.
func (ProjectConfigBucketPolicyOperation) Valid ¶ added in v0.0.5
func (e ProjectConfigBucketPolicyOperation) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigBucketPolicyOperation enum.
type ProjectConfigCustomDomain ¶ added in v0.0.5
type ProjectConfigCustomDomain struct {
// Domain Fully-qualified domain name (hostname only, no scheme/path)
Domain string `json:"domain"`
Tls *FrontendCustomDomainTLSConfig `json:"tls,omitempty"`
}
ProjectConfigCustomDomain Custom domain with BYOC TLS (PRO plan). `tls` is required when the domain is first created and optional afterwards: providing new TLS material for the same domain rotates the certificate in place (zero downtime); omitting `tls` keeps the stored certificate. TLS material is write-only and omitted from config export.
type ProjectConfigDatabase ¶ added in v0.0.5
type ProjectConfigDatabase struct {
// DatabaseType Compute tier. Asserted, never written - tier changes are not
// supported via the manifest; use the databases API/CLI/GUI instead.
DatabaseType *ProjectConfigDatabaseDatabaseType `json:"database_type,omitempty"`
Name string `json:"name"`
// PgVersion PostgreSQL major version. Asserted, never written.
PgVersion ProjectConfigDatabasePgVersion `json:"pg_version"`
// Region Deployed region (aws- prefixed, e.g. aws-us-east-1). Asserted, never written.
Region string `json:"region"`
}
ProjectConfigDatabase Assertion-only entry for an existing database. No database property is mutable through the manifest; declared values are compared against the deployed database and any mismatch fails validation. Databases are never created or deleted here.
type ProjectConfigDatabaseDatabaseType ¶ added in v0.0.5
type ProjectConfigDatabaseDatabaseType string
ProjectConfigDatabaseDatabaseType Compute tier. Asserted, never written - tier changes are not supported via the manifest; use the databases API/CLI/GUI instead.
const ( ProjectConfigDatabaseDatabaseTypeVolcanoDb2xl ProjectConfigDatabaseDatabaseType = "volcano-db-2xl" ProjectConfigDatabaseDatabaseTypeVolcanoDbL ProjectConfigDatabaseDatabaseType = "volcano-db-l" ProjectConfigDatabaseDatabaseTypeVolcanoDbM ProjectConfigDatabaseDatabaseType = "volcano-db-m" ProjectConfigDatabaseDatabaseTypeVolcanoDbS ProjectConfigDatabaseDatabaseType = "volcano-db-s" ProjectConfigDatabaseDatabaseTypeVolcanoDbXl ProjectConfigDatabaseDatabaseType = "volcano-db-xl" ProjectConfigDatabaseDatabaseTypeVolcanoDbXs ProjectConfigDatabaseDatabaseType = "volcano-db-xs" )
Defines values for ProjectConfigDatabaseDatabaseType.
func (ProjectConfigDatabaseDatabaseType) Valid ¶ added in v0.0.5
func (e ProjectConfigDatabaseDatabaseType) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigDatabaseDatabaseType enum.
type ProjectConfigDatabasePgVersion ¶ added in v0.0.5
type ProjectConfigDatabasePgVersion string
ProjectConfigDatabasePgVersion PostgreSQL major version. Asserted, never written.
const ( ProjectConfigDatabasePgVersionN15 ProjectConfigDatabasePgVersion = "15" ProjectConfigDatabasePgVersionN16 ProjectConfigDatabasePgVersion = "16" )
Defines values for ProjectConfigDatabasePgVersion.
func (ProjectConfigDatabasePgVersion) Valid ¶ added in v0.0.5
func (e ProjectConfigDatabasePgVersion) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigDatabasePgVersion enum.
type ProjectConfigEmailTemplate ¶ added in v0.0.5
type ProjectConfigEmailTemplate struct {
// HtmlBody HTML body. Max 256 KiB. PRO plan required for custom bodies.
HtmlBody *string `json:"html_body,omitempty"`
Subject *string `json:"subject,omitempty"`
// TextBody Plain-text body. Max 256 KiB. PRO plan required for custom bodies.
TextBody *string `json:"text_body,omitempty"`
}
ProjectConfigEmailTemplate defines model for ProjectConfigEmailTemplate.
type ProjectConfigEmailTemplates ¶ added in v0.0.5
type ProjectConfigEmailTemplates struct {
Confirmation *ProjectConfigEmailTemplate `json:"confirmation,omitempty"`
PasswordChanged *ProjectConfigEmailTemplate `json:"password_changed,omitempty"`
PasswordReset *ProjectConfigEmailTemplate `json:"password_reset,omitempty"`
Welcome *ProjectConfigEmailTemplate `json:"welcome,omitempty"`
}
ProjectConfigEmailTemplates Email templates keyed by type. Fully synced when declared - template types absent from a declared map revert to server defaults (custom bodies deleted, subject overrides cleared). Custom template bodies require the PRO plan; subject-only changes are available on FREE.
type ProjectConfigFrontend ¶ added in v0.0.5
type ProjectConfigFrontend struct {
// CustomDomain Custom domain with BYOC TLS (PRO plan). `tls` is required when the
// domain is first created and optional afterwards: providing new TLS
// material for the same domain rotates the certificate in place (zero
// downtime); omitting `tls` keeps the stored certificate. TLS material is
// write-only and omitted from config export.
CustomDomain *ProjectConfigCustomDomain `json:"custom_domain,omitempty"`
Name string `json:"name"`
}
ProjectConfigFrontend Configuration for an existing (deployed) frontend. Frontends are never created or deleted through the manifest. A declared frontend entry without `custom_domain` deletes an existing custom domain.
type ProjectConfigFunction ¶ added in v0.0.5
type ProjectConfigFunction struct {
Name string `json:"name"`
// Public Function visibility for anon-key invocation
Public *bool `json:"public,omitempty"`
Schedulers *[]ProjectConfigScheduler `json:"schedulers,omitempty"`
}
ProjectConfigFunction Configuration for an existing (deployed) function. Functions are never created or deleted through the manifest. When `schedulers` is declared it is fully synced (schedulers absent from the list are deleted); omitting `schedulers` leaves the function's schedulers untouched.
type ProjectConfigHostedPage ¶ added in v0.0.5
type ProjectConfigHostedPage struct {
// Css Optional CSS injected at render time. Max 256 KiB.
Css *string `json:"css,omitempty"`
// Html Raw HTML markup for the page. Max 256 KiB.
Html string `json:"html"`
}
ProjectConfigHostedPage defines model for ProjectConfigHostedPage.
type ProjectConfigHostedPages ¶ added in v0.0.5
type ProjectConfigHostedPages struct {
Login *ProjectConfigHostedPage `json:"login,omitempty"`
ResetPassword *ProjectConfigHostedPage `json:"reset_password,omitempty"`
}
ProjectConfigHostedPages Hosted auth pages keyed by page type (PRO plan). Upsert-only: omitted pages are left untouched (there is no delete for hosted pages).
type ProjectConfigMissingResource ¶ added in v0.0.5
type ProjectConfigMissingResource struct {
Name string `json:"name"`
Type ProjectConfigMissingResourceType `json:"type"`
}
ProjectConfigMissingResource defines model for ProjectConfigMissingResource.
type ProjectConfigMissingResourceType ¶ added in v0.0.5
type ProjectConfigMissingResourceType string
ProjectConfigMissingResourceType defines model for ProjectConfigMissingResource.Type.
const ( ProjectConfigMissingResourceTypeBucket ProjectConfigMissingResourceType = "bucket" ProjectConfigMissingResourceTypeDatabase ProjectConfigMissingResourceType = "database" ProjectConfigMissingResourceTypeFrontend ProjectConfigMissingResourceType = "frontend" ProjectConfigMissingResourceTypeFunction ProjectConfigMissingResourceType = "function" )
Defines values for ProjectConfigMissingResourceType.
func (ProjectConfigMissingResourceType) Valid ¶ added in v0.0.5
func (e ProjectConfigMissingResourceType) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigMissingResourceType enum.
type ProjectConfigOAuthProvider ¶ added in v0.0.5
type ProjectConfigOAuthProvider struct {
// ClientId Required for non-device providers. Server-generated for
// `provider=device` (exported read-only, ignored on apply).
ClientId *string `json:"client_id,omitempty"`
// ClientSecret Write-only; omitted from config export. Not used for `provider=device`.
ClientSecret *string `json:"client_secret,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
Provider ProjectConfigOAuthProviderProvider `json:"provider"`
// RedirectUrl Not used for `provider=device`.
RedirectUrl *string `json:"redirect_url,omitempty"`
Scopes *[]string `json:"scopes,omitempty"`
}
ProjectConfigOAuthProvider defines model for ProjectConfigOAuthProvider.
type ProjectConfigOAuthProviderProvider ¶ added in v0.0.5
type ProjectConfigOAuthProviderProvider string
ProjectConfigOAuthProviderProvider defines model for ProjectConfigOAuthProvider.Provider.
const ( ProjectConfigOAuthProviderProviderApple ProjectConfigOAuthProviderProvider = "apple" ProjectConfigOAuthProviderProviderDevice ProjectConfigOAuthProviderProvider = "device" ProjectConfigOAuthProviderProviderGithub ProjectConfigOAuthProviderProvider = "github" ProjectConfigOAuthProviderProviderGoogle ProjectConfigOAuthProviderProvider = "google" ProjectConfigOAuthProviderProviderMicrosoft ProjectConfigOAuthProviderProvider = "microsoft" )
Defines values for ProjectConfigOAuthProviderProvider.
func (ProjectConfigOAuthProviderProvider) Valid ¶ added in v0.0.5
func (e ProjectConfigOAuthProviderProvider) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigOAuthProviderProvider enum.
type ProjectConfigProject ¶ added in v0.0.5
type ProjectConfigProject struct {
// AllRegions Region policy. `false` requires `selected_regions` (PRO plan).
AllRegions *bool `json:"all_regions,omitempty"`
Name *string `json:"name,omitempty"`
// SelectedRegions Region subset (bare AWS names). Requires `all_regions=false`.
SelectedRegions *[]string `json:"selected_regions,omitempty"`
}
ProjectConfigProject Project-level settings. `name` renames the project.
type ProjectConfigRealtime ¶ added in v0.0.5
type ProjectConfigRealtime struct {
BroadcastEnabled *bool `json:"broadcast_enabled,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
PostgresChangesEnabled *bool `json:"postgres_changes_enabled,omitempty"`
PresenceEnabled *bool `json:"presence_enabled,omitempty"`
}
ProjectConfigRealtime defines model for ProjectConfigRealtime.
type ProjectConfigScheduler ¶ added in v0.0.5
type ProjectConfigScheduler struct {
// Cron 5-field UTC cron expression
Cron string `json:"cron"`
Enabled *bool `json:"enabled,omitempty"`
Name string `json:"name"`
Payload *map[string]interface{} `json:"payload,omitempty"`
}
ProjectConfigScheduler defines model for ProjectConfigScheduler.
type ProjectConfigSkippedResource ¶ added in v0.0.5
type ProjectConfigSkippedResource struct {
Name string `json:"name"`
Reason string `json:"reason"`
Type ProjectConfigSkippedResourceType `json:"type"`
}
ProjectConfigSkippedResource defines model for ProjectConfigSkippedResource.
type ProjectConfigSkippedResourceType ¶ added in v0.0.5
type ProjectConfigSkippedResourceType string
ProjectConfigSkippedResourceType defines model for ProjectConfigSkippedResource.Type.
const ( ProjectConfigSkippedResourceTypeBucket ProjectConfigSkippedResourceType = "bucket" ProjectConfigSkippedResourceTypeDatabase ProjectConfigSkippedResourceType = "database" ProjectConfigSkippedResourceTypeFrontend ProjectConfigSkippedResourceType = "frontend" ProjectConfigSkippedResourceTypeFunction ProjectConfigSkippedResourceType = "function" )
Defines values for ProjectConfigSkippedResourceType.
func (ProjectConfigSkippedResourceType) Valid ¶ added in v0.0.5
func (e ProjectConfigSkippedResourceType) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigSkippedResourceType enum.
type ProjectConfigValidationError ¶ added in v0.0.5
type ProjectConfigValidationError struct {
Message string `json:"message"`
// Name Resource name or key within the section, when applicable.
Name *string `json:"name,omitempty"`
// Section Manifest section the error refers to (e.g. databases, functions).
Section string `json:"section"`
}
ProjectConfigValidationError defines model for ProjectConfigValidationError.
type ProjectConfigValidationErrorResponse ¶ added in v0.0.5
type ProjectConfigValidationErrorResponse struct {
Error string `json:"error"`
Errors []ProjectConfigValidationError `json:"errors"`
}
ProjectConfigValidationErrorResponse Returned when manifest validation fails. Nothing was applied.
type ProjectConfigVariable ¶ added in v0.0.5
ProjectConfigVariable defines model for ProjectConfigVariable.
type ProjectConfigVersion ¶ added in v0.0.5
type ProjectConfigVersion int
ProjectConfigVersion Manifest schema version. Must be 1.
const (
N1 ProjectConfigVersion = 1
)
Defines values for ProjectConfigVersion.
func (ProjectConfigVersion) Valid ¶ added in v0.0.5
func (e ProjectConfigVersion) Valid() bool
Valid indicates whether the value is a known member of the ProjectConfigVersion enum.
type ProjectFrontendCustomDomain ¶ added in v0.0.4
type ProjectFrontendCustomDomain struct {
CreatedAt time.Time `json:"created_at"`
Domain string `json:"domain"`
DomainStatus ProjectFrontendCustomDomainDomainStatus `json:"domain_status"`
EffectiveUrls []string `json:"effective_urls"`
// Frontend The frontend this custom domain is attached to. Inlined to
// avoid a second fetch from the project-scoped feed.
Frontend struct {
Id openapi_types.UUID `json:"id"`
Name string `json:"name"`
} `json:"frontend"`
RequiredRoutingRecord *FrontendDomainRoutingRecord `json:"required_routing_record,omitempty"`
TlsMode ProjectFrontendCustomDomainTlsMode `json:"tls_mode"`
UpdatedAt time.Time `json:"updated_at"`
VerificationRecords *[]FrontendDomainVerificationRecord `json:"verification_records,omitempty"`
VerificationStatus ProjectFrontendCustomDomainVerificationStatus `json:"verification_status"`
}
ProjectFrontendCustomDomain defines model for ProjectFrontendCustomDomain.
type ProjectFrontendCustomDomainDomainStatus ¶ added in v0.0.4
type ProjectFrontendCustomDomainDomainStatus string
ProjectFrontendCustomDomainDomainStatus defines model for ProjectFrontendCustomDomain.DomainStatus.
const ( ProjectFrontendCustomDomainDomainStatusActive ProjectFrontendCustomDomainDomainStatus = "active" ProjectFrontendCustomDomainDomainStatusDeleted ProjectFrontendCustomDomainDomainStatus = "deleted" ProjectFrontendCustomDomainDomainStatusDetaching ProjectFrontendCustomDomainDomainStatus = "detaching" ProjectFrontendCustomDomainDomainStatusFailed ProjectFrontendCustomDomainDomainStatus = "failed" ProjectFrontendCustomDomainDomainStatusPendingVerification ProjectFrontendCustomDomainDomainStatus = "pending_verification" ProjectFrontendCustomDomainDomainStatusProvisioning ProjectFrontendCustomDomainDomainStatus = "provisioning" )
Defines values for ProjectFrontendCustomDomainDomainStatus.
func (ProjectFrontendCustomDomainDomainStatus) Valid ¶ added in v0.0.4
func (e ProjectFrontendCustomDomainDomainStatus) Valid() bool
Valid indicates whether the value is a known member of the ProjectFrontendCustomDomainDomainStatus enum.
type ProjectFrontendCustomDomainTlsMode ¶ added in v0.0.4
type ProjectFrontendCustomDomainTlsMode string
ProjectFrontendCustomDomainTlsMode defines model for ProjectFrontendCustomDomain.TlsMode.
const ( Byoc ProjectFrontendCustomDomainTlsMode = "byoc" Managed ProjectFrontendCustomDomainTlsMode = "managed" )
Defines values for ProjectFrontendCustomDomainTlsMode.
func (ProjectFrontendCustomDomainTlsMode) Valid ¶ added in v0.0.4
func (e ProjectFrontendCustomDomainTlsMode) Valid() bool
Valid indicates whether the value is a known member of the ProjectFrontendCustomDomainTlsMode enum.
type ProjectFrontendCustomDomainVerificationStatus ¶ added in v0.0.4
type ProjectFrontendCustomDomainVerificationStatus string
ProjectFrontendCustomDomainVerificationStatus defines model for ProjectFrontendCustomDomain.VerificationStatus.
const ( ProjectFrontendCustomDomainVerificationStatusPending ProjectFrontendCustomDomainVerificationStatus = "pending" ProjectFrontendCustomDomainVerificationStatusVerified ProjectFrontendCustomDomainVerificationStatus = "verified" )
Defines values for ProjectFrontendCustomDomainVerificationStatus.
func (ProjectFrontendCustomDomainVerificationStatus) Valid ¶ added in v0.0.4
func (e ProjectFrontendCustomDomainVerificationStatus) Valid() bool
Valid indicates whether the value is a known member of the ProjectFrontendCustomDomainVerificationStatus enum.
type ProjectFrontendDeployment ¶ added in v0.0.4
type ProjectFrontendDeployment struct {
ArtifactBucket *string `json:"artifact_bucket,omitempty"`
ArtifactKey *string `json:"artifact_key,omitempty"`
ArtifactVersion *string `json:"artifact_version,omitempty"`
CloudformationStackId *string `json:"cloudformation_stack_id,omitempty"`
CloudformationStackUrl *string `json:"cloudformation_stack_url,omitempty"`
CloudwatchLogGroup *string `json:"cloudwatch_log_group,omitempty"`
// CodebuildBuildCount Number of completed CodeBuild builds included in codebuild_duration_seconds.
CodebuildBuildCount *int `json:"codebuild_build_count,omitempty"`
CodebuildDurationRecordedAt *time.Time `json:"codebuild_duration_recorded_at,omitempty"`
// CodebuildDurationSeconds Total CodeBuild build duration recorded for this deployment, in seconds.
CodebuildDurationSeconds *int64 `json:"codebuild_duration_seconds,omitempty"`
CreatedAt time.Time `json:"created_at"`
ErrorMessage *string `json:"error_message,omitempty"`
// Frontend The frontend this deployment belongs to. Inlined to avoid a
// second fetch from the project-scoped feed.
Frontend struct {
Id openapi_types.UUID `json:"id"`
Name string `json:"name"`
} `json:"frontend"`
FrontendId openapi_types.UUID `json:"frontend_id"`
Id openapi_types.UUID `json:"id"`
Operation ProjectFrontendDeploymentOperation `json:"operation"`
ProjectId openapi_types.UUID `json:"project_id"`
SiteUrl *string `json:"site_url,omitempty"`
Status ProjectFrontendDeploymentStatus `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
ProjectFrontendDeployment defines model for ProjectFrontendDeployment.
type ProjectFrontendDeploymentOperation ¶ added in v0.0.4
type ProjectFrontendDeploymentOperation string
ProjectFrontendDeploymentOperation defines model for ProjectFrontendDeployment.Operation.
const ( ProjectFrontendDeploymentOperationDelete ProjectFrontendDeploymentOperation = "delete" ProjectFrontendDeploymentOperationDeploy ProjectFrontendDeploymentOperation = "deploy" ProjectFrontendDeploymentOperationRedeploy ProjectFrontendDeploymentOperation = "redeploy" )
Defines values for ProjectFrontendDeploymentOperation.
func (ProjectFrontendDeploymentOperation) Valid ¶ added in v0.0.4
func (e ProjectFrontendDeploymentOperation) Valid() bool
Valid indicates whether the value is a known member of the ProjectFrontendDeploymentOperation enum.
type ProjectFrontendDeploymentStatus ¶ added in v0.0.4
type ProjectFrontendDeploymentStatus string
ProjectFrontendDeploymentStatus defines model for ProjectFrontendDeployment.Status.
const ( ProjectFrontendDeploymentStatusActive ProjectFrontendDeploymentStatus = "active" ProjectFrontendDeploymentStatusDeleted ProjectFrontendDeploymentStatus = "deleted" ProjectFrontendDeploymentStatusDeleting ProjectFrontendDeploymentStatus = "deleting" ProjectFrontendDeploymentStatusFailed ProjectFrontendDeploymentStatus = "failed" ProjectFrontendDeploymentStatusProvisioning ProjectFrontendDeploymentStatus = "provisioning" )
Defines values for ProjectFrontendDeploymentStatus.
func (ProjectFrontendDeploymentStatus) Valid ¶ added in v0.0.4
func (e ProjectFrontendDeploymentStatus) Valid() bool
Valid indicates whether the value is a known member of the ProjectFrontendDeploymentStatus enum.
type ProjectHealthComponent ¶ added in v0.0.5
type ProjectHealthComponent struct {
Counts ProjectHealthCounts `json:"counts"`
Name ProjectHealthComponentName `json:"name"`
Status ProjectHealthStatus `json:"status"`
}
ProjectHealthComponent defines model for ProjectHealthComponent.
type ProjectHealthComponentName ¶ added in v0.0.5
type ProjectHealthComponentName string
ProjectHealthComponentName defines model for ProjectHealthComponent.Name.
const ( ProjectHealthComponentNameDatabases ProjectHealthComponentName = "databases" ProjectHealthComponentNameFrontends ProjectHealthComponentName = "frontends" ProjectHealthComponentNameFunctions ProjectHealthComponentName = "functions" ProjectHealthComponentNameProject ProjectHealthComponentName = "project" )
Defines values for ProjectHealthComponentName.
func (ProjectHealthComponentName) Valid ¶ added in v0.0.5
func (e ProjectHealthComponentName) Valid() bool
Valid indicates whether the value is a known member of the ProjectHealthComponentName enum.
type ProjectHealthCounts ¶ added in v0.0.5
type ProjectHealthCounts struct {
Active int `json:"active"`
Deleting int `json:"deleting"`
Failed int `json:"failed"`
Provisioning int `json:"provisioning"`
Total int `json:"total"`
Unknown int `json:"unknown"`
}
ProjectHealthCounts defines model for ProjectHealthCounts.
type ProjectHealthIssue ¶ added in v0.0.5
type ProjectHealthIssue struct {
CreatedAt time.Time `json:"created_at"`
LastError *string `json:"last_error,omitempty"`
Message string `json:"message"`
ProvisioningStartedAt *time.Time `json:"provisioning_started_at,omitempty"`
Resource ProjectHealthResource `json:"resource"`
Severity ProjectHealthIssueSeverity `json:"severity"`
Status string `json:"status"`
UpdatedAt time.Time `json:"updated_at"`
}
ProjectHealthIssue defines model for ProjectHealthIssue.
type ProjectHealthIssueSeverity ¶ added in v0.0.5
type ProjectHealthIssueSeverity string
ProjectHealthIssueSeverity defines model for ProjectHealthIssueSeverity.
const ( Critical ProjectHealthIssueSeverity = "critical" Warning ProjectHealthIssueSeverity = "warning" )
Defines values for ProjectHealthIssueSeverity.
func (ProjectHealthIssueSeverity) Valid ¶ added in v0.0.5
func (e ProjectHealthIssueSeverity) Valid() bool
Valid indicates whether the value is a known member of the ProjectHealthIssueSeverity enum.
type ProjectHealthResource ¶ added in v0.0.5
type ProjectHealthResource struct {
Id openapi_types.UUID `json:"id"`
Name string `json:"name"`
Type ProjectHealthResourceType `json:"type"`
}
ProjectHealthResource defines model for ProjectHealthResource.
type ProjectHealthResourceType ¶ added in v0.0.5
type ProjectHealthResourceType string
ProjectHealthResourceType defines model for ProjectHealthResource.Type.
const ( ProjectHealthResourceTypeDatabase ProjectHealthResourceType = "database" ProjectHealthResourceTypeFrontend ProjectHealthResourceType = "frontend" ProjectHealthResourceTypeFunction ProjectHealthResourceType = "function" ProjectHealthResourceTypeProject ProjectHealthResourceType = "project" )
Defines values for ProjectHealthResourceType.
func (ProjectHealthResourceType) Valid ¶ added in v0.0.5
func (e ProjectHealthResourceType) Valid() bool
Valid indicates whether the value is a known member of the ProjectHealthResourceType enum.
type ProjectHealthResponse ¶ added in v0.0.5
type ProjectHealthResponse struct {
CheckedAt time.Time `json:"checked_at"`
Components []ProjectHealthComponent `json:"components"`
Counts ProjectHealthCounts `json:"counts"`
Issues []ProjectHealthIssue `json:"issues"`
ProjectId openapi_types.UUID `json:"project_id"`
Status ProjectHealthStatus `json:"status"`
}
ProjectHealthResponse defines model for ProjectHealthResponse.
type ProjectHealthStatus ¶ added in v0.0.5
type ProjectHealthStatus string
ProjectHealthStatus defines model for ProjectHealthStatus.
const ( Degraded ProjectHealthStatus = "degraded" Healthy ProjectHealthStatus = "healthy" Unhealthy ProjectHealthStatus = "unhealthy" )
Defines values for ProjectHealthStatus.
func (ProjectHealthStatus) Valid ¶ added in v0.0.5
func (e ProjectHealthStatus) Valid() bool
Valid indicates whether the value is a known member of the ProjectHealthStatus enum.
type ProjectPlan ¶
type ProjectPlan string
ProjectPlan Platform plan applied to the project when available
const ( FREE ProjectPlan = "FREE" PRO ProjectPlan = "PRO" )
Defines values for ProjectPlan.
func (ProjectPlan) Valid ¶
func (e ProjectPlan) Valid() bool
Valid indicates whether the value is a known member of the ProjectPlan enum.
type ProjectStatus ¶
type ProjectStatus string
ProjectStatus defines model for Project.Status.
const ( ProjectStatusActive ProjectStatus = "active" ProjectStatusDeleting ProjectStatus = "deleting" ProjectStatusFailed ProjectStatus = "failed" )
Defines values for ProjectStatus.
func (ProjectStatus) Valid ¶
func (e ProjectStatus) Valid() bool
Valid indicates whether the value is a known member of the ProjectStatus enum.
type ProjectUsageResponse ¶
type ProjectUsageResponse struct {
// Frontends Per-frontend request totals for the current usage month
Frontends *[]FrontendUsageData `json:"frontends,omitempty"`
// Metrics Usage metrics for the project
Metrics []MetricUsageData `json:"metrics"`
// Month Usage month in YYYY-MM format
Month string `json:"month"`
// ProjectId Project ID
ProjectId openapi_types.UUID `json:"project_id"`
}
ProjectUsageResponse Aggregated usage metrics for a project.
type RealtimeConfig ¶
type RealtimeConfig struct {
// BroadcastEnabled Whether broadcast channels are enabled
BroadcastEnabled *bool `json:"broadcast_enabled,omitempty"`
// CreatedAt When the configuration was created
CreatedAt *time.Time `json:"created_at,omitempty"`
// Enabled Whether realtime is enabled for this project
Enabled *bool `json:"enabled,omitempty"`
// PostgresChangesEnabled Whether Postgres change notifications are enabled
PostgresChangesEnabled *bool `json:"postgres_changes_enabled,omitempty"`
// PresenceEnabled Whether presence tracking is enabled
PresenceEnabled *bool `json:"presence_enabled,omitempty"`
// ProjectId Project ID
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
// UpdatedAt When the configuration was last updated
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
RealtimeConfig Realtime configuration for a project. Note: Message size and channels per connection are plan-based (not configurable).
type RealtimePlanLimits ¶
type RealtimePlanLimits struct {
// ChannelsPerConn Maximum channels per connection
ChannelsPerConn *int `json:"channels_per_conn,omitempty"`
// MaxConnections Maximum concurrent connections allowed
MaxConnections *int `json:"max_connections,omitempty"`
// MessageSizeKb Maximum message size in KB
MessageSizeKb *int `json:"message_size_kb,omitempty"`
// MessagesPerMonth Maximum messages per month
MessagesPerMonth *int `json:"messages_per_month,omitempty"`
// Plan Plan name (FREE or PRO)
Plan *string `json:"plan,omitempty"`
}
RealtimePlanLimits Plan-based limits for realtime features
type RealtimeStats ¶
type RealtimeStats struct {
// LastInvokedAt Most recent realtime activity timestamp across channels
LastInvokedAt *time.Time `json:"last_invoked_at,omitempty"`
// Limits Plan-based limits for realtime features
Limits *RealtimePlanLimits `json:"limits,omitempty"`
// NumConnections Current number of active connections
NumConnections *int `json:"num_connections,omitempty"`
// PeakConnections Peak concurrent connections this usage period
PeakConnections *int `json:"peak_connections,omitempty"`
}
RealtimeStats Realtime usage statistics for a project
type ResolveFunctionResponse ¶
type ResolveFunctionResponse struct {
// CacheTtlSeconds Suggested SDK cache TTL for this name-to-ID mapping
CacheTtlSeconds int `json:"cache_ttl_seconds"`
// FunctionId Canonical function ID used for invocation routing
FunctionId openapi_types.UUID `json:"function_id"`
// Name DNS-safe function name
Name string `json:"name"`
}
ResolveFunctionResponse defines model for ResolveFunctionResponse.
type ScheduleRequest ¶
type ScheduleRequest struct {
// CronExpression Standard 5-field cron expression evaluated in UTC. Seconds fields, descriptors, and Quartz syntax are not supported.
CronExpression string `json:"cron_expression"`
Kind *ScheduleRequestKind `json:"kind,omitempty"`
}
ScheduleRequest defines model for ScheduleRequest.
type ScheduleRequestKind ¶
type ScheduleRequestKind string
ScheduleRequestKind defines model for ScheduleRequest.Kind.
const (
ScheduleRequestKindCron ScheduleRequestKind = "cron"
)
Defines values for ScheduleRequestKind.
func (ScheduleRequestKind) Valid ¶
func (e ScheduleRequestKind) Valid() bool
Valid indicates whether the value is a known member of the ScheduleRequestKind enum.
type ServiceKey ¶
type ServiceKey struct {
CreatedAt *time.Time `json:"created_at,omitempty"`
Id openapi_types.UUID `json:"id"`
// KeyPrefix First 12 characters of the key for display/identification
KeyPrefix string `json:"key_prefix"`
// KeyValue Full JWT token for Authorization header.
// Returned on create, get, and list (decrypted from storage).
// **Store securely - NEVER expose in frontend code!**
KeyValue *string `json:"key_value,omitempty"`
// Name Descriptive name for the key
Name string `json:"name"`
// Permissions Operations this key may perform. ["*"] grants full admin access
// (default for keys created without an explicit scope). Scoped keys
// list specific permissions, e.g. ["functions.invoke"].
Permissions []string `json:"permissions"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
ServiceKey Service role key for admin operations. **WARNING:** Bypasses all RLS - backend use only!
type StorageBucket ¶
type StorageBucket struct {
// AllowedMimeTypes Allowed MIME types (null for all types)
AllowedMimeTypes *[]string `json:"allowed_mime_types,omitempty"`
CreatedAt *time.Time `json:"created_at,omitempty"`
// FileSizeLimit Maximum file size in bytes (null for no limit)
FileSizeLimit *int64 `json:"file_size_limit,omitempty"`
Id openapi_types.UUID `json:"id"`
// LastInvokedAt Most recent bucket operation timestamp
LastInvokedAt *time.Time `json:"last_invoked_at,omitempty"`
// Name Bucket name (unique within project)
Name string `json:"name"`
ProjectId *openapi_types.UUID `json:"project_id,omitempty"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
StorageBucket A named container for files within a project. Public access is controlled at the file level via is_public on StorageObject.
type StorageCopyRequest ¶
type StorageCopyRequest struct {
// From Source path
From string `json:"from"`
// To Destination path
To string `json:"to"`
}
StorageCopyRequest defines model for StorageCopyRequest.
type StorageListResponse ¶
type StorageListResponse struct {
// NextCursor Cursor for next page (empty if no more results)
NextCursor *string `json:"next_cursor,omitempty"`
Objects *[]StorageObject `json:"objects,omitempty"`
}
StorageListResponse defines model for StorageListResponse.
type StorageMoveRequest ¶
type StorageMoveRequest struct {
// From Source path
From string `json:"from"`
// To Destination path
To string `json:"to"`
}
StorageMoveRequest defines model for StorageMoveRequest.
type StorageObject ¶
type StorageObject struct {
BucketId openapi_types.UUID `json:"bucket_id"`
CreatedAt *time.Time `json:"created_at,omitempty"`
// Etag S3 ETag for cache validation
Etag *string `json:"etag,omitempty"`
Id openapi_types.UUID `json:"id"`
// IsPublic If true, the file can be downloaded with just an anon key (no user authentication).
// Files are private by default. Only the owner or a service key can change visibility.
IsPublic bool `json:"is_public"`
// Metadata Custom user metadata (key-value pairs).
// Limits: Maximum 50 keys, maximum 10KB total serialized size.
Metadata *map[string]interface{} `json:"metadata,omitempty"`
// MimeType MIME type
MimeType string `json:"mime_type"`
// Name Full path within bucket (e.g., "users/abc123/avatar.png")
Name string `json:"name"`
// OwnerId Auth user who uploaded (null for anonymous/service)
OwnerId *openapi_types.UUID `json:"owner_id,omitempty"`
// PublicUrl Shareable public URL for this file (only set for public files with is_public=true).
// This URL requires NO authentication and can be embedded in HTML, shared via email, etc.
// The URL is properly URL-encoded by the server - use it as-is without additional encoding.
PublicUrl *string `json:"public_url,omitempty"`
// Size File size in bytes
Size int64 `json:"size"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
StorageObject defines model for StorageObject.
type StorageObjectWithBucket ¶
type StorageObjectWithBucket struct {
BucketId openapi_types.UUID `json:"bucket_id"`
// BucketName Name of the bucket containing this object
BucketName string `json:"bucket_name"`
CreatedAt *time.Time `json:"created_at,omitempty"`
Etag *string `json:"etag,omitempty"`
Id openapi_types.UUID `json:"id"`
IsPublic bool `json:"is_public"`
Metadata *map[string]interface{} `json:"metadata,omitempty"`
MimeType string `json:"mime_type"`
// Name Full path within bucket
Name string `json:"name"`
// OwnerId Auth user who uploaded (null for anonymous/service)
OwnerId *openapi_types.UUID `json:"owner_id,omitempty"`
// PublicUrl Shareable public URL for this file (only set for public files with is_public=true).
// This URL requires NO authentication and can be embedded in HTML, shared via email, etc.
PublicUrl *string `json:"public_url,omitempty"`
// Size File size in bytes
Size int64 `json:"size"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
StorageObjectWithBucket Storage object with bucket name included (for admin listing across buckets)
type StoragePolicy ¶
type StoragePolicy struct {
BucketId openapi_types.UUID `json:"bucket_id"`
CreatedAt *time.Time `json:"created_at,omitempty"`
// Definition Policy expression evaluated at request time.
// Examples:
// - "true" - Allow all
// - "auth.uid() = owner_id" - Owner only
// - "auth.role() = 'authenticated'" - Authenticated users
// - "(storage.foldername(name))[1] = auth.uid()::text" - User's folder
Definition string `json:"definition"`
Id openapi_types.UUID `json:"id"`
// Name Policy name (unique within bucket)
Name string `json:"name"`
// Operation Operation this policy applies to
Operation StoragePolicyOperation `json:"operation"`
UpdatedAt *time.Time `json:"updated_at,omitempty"`
}
StoragePolicy defines model for StoragePolicy.
type StoragePolicyOperation ¶
type StoragePolicyOperation string
StoragePolicyOperation Operation this policy applies to
const ( DELETE StoragePolicyOperation = "DELETE" INSERT StoragePolicyOperation = "INSERT" SELECT StoragePolicyOperation = "SELECT" UPDATE StoragePolicyOperation = "UPDATE" )
Defines values for StoragePolicyOperation.
func (StoragePolicyOperation) Valid ¶
func (e StoragePolicyOperation) Valid() bool
Valid indicates whether the value is a known member of the StoragePolicyOperation enum.
type StorageStats ¶
type StorageStats struct {
// BucketCount Number of storage buckets
BucketCount int `json:"bucket_count"`
// ObjectCount Total number of stored files
ObjectCount int `json:"object_count"`
// TotalSize Total storage used in bytes
TotalSize int64 `json:"total_size"`
}
StorageStats Aggregate storage statistics for a project
type StorageVisibilityRequest ¶
type StorageVisibilityRequest struct {
// IsPublic Whether the file should be publicly accessible
IsPublic bool `json:"is_public"`
}
StorageVisibilityRequest defines model for StorageVisibilityRequest.
type TestEmailRequest ¶ added in v0.0.4
type TestEmailRequest struct {
// HtmlBody Optional HTML body override. Rendered as an html/template. Max 256 KiB.
HtmlBody *string `json:"html_body,omitempty"`
// Subject Optional subject override, rendered as a text/template. Only
// applied on the override path — requires `html_body` or
// `text_body` to also be set, otherwise the request is
// rejected with 400.
Subject *string `json:"subject,omitempty"`
// TextBody Optional plain-text body override. Rendered as a text/template. Max 256 KiB.
TextBody *string `json:"text_body,omitempty"`
// ToEmail Recipient address for the diagnostic email.
ToEmail openapi_types.Email `json:"to_email"`
}
TestEmailRequest When `html_body` or `text_body` is provided the backend renders those (plus optional `subject`) through html/text templates against the standard `Data` (ProjectName, Name, SiteURL) and sends the result — used by the template-editor "Send Test" affordance to preview an unsaved template. When both bodies are omitted a hardcoded diagnostic message is sent to verify SMTP credentials and `subject` is ignored. Sending `subject` alone (without a body) is rejected with 400.
type TestEmailResponse ¶ added in v0.0.4
type TestEmailResponse struct {
Success bool `json:"success"`
}
TestEmailResponse defines model for TestEmailResponse.
type UnbanUserResponse ¶
type UnbanUserResponse struct {
Email openapi_types.Email `json:"email"`
Message string `json:"message"`
Status UnbanUserResponseStatus `json:"status"`
UserId openapi_types.UUID `json:"user_id"`
}
UnbanUserResponse Response when unbanning a user
type UnbanUserResponseStatus ¶
type UnbanUserResponseStatus string
UnbanUserResponseStatus defines model for UnbanUserResponse.Status.
const (
UnbanUserResponseStatusActive UnbanUserResponseStatus = "active"
)
Defines values for UnbanUserResponseStatus.
func (UnbanUserResponseStatus) Valid ¶
func (e UnbanUserResponseStatus) Valid() bool
Valid indicates whether the value is a known member of the UnbanUserResponseStatus enum.
type UpdateAuthConfigRequest ¶
type UpdateAuthConfigRequest struct {
AccessTokenLifetime *int `json:"access_token_lifetime,omitempty"`
AllowPasswordReset *bool `json:"allow_password_reset,omitempty"`
// AllowedRedirectUrls Redirect allowlist. Every entry must be a valid http/https URL.
AllowedRedirectUrls *[]string `json:"allowed_redirect_urls,omitempty"`
CorsAllowCredentials *bool `json:"cors_allow_credentials,omitempty"`
CorsMaxAge *int `json:"cors_max_age,omitempty"`
// DeviceVerificationUrl Optional custom device-authorization verification page. Must be a
// valid http/https URL (not tied to allowed_redirect_urls). When set,
// device-code logins return this URL (with user_code) instead of the
// managed device page. Send an empty string to clear the override.
DeviceVerificationUrl *string `json:"device_verification_url,omitempty"`
EmailConfirmationSubject *string `json:"email_confirmation_subject,omitempty"`
// EmailConfirmationTimeout Email confirmation token expiry in seconds.
EmailConfirmationTimeout *int `json:"email_confirmation_timeout,omitempty"`
// EmailEnabled Enable transactional email sending. Cannot be false while require_email_confirmation is true.
EmailEnabled *bool `json:"email_enabled,omitempty"`
EmailFromAddress *string `json:"email_from_address,omitempty"`
EmailFromName *string `json:"email_from_name,omitempty"`
EmailPasswordChangedSubject *string `json:"email_password_changed_subject,omitempty"`
EmailPasswordResetSubject *string `json:"email_password_reset_subject,omitempty"`
EnableAnonymousSignins *bool `json:"enable_anonymous_signins,omitempty"`
// EnableEmailPassword Enable/disable email/password provider
EnableEmailPassword *bool `json:"enable_email_password,omitempty"`
// EnableSignup Master switch for signups across ALL providers
EnableSignup *bool `json:"enable_signup,omitempty"`
InactivityTimeout *int `json:"inactivity_timeout,omitempty"`
// ManagedAuthEnabled Enable or disable managed auth hosted pages for the project.
ManagedAuthEnabled *bool `json:"managed_auth_enabled,omitempty"`
MaxPasswordHistory *int `json:"max_password_history,omitempty"`
MaxSessionDuration *int `json:"max_session_duration,omitempty"`
MinPasswordLength *int `json:"min_password_length,omitempty"`
PasswordResetTimeout *int `json:"password_reset_timeout,omitempty"`
// PostAuthRedirectUrl Must be included in allowed_redirect_urls when set.
PostAuthRedirectUrl *string `json:"post_auth_redirect_url,omitempty"`
// PostLogoutRedirectUrl Must be included in allowed_redirect_urls when set.
PostLogoutRedirectUrl *string `json:"post_logout_redirect_url,omitempty"`
RateLimitSignin *int `json:"rate_limit_signin,omitempty"`
RateLimitSignup *int `json:"rate_limit_signup,omitempty"`
RateLimitTokenRefresh *int `json:"rate_limit_token_refresh,omitempty"`
RefreshTokenLifetime *int `json:"refresh_token_lifetime,omitempty"`
// RequireEmailConfirmation Require users to confirm email before sign-in. Can only be true when email_enabled is true.
RequireEmailConfirmation *bool `json:"require_email_confirmation,omitempty"`
RequireLowercase *bool `json:"require_lowercase,omitempty"`
RequireNumbers *bool `json:"require_numbers,omitempty"`
RequireSpecialChars *bool `json:"require_special_chars,omitempty"`
RequireUppercase *bool `json:"require_uppercase,omitempty"`
SmtpHost *string `json:"smtp_host,omitempty"`
// SmtpPassword SMTP password (sensitive). Encrypted at rest (AES-256-GCM) when stored.
SmtpPassword *string `json:"smtp_password,omitempty"`
SmtpPort *int `json:"smtp_port,omitempty"`
SmtpUseTls *bool `json:"smtp_use_tls,omitempty"`
SmtpUsername *string `json:"smtp_username,omitempty"`
}
UpdateAuthConfigRequest All fields optional - only include fields you want to update. Validation rule: require_email_confirmation=true requires email_enabled=true.
type UpdateAuthHostedPageRequest ¶
type UpdateAuthHostedPageRequest struct {
// Css Optional CSS injected at render time. Max 256 KiB.
Css *string `json:"css,omitempty"`
// Html Raw HTML markup for the page. Max 256 KiB.
Html string `json:"html"`
}
UpdateAuthHostedPageRequest defines model for UpdateAuthHostedPageRequest.
type UpdateDatabaseTypeRequest ¶
type UpdateDatabaseTypeRequest struct {
// DatabaseType New compute size tier
DatabaseType UpdateDatabaseTypeRequestDatabaseType `json:"database_type"`
}
UpdateDatabaseTypeRequest Update database compute size tier
type UpdateDatabaseTypeRequestDatabaseType ¶
type UpdateDatabaseTypeRequestDatabaseType string
UpdateDatabaseTypeRequestDatabaseType New compute size tier
const ( UpdateDatabaseTypeRequestDatabaseTypeVolcanoDb2xl UpdateDatabaseTypeRequestDatabaseType = "volcano-db-2xl" UpdateDatabaseTypeRequestDatabaseTypeVolcanoDbL UpdateDatabaseTypeRequestDatabaseType = "volcano-db-l" UpdateDatabaseTypeRequestDatabaseTypeVolcanoDbM UpdateDatabaseTypeRequestDatabaseType = "volcano-db-m" UpdateDatabaseTypeRequestDatabaseTypeVolcanoDbS UpdateDatabaseTypeRequestDatabaseType = "volcano-db-s" UpdateDatabaseTypeRequestDatabaseTypeVolcanoDbXl UpdateDatabaseTypeRequestDatabaseType = "volcano-db-xl" UpdateDatabaseTypeRequestDatabaseTypeVolcanoDbXs UpdateDatabaseTypeRequestDatabaseType = "volcano-db-xs" )
Defines values for UpdateDatabaseTypeRequestDatabaseType.
func (UpdateDatabaseTypeRequestDatabaseType) Valid ¶
func (e UpdateDatabaseTypeRequestDatabaseType) Valid() bool
Valid indicates whether the value is a known member of the UpdateDatabaseTypeRequestDatabaseType enum.
type UpdateEmailTemplateRequest ¶
type UpdateEmailTemplateRequest struct {
HtmlBody *string `json:"html_body,omitempty"`
Subject *string `json:"subject,omitempty"`
TextBody *string `json:"text_body,omitempty"`
}
UpdateEmailTemplateRequest defines model for UpdateEmailTemplateRequest.
type UpdateFunctionRequest ¶
type UpdateFunctionRequest struct {
// IsPublic Function visibility for anon-key invocation.
// - `false` (default): private function
// - `true`: public function (anon keys with `functions.invoke` can invoke)
IsPublic bool `json:"is_public"`
}
UpdateFunctionRequest defines model for UpdateFunctionRequest.
type UpdateFunctionSchedulerRequest ¶
type UpdateFunctionSchedulerRequest struct {
Enabled *bool `json:"enabled,omitempty"`
Name *string `json:"name,omitempty"`
Payload *map[string]interface{} `json:"payload,omitempty"`
Regions *[]string `json:"regions,omitempty"`
Schedule *ScheduleRequest `json:"schedule,omitempty"`
}
UpdateFunctionSchedulerRequest defines model for UpdateFunctionSchedulerRequest.
type UpdateOAuthConfigRequest ¶
type UpdateOAuthConfigRequest struct {
// ClientId Supported for non-device providers. Not supported for `provider=device`.
ClientId *string `json:"client_id,omitempty"`
// ClientSecret Supported for non-device providers. Not supported for `provider=device`.
ClientSecret *string `json:"client_secret,omitempty"`
Enabled *bool `json:"enabled,omitempty"`
RedirectUrl *string `json:"redirect_url,omitempty"`
Scopes *[]string `json:"scopes,omitempty"`
}
UpdateOAuthConfigRequest defines model for UpdateOAuthConfigRequest.
type UpdateProjectRequest ¶
type UpdateProjectRequest struct {
// AllRegions If omitted and `selected_regions` is also omitted, existing region policy is preserved.
// If `selected_regions` is provided without `all_regions`, it is treated as subset mode.
AllRegions *bool `json:"all_regions,omitempty"`
Name *string `json:"name,omitempty"`
// SelectedRegions Region subset for project deployments.
// Provide with `all_regions=false`.
SelectedRegions *[]string `json:"selected_regions,omitempty"`
}
UpdateProjectRequest Update mutable project fields (name and/or region policy)
type UpdateRealtimeConfigRequest ¶
type UpdateRealtimeConfigRequest struct {
// BroadcastEnabled Whether broadcast channels are enabled
BroadcastEnabled *bool `json:"broadcast_enabled,omitempty"`
// Enabled Whether realtime is enabled for this project
Enabled *bool `json:"enabled,omitempty"`
// PostgresChangesEnabled Whether Postgres change notifications are enabled
PostgresChangesEnabled *bool `json:"postgres_changes_enabled,omitempty"`
// PresenceEnabled Whether presence tracking is enabled
PresenceEnabled *bool `json:"presence_enabled,omitempty"`
}
UpdateRealtimeConfigRequest Request to update realtime configuration. Limits (message size, channels per connection) are plan-based and cannot be configured.
type UpdateStorageBucketRequest ¶
type UpdateStorageBucketRequest struct {
AllowedMimeTypes *[]string `json:"allowed_mime_types,omitempty"`
FileSizeLimit *int64 `json:"file_size_limit,omitempty"`
}
UpdateStorageBucketRequest defines model for UpdateStorageBucketRequest.
type UpdateVariableRequest ¶
type UpdateVariableRequest struct {
Value string `json:"value"`
}
UpdateVariableRequest defines model for UpdateVariableRequest.
type UploadSessionPart ¶
type UploadSessionPart struct {
// Etag ETag of the uploaded part
Etag *string `json:"etag,omitempty"`
// PartNumber Part number (1-10000)
PartNumber *int `json:"part_number,omitempty"`
// Size Size of the part in bytes
Size *int64 `json:"size,omitempty"`
}
UploadSessionPart Information about an uploaded part
type UploadSessionStatusResponse ¶
type UploadSessionStatusResponse struct {
// BytesUploaded Total bytes uploaded so far
BytesUploaded *int64 `json:"bytes_uploaded,omitempty"`
// ContentType MIME type
ContentType *string `json:"content_type,omitempty"`
// CreatedAt Session creation time
CreatedAt *time.Time `json:"created_at,omitempty"`
// ExpiresAt Session expiry time
ExpiresAt *time.Time `json:"expires_at,omitempty"`
// PartSize Size of each part (except last)
PartSize *int64 `json:"part_size,omitempty"`
// Parts List of uploaded parts (for resume)
Parts *[]UploadSessionPart `json:"parts,omitempty"`
// PartsUploaded Number of parts uploaded
PartsUploaded *int `json:"parts_uploaded,omitempty"`
// Path Target file path
Path *string `json:"path,omitempty"`
// SessionId Upload session ID
SessionId *string `json:"session_id,omitempty"`
// Status Current status of the upload
Status *UploadSessionStatusResponseStatus `json:"status,omitempty"`
// TotalParts Total number of parts
TotalParts *int `json:"total_parts,omitempty"`
// TotalSize Total file size in bytes
TotalSize *int64 `json:"total_size,omitempty"`
}
UploadSessionStatusResponse Status of an upload session
type UploadSessionStatusResponseStatus ¶
type UploadSessionStatusResponseStatus string
UploadSessionStatusResponseStatus Current status of the upload
const ( Aborted UploadSessionStatusResponseStatus = "aborted" Completed UploadSessionStatusResponseStatus = "completed" Completing UploadSessionStatusResponseStatus = "completing" Pending UploadSessionStatusResponseStatus = "pending" Uploading UploadSessionStatusResponseStatus = "uploading" )
Defines values for UploadSessionStatusResponseStatus.
func (UploadSessionStatusResponseStatus) Valid ¶
func (e UploadSessionStatusResponseStatus) Valid() bool
Valid indicates whether the value is a known member of the UploadSessionStatusResponseStatus enum.
type UsageDataPoint ¶
type UsageDataPoint struct {
// Timestamp UTC timestamp for the data point
Timestamp time.Time `json:"timestamp"`
// Value Usage value at the timestamp
Value int64 `json:"value"`
}
UsageDataPoint A single timestamped usage value.
type Variable ¶
type Variable struct {
CreatedAt time.Time `json:"created_at"`
// CurrentSyncId Identifier of the latest variable propagation sync.
CurrentSyncId *openapi_types.UUID `json:"current_sync_id,omitempty"`
Id openapi_types.UUID `json:"id"`
Name string `json:"name"`
ProjectId openapi_types.UUID `json:"project_id"`
// ProvisioningStartedAt Timestamp when the current variable propagation phase started.
ProvisioningStartedAt *time.Time `json:"provisioning_started_at,omitempty"`
// Status Latest project variable propagation status, when a sync has run.
Status *VariableStatus `json:"status,omitempty"`
UpdatedAt time.Time `json:"updated_at"`
Value string `json:"value"`
}
Variable defines model for Variable.
type VariableStatus ¶
type VariableStatus string
VariableStatus Latest project variable propagation status, when a sync has run.
const ( Active VariableStatus = "active" Failed VariableStatus = "failed" Provisioning VariableStatus = "provisioning" )
Defines values for VariableStatus.
func (VariableStatus) Valid ¶
func (e VariableStatus) Valid() bool
Valid indicates whether the value is a known member of the VariableStatus enum.