planetscale

type Actor struct {
	Type string `json:"type"`
	ID   string `json:"id"`
	Name string `json:"display_name"`
}

type AddServiceTokenAccessRequest struct {
	Organization string   `json:"-"`
	ID           string   `json:"-"`
	Database     string   `json:"database"`
	Accesses     []string `json:"access"`
}

type ApplyDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type AuditLog struct {
	ID   string `json:"id"`
	Type string `json:"type"`

	ActorID          string `json:"actor_id"`
	ActorType        string `json:"actor_type"`
	ActorDisplayName string `json:"actor_display_name"`

	AuditableID          string `json:"auditable_id"`
	AuditableType        string `json:"auditable_type"`
	AuditableDisplayName string `json:"auditable_display_name"`

	AuditAction string `json:"audit_action"`
	Action      string `json:"action"`

	Location string `json:"location"`
	RemoteIP string `json:"remote_ip"`

	TargetID          string `json:"target_id"`
	TargetType        string `json:"target_type"`
	TargetDisplayName string `json:"target_display_name"`

	Metadata map[string]interface{} `json:"metadata"`

	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type AuditLogEvent string

type AuditLogsService interface {
	List(context.Context, *ListAuditLogsRequest, ...ListOption) (*CursorPaginatedResponse[*AuditLog], error)
}

type AutoApplyDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
	Enable       bool   `json:"-"`
}

type Backup struct {
	PublicID    string    `json:"id"`
	Name        string    `json:"name"`
	State       string    `json:"state"`
	Size        int64     `json:"size"`
	Actor       *Actor    `json:"actor"`
	CreatedAt   time.Time `json:"created_at"`
	UpdatedAt   time.Time `json:"updated_at"`
	StartedAt   time.Time `json:"started_at"`
	ExpiresAt   time.Time `json:"expires_at"`
	CompletedAt time.Time `json:"completed_at"`
}

type BackupsService interface {
	Create(context.Context, *CreateBackupRequest) (*Backup, error)
	List(context.Context, *ListBackupsRequest) ([]*Backup, error)
	Get(context.Context, *GetBackupRequest) (*Backup, error)
	Delete(context.Context, *DeleteBackupRequest) error
}

type BillingPlan int

type BranchInfraPod struct {
	Name         string     `json:"name"`
	Status       string     `json:"status"`
	Component    string     `json:"component"`
	Ready        string     `json:"ready"`
	RestartCount int        `json:"restart_count"`
	CreatedAt    *time.Time `json:"created_at"`
	Cell         string     `json:"cell"`
	Size         string     `json:"size"`
	Keyspace     *string    `json:"keyspace"`
	Shard        *string    `json:"shard"`
	TabletType   *string    `json:"tablet_type"`
}

type BranchInfrastructure struct {
	Type     string
	Vitess   *VitessBranchInfrastructure
	Postgres *PostgresBranchInfrastructure
}

type BranchInfrastructureService interface {
	Get(ctx context.Context, req *GetBranchInfrastructureRequest) (*BranchInfrastructure, error)
}

type BranchRoutingRulesRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type BranchSchemaRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
}

type CancelDataImportRequest struct {
	Organization string
	Database     string
}

type CancelDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type CancelKeyspaceResizeRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
}

type CancelWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type Client struct {

	// UserAgent is the version of the planetscale-go library that is being used
	UserAgent string

	AuditLogs             AuditLogsService
	Backups               BackupsService
	BranchInfrastructure  BranchInfrastructureService
	D1ImportNotifications D1ImportNotificationsService
	DatabaseBranches      DatabaseBranchesService
	Databases             DatabasesService
	DataImports           DataImportsService
	DeployRequests        DeployRequestsService
	Keyspaces             KeyspacesService
	LookupVindex          LookupVindexService
	Materialize           MaterializeService
	MoveTables            MoveTablesService
	Organizations         OrganizationsService
	Passwords             PasswordsService
	PlannedReparentShard  PlannedReparentShardService
	PostgresBranches      PostgresBranchesService
	PostgresRoles         PostgresRolesService
	Processlist           ProcesslistService
	QueryPatterns         QueryPatternsService
	Regions               RegionsService
	SchemaRecommendations SchemaRecommendationService
	ServiceTokens         ServiceTokenService
	TrafficBudgets        TrafficBudgetsService
	TrafficRules          TrafficRulesService
	VDiff                 VDiffService
	Vtctld                VtctldService
	Webhooks              WebhooksService
	Workflows             WorkflowsService
	// contains filtered or unexported fields
}

type ClientOption func(c *Client) error

type CloseDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type CloseRequest struct {
	State string `json:"state"`
}

type ClosedByDeployRequest struct {
	ID       string `json:"id"`
	BranchID string `json:"branch_id"`
	Number   int    `json:"number"`
}

type ClusterSKU struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	CPU         string `json:"cpu"`
	Memory      int64  `json:"ram"`

	SortOrder int64 `json:"sort_order"`

	Storage *int64 `json:"storage"`

	Rate                 *int64  `json:"rate"`
	ReplicaRate          *int64  `json:"replica_rate"`
	ProviderInstanceType *string `json:"provider_instance_type"`
	Provider             *string `json:"provider"`
	Enabled              bool    `json:"enabled"`
	DefaultVTGate        string  `json:"default_vtgate"`
	DefaultVTGateRate    *int64  `json:"default_vtgate_rate"`

	Metal bool `json:"metal"`
}

type CompleteWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type CreateBackupRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Name           string `json:"name,omitempty"`
	RetentionUnit  string `json:"retention_unit,omitempty"`
	RetentionValue int    `json:"retention_value,omitempty"`
	Emergency      bool   `json:"emergency,omitempty"`
}

type CreateD1ImportNotificationRequest struct {
	Organization string
	Database     string
	BranchName   string
	MigrationID  string
	Event        string
	Method       string
	ExportBytes  int64
	TableCount   int
	Matched      *bool
	DurationMs   int64
	Error        string
	ErrorCode    string
	Stage        string
	Message      string
}

type CreateDatabaseBranchRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Region       string `json:"region,omitempty"`
	Name         string `json:"name"`
	ParentBranch string `json:"parent_branch"`
	BackupID     string `json:"backup_id,omitempty"`
	SeedData     string `json:"seed_data,omitempty"`
	ClusterSize  string `json:"cluster_size,omitempty"`
}

type CreateDatabaseRequest struct {
	Organization string
	Name         string         `json:"name"`
	Notes        string         `json:"notes,omitempty"`
	Region       string         `json:"region,omitempty"`
	ClusterSize  string         `json:"cluster_size,omitempty"`
	Kind         DatabaseEngine `json:"kind,omitempty"`
	Replicas     *int           `json:"replicas,omitempty"`
	MajorVersion string         `json:"major_version,omitempty"`
	Storage      *StorageConfig `json:"storage,omitempty"`
}

type CreateDeployRequestRequest struct {
	Organization     string `json:"-"`
	Database         string `json:"-"`
	Branch           string `json:"branch"`
	IntoBranch       string `json:"into_branch,omitempty"`
	Notes            string `json:"notes"`
	AutoCutover      bool   `json:"auto_cutover,omitempty"`
	AutoDeleteBranch bool   `json:"auto_delete_branch,omitempty"`
}

type CreateKeyspaceRequest struct {
	Organization  string `json:"-"`
	Database      string `json:"-"`
	Branch        string `json:"-"`
	Name          string `json:"name"`
	ClusterSize   string `json:"cluster_size"`
	ExtraReplicas int    `json:"extra_replicas"`
	Shards        int    `json:"shards"`
}

type CreatePostgresBranchRequest struct {
	Organization string         `json:"-"`
	Database     string         `json:"-"`
	Region       string         `json:"region,omitempty"`
	Name         string         `json:"name"`
	ParentBranch string         `json:"parent_branch"`
	BackupID     string         `json:"backup_id,omitempty"`
	ClusterName  string         `json:"cluster_name,omitempty"`
	MajorVersion string         `json:"major_version,omitempty"`
	Storage      *StorageConfig `json:"storage,omitempty"`
}

type CreatePostgresRoleRequest struct {
	Organization    string   `json:"-"`
	Database        string   `json:"-"`
	Branch          string   `json:"-"`
	Name            string   `json:"name"`
	TTL             int      `json:"ttl,omitempty"`
	InheritedRoles  []string `json:"inherited_roles,omitempty"`
	WithReplication bool     `json:"with_replication,omitempty"`
}

type CreateQueryPatternsReportRequest struct {
	Organization string
	Database     string
	Branch       string
}

type CreateServiceTokenRequest struct {
	Organization string  `json:"-"`
	Name         *string `json:"name,omitempty"`
	TTL          *int    `json:"ttl,omitempty"`
}

type CreateTrafficBudgetRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Name string `json:"name"`
	Mode string `json:"mode"`

	Capacity         *int `json:"capacity,omitempty"`
	Rate             *int `json:"rate,omitempty"`
	Burst            *int `json:"burst,omitempty"`
	Concurrency      *int `json:"concurrency,omitempty"`
	WarningThreshold *int `json:"warning_threshold,omitempty"`

	Rules *[]CreateTrafficBudgetRuleRequest `json:"rules,omitempty"`
}

type CreateTrafficBudgetRuleRequest struct {
	Kind        string            `json:"kind"`
	Fingerprint string            `json:"fingerprint,omitempty"`
	Keyspace    string            `json:"keyspace,omitempty"`
	Tags        *[]TrafficRuleTag `json:"tags,omitempty"`
}

type CreateTrafficRuleRequest struct {
	Organization string            `json:"-"`
	Database     string            `json:"-"`
	Branch       string            `json:"-"`
	BudgetID     string            `json:"-"`
	Kind         string            `json:"kind"`
	Fingerprint  *string           `json:"fingerprint,omitempty"`
	Keyspace     *string           `json:"keyspace,omitempty"`
	Tags         *[]TrafficRuleTag `json:"tags,omitempty"`
}

type CreateWebhookRequest struct {
	Organization string   `json:"-"`
	Database     string   `json:"-"`
	URL          string   `json:"url"`
	Enabled      *bool    `json:"enabled,omitempty"`
	Events       []string `json:"events,omitempty"`
}

type CreateWorkflowRequest struct {
	Organization       string   `json:"-"`
	Database           string   `json:"-"`
	Branch             string   `json:"branch_name"`
	Name               string   `json:"name"`
	SourceKeyspace     string   `json:"source_keyspace"`
	TargetKeyspace     string   `json:"target_keyspace"`
	Tables             []string `json:"tables"`
	GlobalKeyspace     *string  `json:"global_keyspace"`
	DeferSecondaryKeys *bool    `json:"defer_secondary_keys"`
	OnDDL              *string  `json:"on_ddl"`
}

type CursorPaginatedResponse[T any] struct {
	Data    []T  `json:"data"`
	HasNext bool `json:"has_next"`
	HasPrev bool `json:"has_prev"`
	// CursorStart is the ending cursor of the previous page.
	CursorStart *string `json:"cursor_start"`

	// CursorEnd is the starting cursor of the next page.
	CursorEnd *string `json:"cursor_end"`
}

type CutoverWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type D1ImportNotificationsService interface {
	Create(ctx context.Context, req *CreateD1ImportNotificationRequest) error
}

type DataImport struct {
	ID                 string `json:"id"`
	ImportState        DataImportState
	State              string           `json:"state"`
	Errors             string           `json:"import_check_errors"`
	StartedAt          *time.Time       `json:"started_at"`
	FinishedAt         *time.Time       `json:"finished_at"`
	DeletedAt          *time.Time       `json:"deleted_at"`
	ExternalDataSource DataImportSource `json:"data_source"`
}

type DataImportSource struct {
	HostName            string `json:"hostname"`
	Database            string `json:"schema_name"`
	Port                int    `json:"port"`
	SSLMode             string `json:"ssl_mode"`
	SSLVerificationMode ExternalDataSourceSSLVerificationMode
	UserName            string `json:"username"`
	Password            string `json:"password"`
	SSLCA               string `json:"ssl_ca"`
	SSLCertificate      string `json:"ssl_cert"`
	SSLKey              string `json:"ssl_key"`
	SSLServerName       string `json:"ssl_server_name"`
}

type DataImportState int

type DataImportsService interface {
	// TestDataImportSource checks if the external database that we're importing will be supported
	// by PlanetScale. It checks for ability to replicate binlogs, schema compatibility and other factors.
	TestDataImportSource(ctx context.Context, request *TestDataImportSourceRequest) (*TestDataImportSourceResponse, error)
	// StartDataImport spins up a downstream PlanetScale database in replica mode, with the
	// external database as a Primary and starts copying data from external to PlanetScale.
	StartDataImport(ctx context.Context, request *StartDataImportRequest) (*DataImport, error)
	// CancelDataImport halts all replication and data copy from external to PlanetScale
	// and deletes the PlanetScale database.
	CancelDataImport(ctx context.Context, request *CancelDataImportRequest) error
	// GetDataImportStatus gets the current status of a DataImport for a given database
	// Fails if the database is not importing any data.
	GetDataImportStatus(ctx context.Context, request *GetImportStatusRequest) (*DataImport, error)
	// MakePlanetScalePrimary makes the downstream PlanetScale database a Primary and the external database a Replica.
	MakePlanetScalePrimary(ctx context.Context, request *MakePlanetScalePrimaryRequest) (*DataImport, error)
	// MakePlanetScaleReplica makes the downstream PlanetScale database a Replica and the external database a Primary.
	MakePlanetScaleReplica(ctx context.Context, request *MakePlanetScaleReplicaRequest) (*DataImport, error)
	// DetachExternalDatabase detaches the external database from PlanetScale after a data import has finished
	// and PlanetScale is running as Primary.
	DetachExternalDatabase(ctx context.Context, request *DetachExternalDatabaseRequest) (*DataImport, error)
}

type DataSourceIncompatibilityError struct {
	LintError        string `json:"lint_error"`
	Keyspace         string `json:"keyspace_name"`
	Table            string `json:"table_name"`
	SubjectType      string `json:"subject_type"`
	ErrorDescription string `json:"error_description"`
	DocsUrl          string `json:"docs_url"`
}

type Database struct {
	Name      string         `json:"name"`
	Notes     string         `json:"notes"`
	Region    Region         `json:"region"`
	State     DatabaseState  `json:"state"`
	Kind      DatabaseEngine `json:"kind"`
	HtmlURL   string         `json:"html_url"`
	CreatedAt time.Time      `json:"created_at"`
	UpdatedAt time.Time      `json:"updated_at"`
}

type DatabaseBranch struct {
	ID             string    `json:"id"`
	Name           string    `json:"name"`
	ParentBranch   string    `json:"parent_branch"`
	Actor          Actor     `json:"actor"`
	Region         Region    `json:"region"`
	Ready          bool      `json:"ready"`
	Production     bool      `json:"production"`
	HtmlURL        string    `json:"html_url"`
	CreatedAt      time.Time `json:"created_at"`
	UpdatedAt      time.Time `json:"updated_at"`
	SafeMigrations bool      `json:"safe_migrations"`
}

type DatabaseBranchPassword struct {
	PublicID  string         `json:"id"`
	Name      string         `json:"name"`
	Hostname  string         `json:"access_host_url"`
	Username  string         `json:"username"`
	Role      string         `json:"role"`
	Actor     *Actor         `json:"actor"`
	Branch    DatabaseBranch `json:"database_branch"`
	CreatedAt time.Time      `json:"created_at"`
	DeletedAt time.Time      `json:"deleted_at"`
	ExpiresAt time.Time      `json:"expires_at"`
	PlainText string         `json:"plain_text"`
	TTL       int            `json:"ttl_seconds"`
	Renewable bool           `json:"renewable"`
	Replica   bool           `json:"replica"`
}

type DatabaseBranchPasswordRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Role         string `json:"role,omitempty"`
	Name         string `json:"name"`
	TTL          int    `json:"ttl,omitempty"`
	Replica      bool   `json:"replica,omitempty"`
}

type DatabaseBranchesService interface {
	Create(context.Context, *CreateDatabaseBranchRequest) (*DatabaseBranch, error)
	List(context.Context, *ListDatabaseBranchesRequest, ...ListOption) ([]*DatabaseBranch, error)
	Get(context.Context, *GetDatabaseBranchRequest) (*DatabaseBranch, error)
	Delete(context.Context, *DeleteDatabaseBranchRequest) error
	Diff(context.Context, *DiffBranchRequest) ([]*Diff, error)
	Schema(context.Context, *BranchSchemaRequest) ([]*Diff, error)
	RoutingRules(context.Context, *BranchRoutingRulesRequest) (*RoutingRules, error)
	UpdateRoutingRules(context.Context, *UpdateBranchRoutingRulesRequest) (*RoutingRules, error)
	RefreshSchema(context.Context, *RefreshSchemaRequest) error
	Demote(context.Context, *DemoteRequest) (*DatabaseBranch, error)
	Promote(context.Context, *PromoteRequest) (*DatabaseBranch, error)
	EnableSafeMigrations(context.Context, *EnableSafeMigrationsRequest) (*DatabaseBranch, error)
	DisableSafeMigrations(context.Context, *DisableSafeMigrationsRequest) (*DatabaseBranch, error)
	LintSchema(context.Context, *LintSchemaRequest) ([]*SchemaLintError, error)
	ListClusterSKUs(context.Context, *ListBranchClusterSKUsRequest, ...ListOption) ([]*ClusterSKU, error)
}

type DatabaseDeletionRequest struct {
	ID    string `json:"id"`
	Actor Actor  `json:"actor"`
}

type DatabaseEngine string

type DatabaseState string

type DatabasesService interface {
	Create(context.Context, *CreateDatabaseRequest) (*Database, error)
	Get(context.Context, *GetDatabaseRequest) (*Database, error)
	List(context.Context, *ListDatabasesRequest, ...ListOption) ([]*Database, error)
	Delete(context.Context, *DeleteDatabaseRequest) (*DatabaseDeletionRequest, error)
}

type DeleteBackupRequest struct {
	Organization string
	Database     string
	Branch       string
	Backup       string
}

type DeleteDatabaseBranchPasswordRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Name         string `json:"name"`
	PasswordId   string
}

type DeleteDatabaseBranchRequest struct {
	Organization      string
	Database          string
	Branch            string
	DeleteDescendants bool
}

type DeleteDatabaseRequest struct {
	Organization string
	Database     string
}

type DeletePostgresBranchRequest struct {
	Organization      string
	Database          string
	Branch            string
	DeleteDescendants bool
}

type DeletePostgresRoleRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoleId       string `json:"-"`
	Successor    string `json:"successor,omitempty"`
}

type DeleteServiceTokenAccessRequest struct {
	Organization string   `json:"-"`
	ID           string   `json:"-"`
	Database     string   `json:"database"`
	Accesses     []string `json:"access"`
}

type DeleteServiceTokenRequest struct {
	Organization string `json:"-"`
	ID           string `json:"-"`
}

type DeleteTrafficBudgetRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	BudgetID     string `json:"-"`
}

type DeleteTrafficRuleRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	BudgetID     string `json:"-"`
	RuleID       string `json:"-"`
}

type DeleteWebhookRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	ID           string `json:"-"`
}

type DemoteRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type DeployOperation struct {
	ID                 string    `json:"id"`
	State              string    `json:"state"`
	Table              string    `json:"table_name"`
	Keyspace           string    `json:"keyspace_name"`
	Operation          string    `json:"operation_name"`
	ETASeconds         int64     `json:"eta_seconds"`
	ProgressPercentage uint64    `json:"progress_percentage"`
	CreatedAt          time.Time `json:"created_at"`
	UpdatedAt          time.Time `json:"updated_at"`
}

type DeployRequest struct {
	ID string `json:"id"`

	Branch     string `json:"branch"`
	IntoBranch string `json:"into_branch"`

	Actor           Actor  `json:"actor"`
	ClosedBy        *Actor `json:"closed_by"`
	BranchDeletedBy *Actor `json:"branch_deleted_by"`
	Number          uint64 `json:"number"`

	State string `json:"state"`

	DeploymentState string `json:"deployment_state"`

	Approved bool `json:"approved"`

	Notes string `json:"notes"`

	Deployment *Deployment `json:"deployment"`

	HtmlURL string `json:"html_url"`

	CreatedAt  time.Time  `json:"created_at"`
	UpdatedAt  time.Time  `json:"updated_at"`
	ClosedAt   *time.Time `json:"closed_at"`
	DeployedAt *time.Time `json:"deployed_at"`
}

type DeployRequestReview struct {
	ID        string    `json:"id"`
	Body      string    `json:"body"`
	State     string    `json:"state"`
	Actor     Actor     `json:"actor"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type DeployRequestsService interface {
	ApplyDeploy(context.Context, *ApplyDeployRequestRequest) (*DeployRequest, error)
	AutoApplyDeploy(context.Context, *AutoApplyDeployRequestRequest) (*DeployRequest, error)
	CancelDeploy(context.Context, *CancelDeployRequestRequest) (*DeployRequest, error)
	CloseDeploy(context.Context, *CloseDeployRequestRequest) (*DeployRequest, error)
	Create(context.Context, *CreateDeployRequestRequest) (*DeployRequest, error)
	CreateReview(context.Context, *ReviewDeployRequestRequest) (*DeployRequestReview, error)
	Deploy(context.Context, *PerformDeployRequest) (*DeployRequest, error)
	Diff(ctx context.Context, diffReq *DiffRequest) ([]*Diff, error)
	Get(context.Context, *GetDeployRequestRequest) (*DeployRequest, error)
	List(context.Context, *ListDeployRequestsRequest) ([]*DeployRequest, error)
	GetDeployOperations(context.Context, *GetDeployOperationsRequest) ([]*DeployOperation, error)
	SkipRevertDeploy(context.Context, *SkipRevertDeployRequestRequest) (*DeployRequest, error)
	RevertDeploy(context.Context, *RevertDeployRequestRequest) (*DeployRequest, error)
}

type Deployment struct {
	ID                   string                 `json:"id"`
	State                string                 `json:"state"`
	Deployable           bool                   `json:"deployable"`
	LintErrors           []*DeploymentLintError `json:"lint_errors"`
	DeployRequestNumber  uint64                 `json:"deploy_request_number"`
	IntoBranch           string                 `json:"into_branch"`
	PrecedingDeployments []*QueuedDeployment    `json:"preceding_deployments"`

	InstantDDLEligible bool `json:"instant_ddl_eligible"`
	InstantDDL         bool `json:"instant_ddl"`

	Actor          *Actor `json:"actor"`
	CutoverActor   *Actor `json:"cutover_actor"`
	CancelledActor *Actor `json:"cancelled_actor"`

	CreatedAt  time.Time  `json:"created_at"`
	UpdatedAt  time.Time  `json:"updated_at"`
	StartedAt  *time.Time `json:"started_at"`
	QueuedAt   *time.Time `json:"queued_at"`
	FinishedAt *time.Time `json:"finished_at"`
}

type DeploymentLintError struct {
	LintError        string `json:"lint_error"`
	Keyspace         string `json:"keyspace_name"`
	Table            string `json:"table_name"`
	SubjectType      string `json:"subject_type"`
	ErrorDescription string `json:"error_description"`
	DocsUrl          string `json:"docs_url"`
}

type DetachExternalDatabaseRequest struct {
	Organization string
	Database     string
}

type Diff struct {
	Name string `json:"name"`
	Raw  string `json:"raw"`
	HTML string `json:"html"`
}

type DiffBranchRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type DiffRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type DisableSafeMigrationsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type DismissSchemaRecommendationRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	ID           string `json:"-"`
}

type DownloadQueryPatternsReportRequest struct {
	Organization string
	Database     string
	Branch       string
	Report       string
}

type EnableSafeMigrationsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type Error struct {

	// Code specifies the error code. i.e; NotFound, RateLimited, etc...
	Code ErrorCode

	// Meta contains additional information depending on the error code. As an
	// example, if the Code is "ErrResponseMalformed", the map will be: ["body"]
	// = "body of the response"
	Meta map[string]string
	// contains filtered or unexported fields
}

type ErrorCode string

type ExternalDataSourceSSLVerificationMode int

type GetBackupRequest struct {
	Organization string
	Database     string
	Branch       string
	Backup       string
}

type GetBranchInfrastructureRequest struct {
	Organization string
	Database     string
	Branch       string
}

type GetDatabaseBranchPasswordRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Name         string `json:"name"`
	PasswordId   string
}

type GetDatabaseBranchRequest struct {
	Organization string
	Database     string
	Branch       string
}

type GetDatabaseRequest struct {
	Organization string
	Database     string
}

type GetDeployOperationsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type GetDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type GetImportStatusRequest struct {
	Organization string
	Database     string
}

type GetKeyspaceRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
}

type GetKeyspaceVSchemaRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
}

type GetOrganizationRequest struct {
	Organization string
}

type GetPlannedReparentShardRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	ID           string `json:"-"`
}

type GetPostgresBranchRequest struct {
	Organization string
	Database     string
	Branch       string
}

type GetPostgresRoleRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoleId       string
}

type GetQueryPatternsReportRequest struct {
	Organization string
	Database     string
	Branch       string
	Report       string
}

type GetSchemaRecommendationRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	ID           string `json:"-"`
}

type GetServiceTokenAccessRequest struct {
	Organization string `json:"-"`
	ID           string `json:"-"`
}

type GetTrafficBudgetRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	BudgetID     string `json:"-"`
}

type GetVtctldOperationRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	ID           string `json:"-"`
}

type GetWebhookRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	ID           string `json:"-"`
}

type GetWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type Keyspace struct {
	ID                               string                            `json:"id"`
	Name                             string                            `json:"name"`
	Shards                           int                               `json:"shards"`
	Sharded                          bool                              `json:"sharded"`
	Replicas                         uint64                            `json:"replicas"`
	ExtraReplicas                    uint64                            `json:"extra_replicas"`
	ResizePending                    bool                              `json:"resize_pending"`
	Resizing                         bool                              `json:"resizing"`
	Ready                            bool                              `json:"ready"`
	ClusterSize                      string                            `json:"cluster_name"`
	CreatedAt                        time.Time                         `json:"created_at"`
	UpdatedAt                        time.Time                         `json:"updated_at"`
	VReplicationFlags                *VReplicationFlags                `json:"vreplication_flags"`
	ReplicationDurabilityConstraints *ReplicationDurabilityConstraints `json:"replication_durability_constraints"`
}

type KeyspaceResizeRequest struct {
	ID    string `json:"id"`
	State string `json:"state"`
	Actor *Actor `json:"actor"`

	ClusterSize         string `json:"cluster_name"`
	PreviousClusterSize string `json:"previous_cluster_name"`

	Replicas         uint `json:"replicas"`
	ExtraReplicas    uint `json:"extra_replicas"`
	PreviousReplicas uint `json:"previous_replicas"`

	UpdatedAt   time.Time  `json:"updated_at"`
	CreatedAt   time.Time  `json:"created_at"`
	StartedAt   *time.Time `json:"started_at"`
	CompletedAt *time.Time `json:"completed_at"`
}

type KeyspaceResizeStatusRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
}

type KeyspaceRollout struct {
	Name  string `json:"name"`
	State string `json:"state"`

	Shards []ShardRollout `json:"shards"`
}

type KeyspaceRolloutStatusRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
}

type KeyspacesService interface {
	Create(context.Context, *CreateKeyspaceRequest) (*Keyspace, error)
	List(context.Context, *ListKeyspacesRequest) ([]*Keyspace, error)
	Get(context.Context, *GetKeyspaceRequest) (*Keyspace, error)
	VSchema(context.Context, *GetKeyspaceVSchemaRequest) (*VSchema, error)
	UpdateVSchema(context.Context, *UpdateKeyspaceVSchemaRequest) (*VSchema, error)
	Resize(context.Context, *ResizeKeyspaceRequest) (*KeyspaceResizeRequest, error)
	CancelResize(context.Context, *CancelKeyspaceResizeRequest) error
	ResizeStatus(context.Context, *KeyspaceResizeStatusRequest) (*KeyspaceResizeRequest, error)
	RolloutStatus(context.Context, *KeyspaceRolloutStatusRequest) (*KeyspaceRollout, error)
	UpdateSettings(context.Context, *UpdateKeyspaceSettingsRequest) (*Keyspace, error)
}

type KillProcessRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"keyspace,omitempty"`
	Shard        string `json:"shard,omitempty"`
	ID           int64  `json:"id"`
	Kind         string `json:"kind,omitempty"`
}

type KillProcessResult struct {
	Success  bool   `json:"success"`
	Keyspace string `json:"keyspace"`
	Shard    string `json:"shard"`
	Tablet   string `json:"tablet"`
	ID       int64  `json:"id"`
	Kind     string `json:"kind"`
}

type LintSchemaRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type ListAuditLogsRequest struct {
	Organization string

	// Events can be used to filter out only the given audit log events.
	Events []AuditLogEvent
}

type ListBackupsRequest struct {
	Organization string
	Database     string
	Branch       string
}

type ListBranchClusterSKUsRequest struct {
	Organization string
	Database     string
	Branch       string
}

type ListBranchTabletsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	// Keyspace, if set, only returns tablets in this keyspace.
	Keyspace string `json:"-"`
	// Shard, if set, only returns tablets in this shard. It requires Keyspace
	// to also be set.
	Shard string `json:"-"`
	// TabletType, if set, only returns tablets of this type (e.g. "primary",
	// "replica", "rdonly").
	TabletType string `json:"-"`
	// TabletAliases, if set, only returns the tablets with these aliases (e.g.
	// "zone1-0000000100"). When set, the other filters are ignored.
	TabletAliases []string `json:"-"`
}

type ListDatabaseBranchPasswordRequest struct {
	Organization string
	Database     string
	Branch       string
}

type ListDatabaseBranchesRequest struct {
	Organization string
	Database     string
}

type ListDatabasesRequest struct {
	Organization string
}

type ListDeployRequestsRequest struct {
	Organization string
	Database     string
	State        string
	Branch       string
	IntoBranch   string
}

type ListKeyspacesRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type ListOption func(*ListOptions) error

type ListOptions struct {
	URLValues *url.Values
}

type ListOrganizationClusterSKUsRequest struct {
	Organization string
}

type ListOrganizationRegionsRequest struct {
	Organization string
}

type ListPostgresBranchesRequest struct {
	Organization string
	Database     string
}

type ListPostgresRolesRequest struct {
	Organization string
	Database     string
	Branch       string
}

type ListRegionsRequest struct{}

type ListSchemaRecommendationsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
}

type ListServiceTokenGrantsRequest struct {
	Organization string `json:"-"`
	ID           string `json:"-"`
}

type ListServiceTokensRequest struct {
	Organization string `json:"-"`
}

type ListTrafficBudgetsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type ListWebhooksRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
}

type ListWorkflowsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
}

type LookupVindexCancelRequest struct {
	Organization  string `json:"-"`
	Database      string `json:"-"`
	Branch        string `json:"-"`
	Name          string `json:"-"`
	TableKeyspace string `json:"table_keyspace"`
}

type LookupVindexCompleteRequest struct {
	Organization  string `json:"-"`
	Database      string `json:"-"`
	Branch        string `json:"-"`
	Name          string `json:"-"`
	TableKeyspace string `json:"table_keyspace"`
	Keyspace      string `json:"keyspace,omitempty"`
}

type LookupVindexCreateRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Name                         string   `json:"name"`
	TableKeyspace                string   `json:"table_keyspace"`
	Keyspace                     string   `json:"keyspace,omitempty"`
	TableOwner                   string   `json:"table_owner,omitempty"`
	TableName                    string   `json:"table_name,omitempty"`
	Type                         string   `json:"type,omitempty"`
	Cells                        []string `json:"cells,omitempty"`
	TabletTypes                  []string `json:"tablet_types,omitempty"`
	TabletTypesInPreferenceOrder *bool    `json:"tablet_types_in_preference_order,omitempty"`
	IgnoreNulls                  *bool    `json:"ignore_nulls,omitempty"`
	TableOwnerColumns            []string `json:"table_owner_columns,omitempty"`
	TableVindexType              string   `json:"table_vindex_type,omitempty"`
	ContinueAfterCopyWithOwner   *bool    `json:"continue_after_copy_with_owner,omitempty"`
}

type LookupVindexExternalizeRequest struct {
	Organization  string `json:"-"`
	Database      string `json:"-"`
	Branch        string `json:"-"`
	Name          string `json:"-"`
	TableKeyspace string `json:"table_keyspace"`
	Keyspace      string `json:"keyspace,omitempty"`
	Delete        *bool  `json:"delete,omitempty"`
}

type LookupVindexInternalizeRequest struct {
	Organization  string `json:"-"`
	Database      string `json:"-"`
	Branch        string `json:"-"`
	Name          string `json:"-"`
	TableKeyspace string `json:"table_keyspace"`
	Keyspace      string `json:"keyspace,omitempty"`
}

type LookupVindexService interface {
	Create(context.Context, *LookupVindexCreateRequest) (json.RawMessage, error)
	Show(context.Context, *LookupVindexShowRequest) (json.RawMessage, error)
	Externalize(context.Context, *LookupVindexExternalizeRequest) (json.RawMessage, error)
	Internalize(context.Context, *LookupVindexInternalizeRequest) (json.RawMessage, error)
	Cancel(context.Context, *LookupVindexCancelRequest) (json.RawMessage, error)
	Complete(context.Context, *LookupVindexCompleteRequest) (json.RawMessage, error)
}

type LookupVindexShowRequest struct {
	Organization  string `json:"-"`
	Database      string `json:"-"`
	Branch        string `json:"-"`
	Name          string `json:"-"`
	TableKeyspace string `json:"-"`
}

type MakePlanetScalePrimaryRequest struct {
	Organization string
	Database     string
}

type MakePlanetScaleReplicaRequest struct {
	Organization string
	Database     string
}

type MaterializeCancelRequest struct {
	Organization     string `json:"-"`
	Database         string `json:"-"`
	Branch           string `json:"-"`
	Workflow         string `json:"-"`
	TargetKeyspace   string `json:"target_keyspace"`
	KeepData         *bool  `json:"keep_data,omitempty"`
	KeepRoutingRules *bool  `json:"keep_routing_rules,omitempty"`
}

type MaterializeCreateRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Workflow                     string          `json:"workflow"`
	TargetKeyspace               string          `json:"target_keyspace"`
	SourceKeyspace               string          `json:"source_keyspace"`
	TableSettings                json.RawMessage `json:"table_settings"`
	Cells                        []string        `json:"cells,omitempty"`
	ReferenceTables              []string        `json:"reference_tables,omitempty"`
	TabletTypes                  []string        `json:"tablet_types,omitempty"`
	StopAfterCopy                *bool           `json:"stop_after_copy,omitempty"`
	TabletTypesInPreferenceOrder *bool           `json:"tablet_types_in_preference_order,omitempty"`
	DeferSecondaryKeys           *bool           `json:"defer_secondary_keys,omitempty"`
	AtomicCopy                   *bool           `json:"atomic_copy,omitempty"`
	OnDDL                        string          `json:"on_ddl,omitempty"`
	SourceTimeZone               string          `json:"source_time_zone,omitempty"`
}

type MaterializeService interface {
	Create(context.Context, *MaterializeCreateRequest) (json.RawMessage, error)
	Show(context.Context, *MaterializeShowRequest) (json.RawMessage, error)
	Start(context.Context, *MaterializeStartRequest) (json.RawMessage, error)
	Stop(context.Context, *MaterializeStopRequest) (json.RawMessage, error)
	Cancel(context.Context, *MaterializeCancelRequest) (json.RawMessage, error)
}

type MaterializeShowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	TargetKeyspace string `json:"-"`
	IncludeLogs    *bool  `json:"-"`
}

type MaterializeStartRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	TargetKeyspace string `json:"target_keyspace"`
}

type MaterializeStopRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	TargetKeyspace string `json:"target_keyspace"`
}

type MoveTablesCancelRequest struct {
	Organization     string `json:"-"`
	Database         string `json:"-"`
	Branch           string `json:"-"`
	Workflow         string `json:"-"`
	TargetKeyspace   string `json:"target_keyspace"`
	KeepData         *bool  `json:"keep_data,omitempty"`
	KeepRoutingRules *bool  `json:"keep_routing_rules,omitempty"`
}

type MoveTablesCompleteRequest struct {
	Organization     string `json:"-"`
	Database         string `json:"-"`
	Branch           string `json:"-"`
	Workflow         string `json:"-"`
	TargetKeyspace   string `json:"target_keyspace"`
	KeepData         *bool  `json:"keep_data,omitempty"`
	KeepRoutingRules *bool  `json:"keep_routing_rules,omitempty"`
	RenameTables     *bool  `json:"rename_tables,omitempty"`
	DryRun           *bool  `json:"dry_run,omitempty"`
}

type MoveTablesCreateRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Workflow                     string   `json:"workflow"`
	TargetKeyspace               string   `json:"target_keyspace"`
	SourceKeyspace               string   `json:"source_keyspace"`
	Tables                       []string `json:"tables,omitempty"`
	AllTables                    *bool    `json:"all_tables,omitempty"`
	AutoStart                    *bool    `json:"auto_start,omitempty"`
	StopAfterCopy                *bool    `json:"stop_after_copy,omitempty"`
	DeferSecondaryKeys           *bool    `json:"defer_secondary_keys,omitempty"`
	OnDDL                        string   `json:"on_ddl,omitempty"`
	ShardedAutoIncrementHandling string   `json:"sharded_auto_increment_handling,omitempty"`
	GlobalKeyspace               string   `json:"global_keyspace,omitempty"`
	SourceTimeZone               string   `json:"source_time_zone,omitempty"`
	TenantID                     string   `json:"tenant_id,omitempty"`
	Cells                        []string `json:"cells,omitempty"`
	TabletTypes                  []string `json:"tablet_types,omitempty"`
	ExcludeTables                []string `json:"exclude_tables,omitempty"`
	AtomicCopy                   *bool    `json:"atomic_copy,omitempty"`
}

type MoveTablesReverseTrafficRequest struct {
	Organization             string   `json:"-"`
	Database                 string   `json:"-"`
	Branch                   string   `json:"-"`
	Workflow                 string   `json:"-"`
	TargetKeyspace           string   `json:"target_keyspace"`
	TabletTypes              []string `json:"tablet_types,omitempty"`
	MaxReplicationLagAllowed *int64   `json:"max_replication_lag_allowed,omitempty"`
	DryRun                   *bool    `json:"dry_run,omitempty"`
}

type MoveTablesService interface {
	Create(context.Context, *MoveTablesCreateRequest) (*VtctldOperationReference, error)
	Show(context.Context, *MoveTablesShowRequest) (json.RawMessage, error)
	Status(context.Context, *MoveTablesStatusRequest) (json.RawMessage, error)
	SwitchTraffic(context.Context, *MoveTablesSwitchTrafficRequest) (*VtctldOperationReference, error)
	ReverseTraffic(context.Context, *MoveTablesReverseTrafficRequest) (*VtctldOperationReference, error)
	Cancel(context.Context, *MoveTablesCancelRequest) (*VtctldOperationReference, error)
	Complete(context.Context, *MoveTablesCompleteRequest) (*VtctldOperationReference, error)
}

type MoveTablesShowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	TargetKeyspace string `json:"-"`
}

type MoveTablesStatusRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	TargetKeyspace string `json:"-"`
}

type MoveTablesSwitchTrafficRequest struct {
	Organization              string   `json:"-"`
	Database                  string   `json:"-"`
	Branch                    string   `json:"-"`
	Workflow                  string   `json:"-"`
	TargetKeyspace            string   `json:"target_keyspace"`
	TabletTypes               []string `json:"tablet_types,omitempty"`
	MaxReplicationLagAllowed  *int64   `json:"max_replication_lag_allowed,omitempty"`
	DryRun                    *bool    `json:"dry_run,omitempty"`
	InitializeTargetSequences *bool    `json:"initialize_target_sequences,omitempty"`
}

type Organization struct {
	Name                   string    `json:"name"`
	CreatedAt              time.Time `json:"created_at"`
	UpdatedAt              time.Time `json:"updated_at"`
	RemainingFreeDatabases int       `json:"free_databases_remaining"`
}

type OrganizationsService interface {
	Get(context.Context, *GetOrganizationRequest) (*Organization, error)
	List(context.Context) ([]*Organization, error)
	ListRegions(context.Context, *ListOrganizationRegionsRequest) ([]*Region, error)
	ListClusterSKUs(context.Context, *ListOrganizationClusterSKUsRequest, ...ListOption) ([]*ClusterSKU, error)
}

type PasswordsService interface {
	Create(context.Context, *DatabaseBranchPasswordRequest) (*DatabaseBranchPassword, error)
	// List returns passwords with optional pagination support via ListOption parameters
	List(context.Context, *ListDatabaseBranchPasswordRequest, ...ListOption) ([]*DatabaseBranchPassword, error)
	Get(context.Context, *GetDatabaseBranchPasswordRequest) (*DatabaseBranchPassword, error)
	Delete(context.Context, *DeleteDatabaseBranchPasswordRequest) error
	Renew(context.Context, *RenewDatabaseBranchPasswordRequest) (*DatabaseBranchPassword, error)
}

type PerformDeployRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
	InstantDDL   bool   `json:"instant_ddl"`
	Strategy     string `json:"strategy,omitempty"`
}

type PlannedReparentShardRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"keyspace"`
	Shard        string `json:"shard"`
	NewPrimary   string `json:"new_primary"`
}

type PlannedReparentShardService interface {
	Create(context.Context, *PlannedReparentShardRequest) (*VtctldOperation, error)
	Get(context.Context, *GetPlannedReparentShardRequest) (*VtctldOperation, error)
}

type PostgresBranch struct {
	ID                  string    `json:"id"`
	Name                string    `json:"name"`
	ClusterName         string    `json:"cluster_name"`
	ClusterDisplayName  string    `json:"cluster_display_name"`
	ClusterArchitecture string    `json:"cluster_architecture"`
	ClusterIOPS         int       `json:"cluster_iops"`
	State               string    `json:"state"`
	CreatedAt           time.Time `json:"created_at"`
	UpdatedAt           time.Time `json:"updated_at"`
	Actor               Actor     `json:"actor"`
	Production          bool      `json:"production"`
	Ready               bool      `json:"ready"`
	ParentBranch        string    `json:"parent_branch"`
	Region              Region    `json:"region"`
	Kind                string    `json:"kind"`
	Replicas            int       `json:"replicas"`
}

type PostgresBranchClusterResizeRequest struct {
	ID    string `json:"id"`
	State string `json:"state"`

	ClusterName        string `json:"cluster_name"`
	ClusterDisplayName string `json:"cluster_display_name"`
	Replicas           int    `json:"replicas"`

	PreviousClusterName        string `json:"previous_cluster_name"`
	PreviousClusterDisplayName string `json:"previous_cluster_display_name"`
	PreviousReplicas           int    `json:"previous_replicas"`

	StartedAt   *time.Time `json:"started_at"`
	CompletedAt *time.Time `json:"completed_at"`
	CreatedAt   time.Time  `json:"created_at"`
	UpdatedAt   time.Time  `json:"updated_at"`
}

type PostgresBranchInfrastructure struct {
	State                           string                  `json:"state"`
	PrimaryName                     string                  `json:"primary_name"`
	PrimaryPromotedAt               *time.Time              `json:"primary_promoted_at"`
	VolumeModificationsBlockedUntil *time.Time              `json:"volume_modifications_blocked_until"`
	Nodes                           []*PostgresInfraNode    `json:"nodes"`
	Bouncers                        []*PostgresInfraBouncer `json:"bouncers"`
}

type PostgresBranchSchema struct {
	Name string `json:"name"`
	Raw  string `json:"raw"`
	HTML string `json:"html"`
}

type PostgresBranchSchemaRequest struct {
	Organization string
	Database     string
	Branch       string
	Namespace    string `json:"-"`
}

type PostgresBranchesService interface {
	Create(context.Context, *CreatePostgresBranchRequest) (*PostgresBranch, error)
	List(context.Context, *ListPostgresBranchesRequest, ...ListOption) ([]*PostgresBranch, error)
	Get(context.Context, *GetPostgresBranchRequest) (*PostgresBranch, error)
	Delete(context.Context, *DeletePostgresBranchRequest) error
	Schema(context.Context, *PostgresBranchSchemaRequest) ([]*PostgresBranchSchema, error)
	ListClusterSKUs(context.Context, *ListBranchClusterSKUsRequest, ...ListOption) ([]*ClusterSKU, error)
	Resize(context.Context, *ResizePostgresBranchRequest) (*PostgresBranchClusterResizeRequest, error)
}

type PostgresInfraBouncer struct {
	ID              string                   `json:"id"`
	Name            string                   `json:"name"`
	Target          string                   `json:"target"`
	ReplicasPerCell int                      `json:"replicas_per_cell"`
	Region          Region                   `json:"region"`
	SKU             *PostgresInfraBouncerSKU `json:"sku"`
}

type PostgresInfraBouncerSKU struct {
	Name        string `json:"name"`
	DisplayName string `json:"display_name"`
	CPU         string `json:"cpu"`
	RAM         int64  `json:"ram"`
}

type PostgresInfraDiskReplacement struct {
	Reason      string     `json:"reason"`
	Bytes       int64      `json:"bytes"`
	ScheduledAt *time.Time `json:"scheduled_at"`
}

type PostgresInfraNode struct {
	Name                         string                        `json:"name"`
	NormalizedName               string                        `json:"normalized_name"`
	Role                         string                        `json:"role"`
	AvailabilityZone             string                        `json:"availability_zone"`
	ClusterName                  string                        `json:"cluster_name"`
	ClusterDisplayName           string                        `json:"cluster_display_name"`
	PeersCount                   int                           `json:"peers_count"`
	VolumeUsageBytes             *int64                        `json:"volume_usage_bytes"`
	VolumeCapacityBytes          *int64                        `json:"volume_capacity_bytes"`
	VolumeShrinkThresholdPercent *float64                      `json:"volume_shrink_threshold_percent"`
	Region                       Region                        `json:"region"`
	DiskReplacement              *PostgresInfraDiskReplacement `json:"disk_replacement"`
}

type PostgresRole struct {
	ID              string    `json:"id"`
	Name            string    `json:"name"`
	AccessHostURL   string    `json:"access_host_url"`
	DatabaseName    string    `json:"database_name"`
	Password        string    `json:"password"`
	Actor           Actor     `json:"actor"`
	Username        string    `json:"username"`
	WithReplication bool      `json:"with_replication"`
	CreatedAt       time.Time `json:"created_at"`
}

type PostgresRolesService interface {
	List(context.Context, *ListPostgresRolesRequest, ...ListOption) ([]*PostgresRole, error)
	Get(context.Context, *GetPostgresRoleRequest) (*PostgresRole, error)
	Create(context.Context, *CreatePostgresRoleRequest) (*PostgresRole, error)
	Update(context.Context, *UpdatePostgresRoleRequest) (*PostgresRole, error)
	Renew(context.Context, *RenewPostgresRoleRequest) (*PostgresRole, error)
	Delete(context.Context, *DeletePostgresRoleRequest) error
	ResetDefaultRole(context.Context, *ResetDefaultRoleRequest) (*PostgresRole, error)
	ResetPassword(context.Context, *ResetPostgresRolePasswordRequest) (*PostgresRole, error)
	ReassignObjects(context.Context, *ReassignPostgresRoleObjectsRequest) error
}

type Process struct {
	ID      int64  `json:"id"`
	User    string `json:"user"`
	Host    string `json:"host"`
	DB      string `json:"db"`
	Command string `json:"command"`
	Time    int64  `json:"time"`
	State   string `json:"state"`
	Info    string `json:"info"`
}

type ProcesslistRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
	Shard        string `json:"-"`
}

type ProcesslistResult struct {
	Keyspace  string    `json:"keyspace"`
	Shard     string    `json:"shard"`
	Tablet    string    `json:"tablet"`
	Processes []Process `json:"processes"`
}

type ProcesslistService interface {
	List(context.Context, *ProcesslistRequest) (*ProcesslistResult, error)
	Kill(context.Context, *KillProcessRequest) (*KillProcessResult, error)
}

type PromoteRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type QueryPatternsReport struct {
	PublicID    string    `json:"id"`
	State       string    `json:"state"`
	Actor       *Actor    `json:"actor"`
	URL         string    `json:"url"`
	DownloadURL string    `json:"download_url"`
	CreatedAt   time.Time `json:"created_at"`
	FinishedAt  time.Time `json:"finished_at"`
}

type QueryPatternsService interface {
	CreateReport(context.Context, *CreateQueryPatternsReportRequest) (*QueryPatternsReport, error)
	GetReport(context.Context, *GetQueryPatternsReportRequest) (*QueryPatternsReport, error)
	DownloadReport(context.Context, *DownloadQueryPatternsReportRequest) (io.ReadCloser, error)
}

type QueuedDeployment struct {
	ID                  string `json:"id"`
	State               string `json:"state"`
	DeployRequestNumber uint64 `json:"deploy_request_number"`
	IntoBranch          string `json:"into_branch"`

	Actor *Actor `json:"actor"`

	CreatedAt  time.Time  `json:"created_at"`
	UpdatedAt  time.Time  `json:"updated_at"`
	StartedAt  *time.Time `json:"started_at"`
	QueuedAt   *time.Time `json:"queued_at"`
	FinishedAt *time.Time `json:"finished_at"`
}

type ReassignPostgresRoleObjectsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoleId       string `json:"-"`
	Successor    string `json:"successor"`
}

type RefreshSchemaRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type Region struct {
	Slug      string `json:"slug"`
	Provider  string `json:"provider"`
	Name      string `json:"display_name"`
	Location  string `json:"location"`
	Enabled   bool   `json:"enabled"`
	IsDefault bool   `json:"current_default"`
}

type RegionsService interface {
	List(ctx context.Context, req *ListRegionsRequest) ([]*Region, error)
}

type RenewDatabaseBranchPasswordRequest struct {
	Organization string
	Database     string
	Branch       string
	PasswordId   string
}

type RenewPostgresRoleRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoleId       string `json:"-"`
}

type ReplicationDurabilityConstraints struct {
	Strategy string `json:"strategy"`
}

type RequestOption func(*requestOptions)

type ResetDefaultRoleRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type ResetPostgresRolePasswordRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoleId       string `json:"-"`
}

type ResizeKeyspaceRequest struct {
	Organization  string  `json:"-"`
	Database      string  `json:"-"`
	Branch        string  `json:"-"`
	Keyspace      string  `json:"-"`
	ExtraReplicas *uint   `json:"extra_replicas,omitempty"`
	ClusterSize   *string `json:"cluster_size,omitempty"`
}

type ResizePostgresBranchRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	// ClusterSize is the fully-qualified cluster size SKU name to resize to,
	// e.g. "PS_10_GCP_X86". Use the values returned by ListClusterSKUs.
	ClusterSize string `json:"cluster_size,omitempty"`
	// Replicas is the desired number of replicas. Nil leaves it unchanged.
	Replicas *int `json:"replicas,omitempty"`
}

type RetryWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type ReverseCutoverWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type ReverseTrafficWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type RevertDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type ReviewAction int

type ReviewDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`

	// CommentText represents the comment body to be posted
	CommentText string `json:"-"`

	// ReviewAction defines the action for an individual review.
	ReviewAction ReviewAction `json:"-"`
}

type RoutingRules struct {
	Raw  string `json:"raw"`
	HTML string `json:"html"`
}

type SchemaLintError struct {
	LintError        string `json:"lint_error"`
	Keyspace         string `json:"keyspace_name"`
	Table            string `json:"table_name"`
	SubjectType      string `json:"subject_type"`
	ErrorDescription string `json:"error_description"`
	DocsURL          string `json:"docs_url"`
}

type SchemaRecommendation struct {
	ID                    string                 `json:"id"`
	HtmlURL               string                 `json:"html_url"`
	Title                 string                 `json:"title"`
	Table                 string                 `json:"table_name"`
	Keyspace              string                 `json:"keyspace"`
	DDLStatement          string                 `json:"ddl_statement"`
	Number                int                    `json:"number"`
	State                 string                 `json:"state"`
	RecommendationType    string                 `json:"recommendation_type"`
	CreatedAt             time.Time              `json:"created_at"`
	UpdatedAt             time.Time              `json:"updated_at"`
	AppliedAt             *time.Time             `json:"applied_at"`
	DismissedAt           *time.Time             `json:"dismissed_at"`
	ClosedByDeployRequest *ClosedByDeployRequest `json:"closed_by_deploy_request"`
	DismissedBy           *Actor                 `json:"dismissed_by"`
}

type SchemaRecommendationService interface {
	List(context.Context, *ListSchemaRecommendationsRequest, ...ListOption) ([]*SchemaRecommendation, error)
	Get(context.Context, *GetSchemaRecommendationRequest) (*SchemaRecommendation, error)
	Dismiss(context.Context, *DismissSchemaRecommendationRequest) (*SchemaRecommendation, error)
}

type ServiceToken struct {
	ID         string     `json:"id"`
	Type       string     `json:"type"`
	Token      string     `json:"token"`
	Name       *string    `json:"name"`
	CreatedAt  time.Time  `json:"created_at"`
	LastUsedAt *time.Time `json:"last_used_at"`
	ExpiresAt  *time.Time `json:"expires_at"`
}

type ServiceTokenAccess struct {
	ID       string               `json:"id"`
	Access   string               `json:"access"`
	Type     string               `json:"type"`
	Resource ServiceTokenResource `json:"resource"`
}

type ServiceTokenGrant struct {
	ID           string                     `json:"id"`
	ResourceName string                     `json:"resource_name"`
	ResourceType string                     `json:"resource_type"`
	ResourceID   string                     `json:"resource_id"`
	Accesses     []*ServiceTokenGrantAccess `json:"accesses"`
}

type ServiceTokenGrantAccess struct {
	Access      string `json:"access"`
	Description string `json:"description"`
}

type ServiceTokenResource struct {
	ID   string `json:"id"`
	Name string `json:"name"`
	Type string `json:"type"`
}

type ServiceTokenService interface {
	Create(context.Context, *CreateServiceTokenRequest) (*ServiceToken, error)
	List(context.Context, *ListServiceTokensRequest) ([]*ServiceToken, error)
	ListGrants(context.Context, *ListServiceTokenGrantsRequest) ([]*ServiceTokenGrant, error)
	Delete(context.Context, *DeleteServiceTokenRequest) error
	GetAccess(context.Context, *GetServiceTokenAccessRequest) ([]*ServiceTokenAccess, error)
	AddAccess(context.Context, *AddServiceTokenAccessRequest) ([]*ServiceTokenAccess, error)
	DeleteAccess(context.Context, *DeleteServiceTokenAccessRequest) error
}

type ShardRollout struct {
	Name  string `json:"name"`
	State string `json:"state"`

	LastRolloutStartedAt  time.Time `json:"last_rollout_started_at"`
	LastRolloutFinishedAt time.Time `json:"last_rollout_finished_at"`
}

type SkipRevertDeployRequestRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Number       uint64 `json:"-"`
}

type StartDataImportRequest struct {
	Organization string           `json:"organization"`
	Database     string           `json:"database_name"`
	Connection   DataImportSource `json:"connection"`
	Region       string           `json:"region"`
	Plan         string           `json:"plan"`
	MaxPoolSize  int              `json:"max_pool_size"`
}

type StorageConfig struct {
	MinimumStorageBytes *int64 `json:"minimum_storage_bytes,omitempty"`
	MaximumStorageBytes *int64 `json:"maximum_storage_bytes,omitempty"`
}

type SwitchPrimariesWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type SwitchReplicasWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type Tablet struct {
	Alias string `json:"alias"`
	Role  string `json:"role"`
	Cell  string `json:"cell"`
}

type TabletGroup struct {
	Type     string   `json:"type"`
	Keyspace string   `json:"keyspace"`
	Shard    string   `json:"shard"`
	Tablets  []Tablet `json:"tablets"`
}

type TestDataImportSourceRequest struct {
	Organization string           `json:"organization"`
	Database     string           `json:"database_name"`
	Connection   DataImportSource `json:"connection"`
}

type TestDataImportSourceResponse struct {
	CanConnect           bool   `json:"can_connect"`
	ShouldUpgradePlan    bool   `json:"should_upgrade"`
	SuggestedPlan        string `json:"suggested_plan"`
	SuggestedBillingPlan BillingPlan
	ConnectError         string                            `json:"error"`
	Errors               []*DataSourceIncompatibilityError `json:"lint_errors"`
	MaxPoolSize          int                               `json:"max_pool_size"`
}

type TestWebhookRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	ID           string `json:"-"`
}

type TrafficBudget struct {
	ID   string `json:"id"`
	Type string `json:"type"`

	Name string `json:"name"`
	Mode string `json:"mode"`

	Capacity         *int `json:"capacity"`
	Rate             *int `json:"rate"`
	Burst            *int `json:"burst"`
	Concurrency      *int `json:"concurrency"`
	WarningThreshold *int `json:"warning_threshold"`

	Rules []TrafficRule `json:"rules"`

	Actor     Actor     `json:"actor"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type TrafficBudgetsService interface {
	List(context.Context, *ListTrafficBudgetsRequest) ([]*TrafficBudget, error)
	Get(context.Context, *GetTrafficBudgetRequest) (*TrafficBudget, error)
	Create(context.Context, *CreateTrafficBudgetRequest) (*TrafficBudget, error)
	Update(context.Context, *UpdateTrafficBudgetRequest) (*TrafficBudget, error)
	Delete(context.Context, *DeleteTrafficBudgetRequest) error
}

type TrafficRule struct {
	ID                   string           `json:"id"`
	Type                 string           `json:"type"`
	Kind                 string           `json:"kind"`
	Fingerprint          *string          `json:"fingerprint"`
	Keyspace             *string          `json:"keyspace"`
	Tags                 []TrafficRuleTag `json:"tags"`
	Actor                Actor            `json:"actor"`
	SyntaxHighlightedSQL string           `json:"syntax_highlighted_sql"`
	CreatedAt            time.Time        `json:"created_at"`
	UpdatedAt            time.Time        `json:"updated_at"`
}

type TrafficRuleTag struct {
	Type   string `json:"type"`
	KeyID  string `json:"key_id"`
	Key    string `json:"key"`
	Value  string `json:"value"`
	Source string `json:"source"`
}

type TrafficRulesService interface {
	Create(context.Context, *CreateTrafficRuleRequest) (*TrafficRule, error)
	Delete(context.Context, *DeleteTrafficRuleRequest) error
}

type UpdateBranchRoutingRulesRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoutingRules string `json:"routing_rules"`
}

type UpdateKeyspaceSettingsRequest struct {
	Organization                     string                            `json:"-"`
	Database                         string                            `json:"-"`
	Branch                           string                            `json:"-"`
	Keyspace                         string                            `json:"-"`
	ReplicationDurabilityConstraints *ReplicationDurabilityConstraints `json:"replication_durability_constraints,omitempty"`
	VReplicationFlags                *VReplicationFlags                `json:"vreplication_flags,omitempty"`
}

type UpdateKeyspaceVSchemaRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
	VSchema      string `json:"vschema"`
}

type UpdatePostgresRoleRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	RoleId       string `json:"-"`
	Name         string `json:"name"`
}

type UpdateTrafficBudgetRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	BudgetID     string `json:"-"`

	Name *string `json:"name,omitempty"`
	Mode *string `json:"mode,omitempty"`

	Capacity         *int `json:"capacity,omitempty"`
	Rate             *int `json:"rate,omitempty"`
	Burst            *int `json:"burst,omitempty"`
	Concurrency      *int `json:"concurrency,omitempty"`
	WarningThreshold *int `json:"warning_threshold,omitempty"`

	Rules *[]CreateTrafficBudgetRuleRequest `json:"rules,omitempty"`
}

type UpdateWebhookRequest struct {
	Organization string   `json:"-"`
	Database     string   `json:"-"`
	ID           string   `json:"-"`
	URL          *string  `json:"url,omitempty"`
	Enabled      *bool    `json:"enabled,omitempty"`
	Events       []string `json:"events,omitempty"`
}

type UserShouldUpgradePlanError struct{}

type VDiffCreateRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Workflow     string `json:"-"`

	TargetKeyspace              string   `json:"target_keyspace"`
	AutoRetry                   *bool    `json:"auto_retry,omitempty"`
	AutoStart                   *bool    `json:"auto_start,omitempty"`
	DebugQuery                  bool     `json:"debug_query,omitempty"`
	OnlyPKs                     bool     `json:"only_pks,omitempty"`
	UpdateTableStats            bool     `json:"update_table_stats,omitempty"`
	Verbose                     bool     `json:"verbose,omitempty"`
	Tables                      []string `json:"tables,omitempty"`
	TabletTypes                 []string `json:"tablet_types,omitempty"`
	TabletSelectionPreference   string   `json:"tablet_selection_preference,omitempty"`
	FilteredReplicationWaitTime *int     `json:"filtered_replication_wait_time,omitempty"`
	MaxReportSampleRows         *int     `json:"max_report_sample_rows,omitempty"`
	MaxExtraRowsToCompare       *int     `json:"max_extra_rows_to_compare,omitempty"`
	RowDiffColumnTruncateAt     *int     `json:"row_diff_column_truncate_at,omitempty"`
	Limit                       *int     `json:"limit,omitempty"`
}

type VDiffDeleteRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	UUID           string `json:"-"`
	TargetKeyspace string `json:"-"`
}

type VDiffListRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	TargetKeyspace string `json:"-"`
}

type VDiffResumeRequest struct {
	Organization   string   `json:"-"`
	Database       string   `json:"-"`
	Branch         string   `json:"-"`
	Workflow       string   `json:"-"`
	UUID           string   `json:"-"`
	TargetKeyspace string   `json:"target_keyspace"`
	TargetShards   []string `json:"target_shards,omitempty"`
}

type VDiffService interface {
	Create(context.Context, *VDiffCreateRequest) (json.RawMessage, error)
	List(context.Context, *VDiffListRequest) (json.RawMessage, error)
	Show(context.Context, *VDiffShowRequest) (json.RawMessage, error)
	Stop(context.Context, *VDiffStopRequest) (json.RawMessage, error)
	Resume(context.Context, *VDiffResumeRequest) (json.RawMessage, error)
	Delete(context.Context, *VDiffDeleteRequest) (json.RawMessage, error)
}

type VDiffShowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	Branch         string `json:"-"`
	Workflow       string `json:"-"`
	UUID           string `json:"-"`
	TargetKeyspace string `json:"-"`
}

type VDiffStopRequest struct {
	Organization   string   `json:"-"`
	Database       string   `json:"-"`
	Branch         string   `json:"-"`
	Workflow       string   `json:"-"`
	UUID           string   `json:"-"`
	TargetKeyspace string   `json:"target_keyspace"`
	TargetShards   []string `json:"target_shards,omitempty"`
}

type VReplicationFlags struct {
	OptimizeInserts           bool `json:"optimize_inserts"`
	AllowNoBlobBinlogRowImage bool `json:"allow_no_blob_binlog_row_image"`
	VPlayerBatching           bool `json:"vplayer_batching"`
}

type VSchema struct {
	Raw  string `json:"raw"`
	HTML string `json:"html"`
}

type VerifyDataWorkflowRequest struct {
	Organization   string `json:"-"`
	Database       string `json:"-"`
	WorkflowNumber uint64 `json:"-"`
}

type VitessBranchInfrastructure struct {
	Ready bool              `json:"ready"`
	Pods  []*BranchInfraPod `json:"pods"`
}

type VtctldCheckThrottlerRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	TabletAlias string `json:"tablet_alias"`
	// AppName is the app to issue the check on behalf of (e.g. "online-ddl"). If
	// empty, the throttler's default app is used.
	AppName string `json:"app_name,omitempty"`
	// Scope is the scope of the check, either "shard" or "self". If empty, the
	// throttler's default scope is used.
	Scope string `json:"scope,omitempty"`
	// SkipRequestHeartbeats instructs the throttler not to renew its heartbeat
	// lease while serving this check.
	SkipRequestHeartbeats *bool `json:"skip_request_heartbeats,omitempty"`
	// OkIfNotExists instructs the throttler to return OK even if the requested
	// metric does not exist.
	OkIfNotExists *bool `json:"ok_if_not_exists,omitempty"`
}

type VtctldGetRoutingRulesRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
}

type VtctldGetShardRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
	Shard        string `json:"-"`
}

type VtctldGetThrottlerStatusRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	TabletAlias  string `json:"-"`
}

type VtctldListKeyspacesRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Name         string `json:"-"`
}

type VtctldListWorkflowsRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Keyspace     string `json:"-"`
	Workflow     string `json:"-"`
	IncludeLogs  *bool  `json:"-"`
}

type VtctldOperation struct {
	ID          string          `json:"id"`
	Type        string          `json:"type"`
	Action      string          `json:"action"`
	Timeout     int             `json:"timeout"`
	CreatedAt   time.Time       `json:"created_at"`
	CompletedAt *time.Time      `json:"completed_at"`
	State       string          `json:"state"`
	Completed   bool            `json:"completed"`
	Metadata    json.RawMessage `json:"metadata"`
	Result      json.RawMessage `json:"result"`
	Error       string          `json:"error"`
}

type VtctldOperationReference struct {
	ID string `json:"id"`
}

type VtctldRefreshStateByShardRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Keyspace string   `json:"keyspace"`
	Shard    string   `json:"shard"`
	Cells    []string `json:"cells,omitempty"`
}

type VtctldService interface {
	ListWorkflows(context.Context, *VtctldListWorkflowsRequest) (json.RawMessage, error)
	ListKeyspaces(context.Context, *VtctldListKeyspacesRequest) (json.RawMessage, error)
	GetRoutingRules(context.Context, *VtctldGetRoutingRulesRequest) (json.RawMessage, error)
	GetShard(context.Context, *VtctldGetShardRequest) (json.RawMessage, error)
	SetShardTabletControl(context.Context, *VtctldSetShardTabletControlRequest) (json.RawMessage, error)
	RefreshStateByShard(context.Context, *VtctldRefreshStateByShardRequest) (json.RawMessage, error)
	ListTablets(context.Context, *ListBranchTabletsRequest) ([]*TabletGroup, error)
	StartWorkflow(context.Context, *VtctldStartWorkflowRequest) (json.RawMessage, error)
	StopWorkflow(context.Context, *VtctldStopWorkflowRequest) (json.RawMessage, error)
	GetThrottlerStatus(context.Context, *VtctldGetThrottlerStatusRequest) (json.RawMessage, error)
	CheckThrottler(context.Context, *VtctldCheckThrottlerRequest) (json.RawMessage, error)
	UpdateThrottlerConfig(context.Context, *VtctldUpdateThrottlerConfigRequest) (json.RawMessage, error)
	GetOperation(context.Context, *GetVtctldOperationRequest) (*VtctldOperation, error)
}

type VtctldSetShardTabletControlRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Keyspace            string   `json:"keyspace"`
	Shard               string   `json:"shard"`
	TabletType          string   `json:"tablet_type"`
	Cells               []string `json:"cells,omitempty"`
	DeniedTables        []string `json:"denied_tables,omitempty"`
	Remove              *bool    `json:"remove,omitempty"`
	DisableQueryService *bool    `json:"disable_query_service,omitempty"`
}

type VtctldStartWorkflowRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Workflow     string `json:"-"`
	Keyspace     string `json:"keyspace"`
}

type VtctldStopWorkflowRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`
	Workflow     string `json:"-"`
	Keyspace     string `json:"keyspace"`
}

type VtctldThrottledAppConfig struct {
	// Name is the app to throttle (e.g. "online-ddl", "vreplication", or an
	// Online DDL migration UUID).
	Name string `json:"name"`
	// Ratio is the fraction of operations to throttle for the app, 0.00-1.00 in
	// increments of 0.01.
	Ratio *float64 `json:"ratio,omitempty"`
	// ExpireAt is an optional RFC3339 expiration time for the app rule. It must
	// be in the future. Omit to throttle until changed.
	ExpireAt string `json:"expire_at,omitempty"`
}

type VtctldUpdateThrottlerConfigRequest struct {
	Organization string `json:"-"`
	Database     string `json:"-"`
	Branch       string `json:"-"`

	Keyspace string `json:"keyspace"`
	// Enabled controls whether the tablet throttler is enabled for the keyspace.
	// It is required: the API has no tri-state, so omitting it would disable the
	// throttler.
	Enabled bool `json:"enabled"`
	// Threshold is the threshold for the default throttler check (replication lag
	// in seconds). It must be >= 0; the server defaults to 5.0 when omitted.
	Threshold *float64 `json:"threshold,omitempty"`
	// Apps configures zero or more per-app throttling rules.
	Apps []VtctldThrottledAppConfig `json:"apps,omitempty"`
}

type Webhook struct {
	ID              string    `json:"id"`
	URL             string    `json:"url"`
	Secret          string    `json:"secret"`
	Enabled         bool      `json:"enabled"`
	LastSentResult  string    `json:"last_sent_result"`
	LastSentSuccess bool      `json:"last_sent_success"`
	LastSentAt      time.Time `json:"last_sent_at"`
	CreatedAt       time.Time `json:"created_at"`
	UpdatedAt       time.Time `json:"updated_at"`
	Events          []string  `json:"events"`
}

type WebhooksService interface {
	List(context.Context, *ListWebhooksRequest, ...ListOption) ([]*Webhook, error)
	Create(context.Context, *CreateWebhookRequest) (*Webhook, error)
	Get(context.Context, *GetWebhookRequest) (*Webhook, error)
	Update(context.Context, *UpdateWebhookRequest) (*Webhook, error)
	Delete(context.Context, *DeleteWebhookRequest) error
	Test(context.Context, *TestWebhookRequest) error
}

type Workflow struct {
	ID                  string     `json:"id"`
	Name                string     `json:"name"`
	Number              uint64     `json:"number"`
	State               string     `json:"state"`
	CreatedAt           time.Time  `json:"created_at"`
	UpdatedAt           time.Time  `json:"updated_at"`
	StartedAt           *time.Time `json:"started_at"`
	CompletedAt         *time.Time `json:"completed_at"`
	CancelledAt         *time.Time `json:"cancelled_at"`
	ReversedAt          *time.Time `json:"reversed_at"`
	RetriedAt           *time.Time `json:"retried_at"`
	DataCopyCompletedAt *time.Time `json:"data_copy_completed_at"`
	CutoverAt           *time.Time `json:"cutover_at"`
	ReplicasSwitched    bool       `json:"replicas_switched"`
	PrimariesSwitched   bool       `json:"primaries_switched"`
	SwitchReplicasAt    *time.Time `json:"switch_replicas_at"`
	SwitchPrimariesAt   *time.Time `json:"switch_primaries_at"`
	VerifyDataAt        *time.Time `json:"verify_data_at"`

	Branch         DatabaseBranch `json:"branch"`
	SourceKeyspace Keyspace       `json:"source_keyspace"`
	TargetKeyspace Keyspace       `json:"target_keyspace"`

	Actor             Actor  `json:"actor"`
	VerifyDataBy      *Actor `json:"verify_data_by"`
	ReversedBy        *Actor `json:"reversed_by"`
	SwitchReplicasBy  *Actor `json:"switch_replicas_by"`
	SwitchPrimariesBy *Actor `json:"switch_primaries_by"`
	CancelledBy       *Actor `json:"cancelled_by"`
	CompletedBy       *Actor `json:"completed_by"`
	RetriedBy         *Actor `json:"retried_by"`
	CutoverBy         *Actor `json:"cutover_by"`
	ReversedCutoverBy *Actor `json:"reversed_cutover_by"`

	Streams []*WorkflowStream `json:"streams"`
	Tables  []*WorkflowTable  `json:"tables"`
	VDiff   *WorkflowVDiff    `json:"vdiff"`
}

type WorkflowStream struct {
	PublicID             string              `json:"id"`
	State                string              `json:"state"`
	CreatedAt            time.Time           `json:"created_at"`
	UpdatedAt            time.Time           `json:"updated_at"`
	TargetShard          string              `json:"target_shard"`
	SourceShard          string              `json:"source_shard"`
	Position             string              `json:"position"`
	StopPosition         string              `json:"stop_position"`
	RowsCopied           int64               `json:"rows_copied"`
	ComponentThrottled   *string             `json:"component_throttled"`
	ComponentThrottledAt *time.Time          `json:"component_throttled_at"`
	PrimaryServing       bool                `json:"primary_serving"`
	Info                 string              `json:"info"`
	Logs                 []WorkflowStreamLog `json:"logs"`
}

type WorkflowStreamLog struct {
	PublicID  string    `json:"id"`
	State     string    `json:"state"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	Message   string    `json:"message"`
	LogType   string    `json:"log_type"`
}

type WorkflowTable struct {
	PublicID       string    `json:"id"`
	Name           string    `json:"name"`
	CreatedAt      time.Time `json:"created_at"`
	UpdatedAt      time.Time `json:"updated_at"`
	RowsCopied     uint64    `json:"rows_copied"`
	RowsTotal      uint64    `json:"rows_total"`
	RowsPercentage uint      `json:"rows_percentage"`
}

type WorkflowVDiff struct {
	PublicID           string                     `json:"id"`
	State              string                     `json:"state"`
	CreatedAt          time.Time                  `json:"created_at"`
	UpdatedAt          time.Time                  `json:"updated_at"`
	StartedAt          *time.Time                 `json:"started_at"`
	CompletedAt        *time.Time                 `json:"completed_at"`
	HasMismatch        bool                       `json:"has_mismatch"`
	ProgressPercentage uint                       `json:"progress_percentage"`
	EtaSeconds         uint64                     `json:"eta_seconds"`
	TableReports       []WorkflowVDiffTableReport `json:"table_reports"`
}

type WorkflowVDiffTableReport struct {
	PublicID                   string        `json:"id"`
	TableName                  string        `json:"table_name"`
	Shard                      string        `json:"shard"`
	MismatchedRowsCount        int64         `json:"mismatched_rows_count"`
	ExtraSourceRowsCount       int64         `json:"extra_source_rows_count"`
	ExtraTargetRowsCount       int64         `json:"extra_target_rows_count"`
	ExtraSourceRows            []interface{} `json:"extra_source_rows"`
	ExtraTargetRows            []interface{} `json:"extra_target_rows"`
	MismatchedRows             []interface{} `json:"mismatched_rows"`
	SampleExtraSourceRowsQuery string        `json:"sample_extra_source_rows_query"`
	SampleExtraTargetRowsQuery string        `json:"sample_extra_target_rows_query"`
	SampleMismatchedRowsQuery  string        `json:"sample_mismatched_rows_query"`
	CreatedAt                  time.Time     `json:"created_at"`
	UpdatedAt                  time.Time     `json:"updated_at"`
}

type WorkflowsService interface {
	List(context.Context, *ListWorkflowsRequest) ([]*Workflow, error)
	Get(context.Context, *GetWorkflowRequest) (*Workflow, error)
	Create(context.Context, *CreateWorkflowRequest) (*Workflow, error)
	VerifyData(context.Context, *VerifyDataWorkflowRequest) (*Workflow, error)
	SwitchReplicas(context.Context, *SwitchReplicasWorkflowRequest) (*Workflow, error)
	SwitchPrimaries(context.Context, *SwitchPrimariesWorkflowRequest) (*Workflow, error)
	ReverseTraffic(context.Context, *ReverseTrafficWorkflowRequest) (*Workflow, error)
	Cutover(context.Context, *CutoverWorkflowRequest) (*Workflow, error)
	ReverseCutover(context.Context, *ReverseCutoverWorkflowRequest) (*Workflow, error)
	Complete(context.Context, *CompleteWorkflowRequest) (*Workflow, error)
	Retry(context.Context, *RetryWorkflowRequest) (*Workflow, error)
	Cancel(context.Context, *CancelWorkflowRequest) (*Workflow, error)
}