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 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 FrontendUsageData
- type Function
- type FunctionDeployment
- type FunctionDeploymentOperation
- type FunctionDeploymentStatus
- type FunctionInvocationRequest
- type FunctionInvocationResponse
- type FunctionRuntimeDeployment
- type FunctionRuntimeOption
- type FunctionRuntimesResponse
- type FunctionScheduler
- type FunctionSchedulerListResponse
- type FunctionSchedulerScheduleKind
- type FunctionStatus
- type GetLogsResponse
- type HostedAuthPageType
- type HostedLoginEmailCheckRequest
- type HostedLoginEmailCheckResponse
- type HostedLoginOptionsResponse
- type HostedRenderablePageType
- type LogEvent
- type MetricUsageData
- type OAuthConfig
- type OAuthConfigProvider
- type OAuthErrorResponse
- type PaginatedAuthUsers
- type PaginatedDatabases
- type PaginatedFrontendDeployments
- type PaginatedFrontends
- type PaginatedFunctionDeployments
- type PaginatedFunctions
- type PaginatedProjects
- type PaginatedProjectsStatus
- type PaginatedServiceKeys
- type PaginatedVariables
- type PlatformExchangeResponse
- type Project
- 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 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"`
// 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"`
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 *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 ( N15 CreateDatabaseRequestPgVersion = "15" N16 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" )
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.
//
// **Connection Modes via application_name parameter:**
// - `volcano_full_access:{database_name}` — Full admin access (DDL, migrations)
// - `volcano_user_access:{database_name}:{user_id}` — User impersonation (RLS enforced)
// - `volcano_user_access:{database_name}` — 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 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" 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
VerificationUri string `json:"verification_uri"`
// VerificationUriComplete Browser verification URL including prefilled `user_code`
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" )
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"`
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 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 billing month
Requests int64 `json:"requests"`
}
FrontendUsageData Monthly frontend request totals grouped by frontend.
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"`
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 ( Delete FunctionDeploymentOperation = "delete" Deploy FunctionDeploymentOperation = "deploy" Update 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 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 GetLogsResponse ¶
type GetLogsResponse struct {
// Data Array of log events sorted by timestamp (newest first)
Data []LogEvent `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"`
// Next URL path to next page with all current filters (only present if has_more is true)
Next *string `json:"next,omitempty"`
// Partial True when one or more regions could not be queried successfully
Partial *bool `json:"partial,omitempty"`
// RegionErrors Per-region query errors when `partial=true`
RegionErrors *map[string]string `json:"region_errors,omitempty"`
}
GetLogsResponse defines model for GetLogsResponse.
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 LogEvent ¶
type LogEvent struct {
// Message Log message content
Message string `json:"message"`
// Region Region where this log event originated (multi-region logs)
Region *string `json:"region,omitempty"`
// Timestamp Unix timestamp in milliseconds
Timestamp int64 `json:"timestamp"`
}
LogEvent defines model for LogEvent.
type MetricUsageData ¶
type MetricUsageData struct {
// 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 Invocations" or "Frontend Requests")
Metric string `json:"metric"`
// Total Total usage for the current billing 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 ( Apple OAuthConfigProvider = "apple" Device OAuthConfigProvider = "device" Github OAuthConfigProvider = "github" Google OAuthConfigProvider = "google" Microsoft 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 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"`
Name string `json:"name"`
// Plan Billing 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 ProjectPlan ¶
type ProjectPlan string
ProjectPlan Billing 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 billing month
Frontends *[]FrontendUsageData `json:"frontends,omitempty"`
// Metrics Usage metrics for the project
Metrics []MetricUsageData `json:"metrics"`
// Month Billing 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 billing 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 Always ["*"] for full admin access
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 ( StoragePolicyOperationDELETE StoragePolicyOperation = "DELETE" StoragePolicyOperationINSERT StoragePolicyOperation = "INSERT" StoragePolicyOperationSELECT StoragePolicyOperation = "SELECT" StoragePolicyOperationUPDATE 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 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"`
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 *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 ( VolcanoDb2xl UpdateDatabaseTypeRequestDatabaseType = "volcano-db-2xl" VolcanoDbL UpdateDatabaseTypeRequestDatabaseType = "volcano-db-l" VolcanoDbM UpdateDatabaseTypeRequestDatabaseType = "volcano-db-m" VolcanoDbS UpdateDatabaseTypeRequestDatabaseType = "volcano-db-s" VolcanoDbXl UpdateDatabaseTypeRequestDatabaseType = "volcano-db-xl" VolcanoDbXs 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 ( UploadSessionStatusResponseStatusAborted UploadSessionStatusResponseStatus = "aborted" UploadSessionStatusResponseStatusCompleted UploadSessionStatusResponseStatus = "completed" UploadSessionStatusResponseStatusCompleting UploadSessionStatusResponseStatus = "completing" UploadSessionStatusResponseStatusPending UploadSessionStatusResponseStatus = "pending" UploadSessionStatusResponseStatusUploading 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.