postgres

package
v0.0.1-dev.6 Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2026 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiError

type ApiError struct {
	ErrorCode  ErrorCode
	Message    *string
	StackTrace *string
	Details    []json.RawMessage
}

Databricks Error that is returned by all Databricks APIs..

func (*ApiError) Error

func (e *ApiError) Error() string

Error returns the LRO error code and message.

type Branch

type Branch struct {
	// Output only. The full resource path of the branch. Format:
	// projects/{project_id}/branches/{branch_id}
	Name *string `fieldmask:"name"`
	// System-generated unique ID for the branch.
	Uid *string `fieldmask:"uid"`
	// The project containing this branch (API resource hierarchy). Format:
	// projects/{project_id}
	//
	// Note: This field indicates where the branch exists in the resource hierarchy.
	// For point-in-time branching from another branch, see `status.source_branch`.
	Parent *string `fieldmask:"parent"`
	// A timestamp indicating when the branch was created.
	CreateTime *types.Time `fieldmask:"create_time"`
	// A timestamp indicating when the branch was last updated.
	UpdateTime *types.Time `fieldmask:"update_time"`
	// The spec contains the branch configuration.
	Spec *BranchSpec `fieldmask:"spec"`
	// The current status of a Branch.
	Status *BranchStatus `fieldmask:"status"`
	// The part of the name, chosen by the user when the resource was created.
	BranchId *string `fieldmask:"branch_id"`
}

type BranchOperationMetadata

type BranchOperationMetadata struct {
}

type BranchSpec

type BranchSpec struct {
	// The name of the source branch from which this branch was created (data
	// lineage for point-in-time recovery). If not specified, defaults to the
	// project's default branch. Format: projects/{project_id}/branches/{branch_id}
	SourceBranch *string `fieldmask:"source_branch"`
	// The Log Sequence Number (LSN) on the source branch from which this branch was
	// created.
	SourceBranchLsn *string `fieldmask:"source_branch_lsn"`
	// The point in time on the source branch from which this branch was created.
	SourceBranchTime *types.Time `fieldmask:"source_branch_time"`
	// When set to true, protects the branch from deletion and reset. Associated
	// compute endpoints and the project cannot be deleted while the branch is
	// protected.
	IsProtected *bool `fieldmask:"is_protected"`
	// Expiration configuration for the branch. One of expire_time, ttl, or
	// no_expiry must be provided. To disable expiration, set no_expiry to true.
	//
	// When updating this field, use "spec.expiration" in the update_mask.
	Expiration isBranchSpec_Expiration
	// The snapshot this branch was created from. When set, the branch's data comes
	// from the snapshot rather than a source branch, so source_branch,
	// source_branch_lsn, and source_branch_time must be empty. The snapshot must be
	// AVAILABLE and belong to this branch's project. Format:
	// projects/{project_id}/snapshots/{snapshot_id}
	SourceSnapshot *string `fieldmask:"source_snapshot"`
	// contains filtered or unexported fields
}

type BranchSpec_Expiration_ExpireTime

type BranchSpec_Expiration_ExpireTime struct {
	ExpireTime types.Time `fieldmask:"expire_time"`
}

BranchSpec_Expiration_ExpireTime selects ExpireTime for BranchSpec.Expiration. Absolute expiration timestamp. When set, the branch will expire at this time. Mutually exclusive with `ttl` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.

type BranchSpec_Expiration_NoExpiry

type BranchSpec_Expiration_NoExpiry struct {
	NoExpiry bool `fieldmask:"no_expiry"`
}

BranchSpec_Expiration_NoExpiry selects NoExpiry for BranchSpec.Expiration. Explicitly disable expiration. When set to true, the branch will not expire. If set to false, the request is invalid; provide either ttl or expire_time instead. Mutually exclusive with `expire_time` and `ttl`. When updating, use `spec.expiration` in the update_mask.

type BranchSpec_Expiration_Ttl

type BranchSpec_Expiration_Ttl struct {
	Ttl types.Duration `fieldmask:"ttl"`
}

BranchSpec_Expiration_Ttl selects Ttl for BranchSpec.Expiration. Relative time-to-live duration. When set, the branch will expire at creation_time + ttl. Mutually exclusive with `expire_time` and `no_expiry`. When updating, use `spec.expiration` in the update_mask.

type BranchStatus

type BranchStatus struct {
	// The name of the source branch from which this branch was created. Format:
	// projects/{project_id}/branches/{branch_id}
	SourceBranch *string `fieldmask:"source_branch"`
	// The Log Sequence Number (LSN) on the source branch from which this branch was
	// created.
	SourceBranchLsn *string `fieldmask:"source_branch_lsn"`
	// The point in time on the source branch from which this branch was created.
	SourceBranchTime *types.Time `fieldmask:"source_branch_time"`
	// Whether the branch is the project's default branch.
	Default *bool `fieldmask:"default"`
	// Whether the branch is protected.
	IsProtected *bool `fieldmask:"is_protected"`
	// The branch's state, indicating if it is initializing, ready for use, or
	// archived.
	CurrentState BranchStatus_State `fieldmask:"current_state"`
	// The pending state of the branch, if a state transition is in progress.
	PendingState BranchStatus_State `fieldmask:"pending_state"`
	// A timestamp indicating when the `current_state` began.
	StateChangeTime *types.Time `fieldmask:"state_change_time"`
	// The logical size of the branch.
	LogicalSizeBytes *int64 `fieldmask:"logical_size_bytes"`
	// Absolute expiration time for the branch. Empty if expiration is disabled.
	ExpireTime *types.Time `fieldmask:"expire_time"`
	// Part of the resource name.
	BranchId *string `fieldmask:"branch_id"`
	// A timestamp indicating when the branch was deleted. Empty if the branch is
	// not deleted.
	DeleteTime *types.Time `fieldmask:"delete_time"`
	// A timestamp indicating when the branch is scheduled to be purged. Empty if
	// the branch is not deleted, otherwise set to a timestamp in the future.
	PurgeTime *types.Time `fieldmask:"purge_time"`
	// The snapshot this branch was restored from. Set only for branches created by
	// restoring a snapshot; unset for all other branches. Format:
	// projects/{project_id}/snapshots/{snapshot_id}
	SourceSnapshot *string `fieldmask:"source_snapshot"`
}

type BranchStatus_State

type BranchStatus_State string

The state of the branch.

const (
	BranchStatus_State_Unspecified BranchStatus_State = ""
	// The branch is being created but is not yet available for querying.
	BranchStatus_State_Init BranchStatus_State = "INIT"
	// The branch is being imported and is not yet available for querying.
	BranchStatus_State_Importing BranchStatus_State = "IMPORTING"
	// The branch is being reset to a specific point in time or LSN and is not yet
	// available for querying.
	BranchStatus_State_Resetting BranchStatus_State = "RESETTING"
	// The branch is fully operational and ready for querying.
	BranchStatus_State_Ready BranchStatus_State = "READY"
	// The branch is stored in cost-effective archival storage. Expect slow query
	// response times.
	BranchStatus_State_Archived BranchStatus_State = "ARCHIVED"
	// The branch is deleted and is not available for querying, but can be
	// undeleted.
	BranchStatus_State_Deleted BranchStatus_State = "DELETED"
)

type Catalog

type Catalog struct {
	// Output only. The full resource path of the catalog.
	//
	// Format: "catalogs/{catalog_id}".
	Name *string
	// System-generated unique identifier for the catalog.
	Uid *string
	// The desired state of the Catalog.
	Spec *Catalog_CatalogSpec
	// The observed state of the Catalog.
	Status *Catalog_CatalogStatus
	// A timestamp indicating when the catalog was created.
	CreateTime *types.Time
	// A timestamp indicating when the catalog was last updated.
	UpdateTime *types.Time
	// The part of the name, chosen by the user when the resource was created.
	CatalogId *string
}

type CatalogOperationMetadata

type CatalogOperationMetadata struct {
}

type Catalog_CatalogSpec

type Catalog_CatalogSpec struct {
	// The name of the Postgres database inside the specified Lakebase project and
	// branch to be associated with the UC catalog. This database must already
	// exist, unless create_database_if_missing is set to true on creation.
	//
	// A database can only be registered with one UC catalog at a time. To
	// re-register a database with a different catalog, the existing catalog must be
	// deleted first.
	//
	// A child branch inherits the fact of parent's registration. This means the
	// same-named database in a child branch cannot be registered with a second
	// catalog while the parent's registration exists. To allow registering the
	// database of a child branch, drop and recreate the database on the child
	// branch. This removes the fact of parent's registration from this branch only.
	//
	// Doing Point In Time Restore (PITR) prior to the moment before the Postgres DB
	// was registered in the Catalog drops the fact of registration of the database.
	// So the user should avoid doing so.
	PostgresDatabase *string
	// If set to true, the specified postgres_database is created on behalf of the
	// calling user if it does not already exist. In this case, the calling user has
	// a role created for them in Postgres if they do not already have one.
	//
	// Defaults to false, meaning that the request fails if the specified
	// postgres_database does not already exist.
	CreateDatabaseIfMissing *bool
	// The resource path of the branch associated with the catalog.
	//
	// Format: projects/{project_id}/branches/{branch_id}.
	Branch *string
}

The desired state of the Catalog..

type Catalog_CatalogStatus

type Catalog_CatalogStatus struct {
	// The name of the Postgres database associated with the catalog.
	PostgresDatabase *string
	// The resource path of the project associated with the catalog.
	//
	// Format: projects/{project_id}.
	Project *string
	// The resource path of the branch associated with the catalog.
	//
	// Format: projects/{project_id}/branches/{branch_id}.
	Branch *string
}

The observed state of the Catalog..

type CdfConfig

type CdfConfig struct {
	// Output only. The full resource name of the CdfConfig. Format:
	// projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
	Name *string
	// The Unity Catalog catalog that replicated tables are written into. Set at
	// creation; the CdfConfig is immutable.
	Catalog *string
	// The Unity Catalog schema that replicated tables are written into. Set at
	// creation; the CdfConfig is immutable.
	Schema *string
	// When the CdfConfig was created.
	CreateTime *types.Time
	// The user-specified id; equals the final segment of `name`. Defaults to the
	// Postgres schema name for configs without an explicit id.
	CdfConfigId *string
	// The Postgres schema this CdfConfig replicates from. Unique within the parent
	// database. Set at creation; the CdfConfig is immutable.
	PostgresSchema *string
}

A Lakebase CDF configuration (CdfConfig): one per Postgres schema per database, replicating that schema's tables into a Unity Catalog schema. Immutable once created..

type CdfConfigOperationMetadata

type CdfConfigOperationMetadata struct {
}

Metadata for CdfConfig long-running operations. Intentionally empty today; fields (e.g. progress) may be added as the operation contract grows..

type CdfState

type CdfState string

The replication state of a single replicated table (CdfStatus).

const (
	CdfState_Unspecified CdfState = ""
	// Taking the initial snapshot: the table's existing rows are being written to
	// the Delta table.
	CdfState_CdfStateSnapshotting CdfState = "CDF_STATE_SNAPSHOTTING"
	// Continuously streaming WAL changes to the Delta table.
	CdfState_CdfStateStreaming CdfState = "CDF_STATE_STREAMING"
	// Reserved: replication for this table was superseded by a newer one. Not
	// currently returned by the API.
	CdfState_CdfStateTerminated CdfState = "CDF_STATE_TERMINATED"
	// The table is not being replicated: it was skipped because it is not eligible
	// for replication, or replication errored. See status_detail for the specific
	// reason.
	CdfState_CdfStateSkipped CdfState = "CDF_STATE_SKIPPED"
)

type CdfStatus

type CdfStatus struct {
	// Output only. The full resource name of the CdfStatus. Format:
	// projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}
	// The {cdf_status} segment is the Postgres table name.
	Name *string
	// The Postgres table being replicated.
	PostgresTable *string
	// The Unity Catalog table receiving replicated data.
	UcTable *string
	// The current replication state of this table.
	State CdfState
	// The high-watermark Log Sequence Number (LSN) committed to Delta Lake.
	CommittedLsn *string
	// The last time changes for this table were written to Delta Lake.
	LastSyncTime *types.Time
	// When replication for this table was first established.
	CreateTime *types.Time
	// Human-readable detail for the current state (e.g. the skip/error reason).
	// Empty for healthy states.
	StatusDetail *string
}

The read-only replication status of a single Postgres table replicated under a CdfConfig. One status exists per replicated table. It is created automatically and cannot be modified..

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(ctx context.Context, opts ...client.Option) (*Client, error)

func (*Client) CreateBranch

func (c *Client) CreateBranch(ctx context.Context, req CreateBranchRequest, opts ...call.Option) (*CreateBranchOperation, error)

Creates a new database branch in the project.

func (*Client) CreateCatalog

func (c *Client) CreateCatalog(ctx context.Context, req CreateCatalogRequest, opts ...call.Option) (*CreateCatalogOperation, error)

Register a Postgres database in the Unity Catalog.

func (*Client) CreateCdfConfig

func (c *Client) CreateCdfConfig(ctx context.Context, req CreateCdfConfigRequest, opts ...call.Option) (*CreateCdfConfigOperation, error)

Create a CDF configuration that materializes the change data feed for all tables in a Postgres schema as open-format Delta tables in Unity Catalog. Once created, each table's change history is continuously written to its corresponding Lakehouse table.

func (*Client) CreateDataApi

func (c *Client) CreateDataApi(ctx context.Context, req CreateDataApiRequest, opts ...call.Option) (*CreateDataApiOperation, error)

Enable Data API for a database.

func (*Client) CreateDatabase

func (c *Client) CreateDatabase(ctx context.Context, req CreateDatabaseRequest, opts ...call.Option) (*CreateDatabaseOperation, error)

Create a Database.

Creates a database in the specified branch. A branch can have multiple databases.

func (*Client) CreateEndpoint

func (c *Client) CreateEndpoint(ctx context.Context, req CreateEndpointRequest, opts ...call.Option) (*CreateEndpointOperation, error)

Creates a new compute endpoint in the branch.

func (*Client) CreateProject

func (c *Client) CreateProject(ctx context.Context, req CreateProjectRequest, opts ...call.Option) (*CreateProjectOperation, error)

Creates a new Lakebase Autoscaling Postgres database project, which contains branches and compute endpoints.

func (*Client) CreateRole

func (c *Client) CreateRole(ctx context.Context, req CreateRoleRequest, opts ...call.Option) (*CreateRoleOperation, error)

Creates a new Postgres role in the branch.

func (*Client) CreateSnapshot

func (c *Client) CreateSnapshot(ctx context.Context, req CreateSnapshotRequest, opts ...call.Option) (*CreateSnapshotOperation, error)

Creates a snapshot, an immutable point-in-time copy of a branch's data, within the project.

func (*Client) CreateSyncedTable

func (c *Client) CreateSyncedTable(ctx context.Context, req CreateSyncedTableRequest, opts ...call.Option) (*CreateSyncedTableOperation, error)

Create a Synced Table.

func (*Client) DeleteBranch

func (c *Client) DeleteBranch(ctx context.Context, req DeleteBranchRequest, opts ...call.Option) (*DeleteBranchOperation, error)

Deletes the specified database branch.

func (*Client) DeleteCatalog

func (c *Client) DeleteCatalog(ctx context.Context, req DeleteCatalogRequest, opts ...call.Option) (*DeleteCatalogOperation, error)

Delete a Database Catalog.

func (*Client) DeleteCdfConfig

func (c *Client) DeleteCdfConfig(ctx context.Context, req DeleteCdfConfigRequest, opts ...call.Option) (*DeleteCdfConfigOperation, error)

Delete a CDF configuration and stop materializing the change data feed. When force=true, also drops the Delta tables in Unity Catalog. When force=false (default), the existing tables are preserved at their last state.

func (*Client) DeleteDataApi

func (c *Client) DeleteDataApi(ctx context.Context, req DeleteDataApiRequest, opts ...call.Option) (*DeleteDataApiOperation, error)

Disable Data API for a database.

func (*Client) DeleteDatabase

func (c *Client) DeleteDatabase(ctx context.Context, req DeleteDatabaseRequest, opts ...call.Option) (*DeleteDatabaseOperation, error)

Delete a Database.

func (*Client) DeleteEndpoint

func (c *Client) DeleteEndpoint(ctx context.Context, req DeleteEndpointRequest, opts ...call.Option) (*DeleteEndpointOperation, error)

Deletes the specified compute endpoint.

func (*Client) DeleteProject

func (c *Client) DeleteProject(ctx context.Context, req DeleteProjectRequest, opts ...call.Option) (*DeleteProjectOperation, error)

Deletes the specified database project.

func (*Client) DeleteRole

func (c *Client) DeleteRole(ctx context.Context, req DeleteRoleRequest, opts ...call.Option) (*DeleteRoleOperation, error)

Deletes the specified Postgres role.

func (*Client) DeleteSnapshot

func (c *Client) DeleteSnapshot(ctx context.Context, req DeleteSnapshotRequest, opts ...call.Option) (*DeleteSnapshotOperation, error)

Deletes the specified snapshot.

func (*Client) DeleteSyncedTable

func (c *Client) DeleteSyncedTable(ctx context.Context, req DeleteSyncedTableRequest, opts ...call.Option) (*DeleteSyncedTableOperation, error)

Delete a Synced Table.

func (*Client) GenerateDatabaseCredential

func (c *Client) GenerateDatabaseCredential(ctx context.Context, req GenerateDatabaseCredentialRequest, opts ...call.Option) (*DatabaseCredential, error)

Generate OAuth credentials for a Postgres database.

func (*Client) GetBranch

func (c *Client) GetBranch(ctx context.Context, req GetBranchRequest, opts ...call.Option) (*Branch, error)

Retrieves information about the specified database branch.

func (*Client) GetCatalog

func (c *Client) GetCatalog(ctx context.Context, req GetCatalogRequest, opts ...call.Option) (*Catalog, error)

Get a Database Catalog.

func (*Client) GetCdfConfig

func (c *Client) GetCdfConfig(ctx context.Context, req GetCdfConfigRequest, opts ...call.Option) (*CdfConfig, error)

Get a single Lakebase CDF configuration, including the source Postgres schema, target Unity Catalog schema, and the identity under which writes are authorized.

func (*Client) GetCdfStatus

func (c *Client) GetCdfStatus(ctx context.Context, req GetCdfStatusRequest, opts ...call.Option) (*CdfStatus, error)

Get the CDF status of a single table within a Lakebase CDF configuration, including its current state and the last committed position in the feed.

func (*Client) GetDataApi

func (c *Client) GetDataApi(ctx context.Context, req GetDataApiRequest, opts ...call.Option) (*DataApi, error)

Get Data API configuration for a database.

func (*Client) GetDatabase

func (c *Client) GetDatabase(ctx context.Context, req GetDatabaseRequest, opts ...call.Option) (*Database, error)

Get a Database.

func (*Client) GetEndpoint

func (c *Client) GetEndpoint(ctx context.Context, req GetEndpointRequest, opts ...call.Option) (*Endpoint, error)

Retrieves information about the specified compute endpoint, including its connection details and operational state.

func (*Client) GetProject

func (c *Client) GetProject(ctx context.Context, req GetProjectRequest, opts ...call.Option) (*Project, error)

Retrieves information about the specified database project.

func (*Client) GetRole

func (c *Client) GetRole(ctx context.Context, req GetRoleRequest, opts ...call.Option) (*Role, error)

Retrieves information about the specified Postgres role, including its authentication method and permissions.

func (*Client) GetSnapshot

func (c *Client) GetSnapshot(ctx context.Context, req GetSnapshotRequest, opts ...call.Option) (*Snapshot, error)

Retrieves information about the specified snapshot.

func (*Client) GetSnapshotSchedule

func (c *Client) GetSnapshotSchedule(ctx context.Context, req GetSnapshotScheduleRequest, opts ...call.Option) (*SnapshotSchedule, error)

Retrieves the snapshot schedule for a branch. A branch with no configured schedule returns an empty schedule (not NOT_FOUND).

func (*Client) GetSyncedTable

func (c *Client) GetSyncedTable(ctx context.Context, req GetSyncedTableRequest, opts ...call.Option) (*SyncedTable, error)

Get a Synced Table.

func (*Client) ListBranches

func (c *Client) ListBranches(ctx context.Context, req ListBranchesRequest, opts ...call.Option) (*ListBranchesResponse, error)

Returns a paginated list of database branches in the project.

func (*Client) ListBranchesIter

func (c *Client) ListBranchesIter(ctx context.Context, req ListBranchesRequest, opts ...call.Option) iter.Seq2[*Branch, error]

ListBranchesIter returns an iterator that iterates over the results of ListBranches.

For example:

for item, err := range c.ListBranchesIter(ctx, ListBranchesRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListBranches call made by the iterator under the hood.

Callers who need custom pagination logic should use ListBranches directly.

func (*Client) ListCdfConfigs

func (c *Client) ListCdfConfigs(ctx context.Context, req ListCdfConfigsRequest, opts ...call.Option) (*ListCdfConfigsResponse, error)

List all CDF configurations for a Lakebase database. Each configuration maps a Postgres schema to a Unity Catalog schema where the change data feed is materialized.

func (*Client) ListCdfConfigsIter

func (c *Client) ListCdfConfigsIter(ctx context.Context, req ListCdfConfigsRequest, opts ...call.Option) iter.Seq2[*CdfConfig, error]

ListCdfConfigsIter returns an iterator that iterates over the results of ListCdfConfigs.

For example:

for item, err := range c.ListCdfConfigsIter(ctx, ListCdfConfigsRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListCdfConfigs call made by the iterator under the hood.

Callers who need custom pagination logic should use ListCdfConfigs directly.

func (*Client) ListCdfStatuses

func (c *Client) ListCdfStatuses(ctx context.Context, req ListCdfStatusesRequest, opts ...call.Option) (*ListCdfStatusesResponse, error)

List the per-table CDF statuses within a Lakebase CDF configuration. Each status shows whether a table's change data feed is snapshotting, streaming, or skipped.

func (*Client) ListCdfStatusesIter

func (c *Client) ListCdfStatusesIter(ctx context.Context, req ListCdfStatusesRequest, opts ...call.Option) iter.Seq2[*CdfStatus, error]

ListCdfStatusesIter returns an iterator that iterates over the results of ListCdfStatuses.

For example:

for item, err := range c.ListCdfStatusesIter(ctx, ListCdfStatusesRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListCdfStatuses call made by the iterator under the hood.

Callers who need custom pagination logic should use ListCdfStatuses directly.

func (*Client) ListDatabases

func (c *Client) ListDatabases(ctx context.Context, req ListDatabasesRequest, opts ...call.Option) (*ListDatabasesResponse, error)

List Databases.

func (*Client) ListDatabasesIter

func (c *Client) ListDatabasesIter(ctx context.Context, req ListDatabasesRequest, opts ...call.Option) iter.Seq2[*Database, error]

ListDatabasesIter returns an iterator that iterates over the results of ListDatabases.

For example:

for item, err := range c.ListDatabasesIter(ctx, ListDatabasesRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListDatabases call made by the iterator under the hood.

Callers who need custom pagination logic should use ListDatabases directly.

func (*Client) ListEndpoints

func (c *Client) ListEndpoints(ctx context.Context, req ListEndpointsRequest, opts ...call.Option) (*ListEndpointsResponse, error)

Returns a paginated list of compute endpoints in the branch.

func (*Client) ListEndpointsIter

func (c *Client) ListEndpointsIter(ctx context.Context, req ListEndpointsRequest, opts ...call.Option) iter.Seq2[*Endpoint, error]

ListEndpointsIter returns an iterator that iterates over the results of ListEndpoints.

For example:

for item, err := range c.ListEndpointsIter(ctx, ListEndpointsRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListEndpoints call made by the iterator under the hood.

Callers who need custom pagination logic should use ListEndpoints directly.

func (*Client) ListProjects

func (c *Client) ListProjects(ctx context.Context, req ListProjectsRequest, opts ...call.Option) (*ListProjectsResponse, error)

Returns a paginated list of database projects in the workspace that the user has permission to access.

func (*Client) ListProjectsIter

func (c *Client) ListProjectsIter(ctx context.Context, req ListProjectsRequest, opts ...call.Option) iter.Seq2[*Project, error]

ListProjectsIter returns an iterator that iterates over the results of ListProjects.

For example:

for item, err := range c.ListProjectsIter(ctx, ListProjectsRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListProjects call made by the iterator under the hood.

Callers who need custom pagination logic should use ListProjects directly.

func (*Client) ListRoles

func (c *Client) ListRoles(ctx context.Context, req ListRolesRequest, opts ...call.Option) (*ListRolesResponse, error)

Returns a paginated list of Postgres roles in the branch.

func (*Client) ListRolesIter

func (c *Client) ListRolesIter(ctx context.Context, req ListRolesRequest, opts ...call.Option) iter.Seq2[*Role, error]

ListRolesIter returns an iterator that iterates over the results of ListRoles.

For example:

for item, err := range c.ListRolesIter(ctx, ListRolesRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListRoles call made by the iterator under the hood.

Callers who need custom pagination logic should use ListRoles directly.

func (*Client) ListSnapshots

func (c *Client) ListSnapshots(ctx context.Context, req ListSnapshotsRequest, opts ...call.Option) (*ListSnapshotsResponse, error)

Returns a paginated list of snapshots in the project.

func (*Client) ListSnapshotsIter

func (c *Client) ListSnapshotsIter(ctx context.Context, req ListSnapshotsRequest, opts ...call.Option) iter.Seq2[*Snapshot, error]

ListSnapshotsIter returns an iterator that iterates over the results of ListSnapshots.

For example:

for item, err := range c.ListSnapshotsIter(ctx, ListSnapshotsRequest{}) {
  if err != nil {
    return err
  }
  fmt.Println(item)
}

Options opts are passed to each ListSnapshots call made by the iterator under the hood.

Callers who need custom pagination logic should use ListSnapshots directly.

func (*Client) UndeleteBranch

func (c *Client) UndeleteBranch(ctx context.Context, req UndeleteBranchRequest, opts ...call.Option) (*UndeleteBranchOperation, error)

Undeletes the specified database branch.

func (*Client) UndeleteProject

func (c *Client) UndeleteProject(ctx context.Context, req UndeleteProjectRequest, opts ...call.Option) (*UndeleteProjectOperation, error)

Undeletes a soft-deleted project.

func (*Client) UpdateBranch

func (c *Client) UpdateBranch(ctx context.Context, req UpdateBranchRequest, opts ...call.Option) (*UpdateBranchOperation, error)

Updates the specified database branch. You can set this branch as the project's default branch, or protect/unprotect it.

func (*Client) UpdateDataApi

func (c *Client) UpdateDataApi(ctx context.Context, req UpdateDataApiRequest, opts ...call.Option) (*UpdateDataApiOperation, error)

Update Data API configuration for a database.

func (*Client) UpdateDatabase

func (c *Client) UpdateDatabase(ctx context.Context, req UpdateDatabaseRequest, opts ...call.Option) (*UpdateDatabaseOperation, error)

Update a Database.

func (*Client) UpdateEndpoint

func (c *Client) UpdateEndpoint(ctx context.Context, req UpdateEndpointRequest, opts ...call.Option) (*UpdateEndpointOperation, error)

Updates the specified compute endpoint. You can update autoscaling limits, suspend timeout, or enable/disable the compute endpoint.

func (*Client) UpdateProject

func (c *Client) UpdateProject(ctx context.Context, req UpdateProjectRequest, opts ...call.Option) (*UpdateProjectOperation, error)

Updates the specified database project.

func (*Client) UpdateRole

func (c *Client) UpdateRole(ctx context.Context, req UpdateRoleRequest, opts ...call.Option) (*UpdateRoleOperation, error)

Update a role for a branch.

func (*Client) UpdateSnapshotSchedule

func (c *Client) UpdateSnapshotSchedule(ctx context.Context, req UpdateSnapshotScheduleRequest, opts ...call.Option) (*UpdateSnapshotScheduleOperation, error)

Sets the snapshot schedule for a branch. The `schedule` field is replaced wholesale; an empty schedule disables automatic snapshots.

type CreateBranchOperation

type CreateBranchOperation struct {
	// contains filtered or unexported fields
}

CreateBranchOperation tracks the state of the long-running operation started by CreateBranch.

func (*CreateBranchOperation) Done

func (o *CreateBranchOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateBranchOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateBranchOperation) Name

func (o *CreateBranchOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateBranchOperation) Wait

func (o *CreateBranchOperation) Wait(ctx context.Context, opts ...lro.Option) (*Branch, error)

Wait polls the operation until it completes.

type CreateBranchRequest

type CreateBranchRequest struct {
	// The Project where this Branch will be created. Format: projects/{project_id}
	Parent *string
	// The ID to use for the Branch. This becomes the final component of the
	// branch's resource name. The ID is required and must be 1-63 characters long,
	// start with a lowercase letter, and contain only lowercase letters, numbers,
	// and hyphens. For example, `development` becomes
	// `projects/my-app/branches/development`.
	BranchId *string
	// The Branch to create.
	Branch *Branch
	// If true, update the branch if it already exists instead of returning an
	// error.
	ReplaceExisting *bool
}

type CreateCatalogOperation

type CreateCatalogOperation struct {
	// contains filtered or unexported fields
}

CreateCatalogOperation tracks the state of the long-running operation started by CreateCatalog.

func (*CreateCatalogOperation) Done

func (o *CreateCatalogOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateCatalogOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateCatalogOperation) Name

func (o *CreateCatalogOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateCatalogOperation) Wait

func (o *CreateCatalogOperation) Wait(ctx context.Context, opts ...lro.Option) (*Catalog, error)

Wait polls the operation until it completes.

type CreateCatalogRequest

type CreateCatalogRequest struct {
	// The ID in the Unity Catalog. It becomes the full resource name, for example
	// "my_catalog" becomes "catalogs/my_catalog".
	CatalogId *string
	Catalog   *Catalog
}

type CreateCdfConfigOperation

type CreateCdfConfigOperation struct {
	// contains filtered or unexported fields
}

CreateCdfConfigOperation tracks the state of the long-running operation started by CreateCdfConfig.

func (*CreateCdfConfigOperation) Done

func (o *CreateCdfConfigOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateCdfConfigOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateCdfConfigOperation) Name

func (o *CreateCdfConfigOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateCdfConfigOperation) Wait

func (o *CreateCdfConfigOperation) Wait(ctx context.Context, opts ...lro.Option) (*CdfConfig, error)

Wait polls the operation until it completes.

type CreateCdfConfigRequest

type CreateCdfConfigRequest struct {
	// The parent database under which to create the CdfConfig. Format:
	// projects/{project}/branches/{branch}/databases/{database}
	Parent *string
	// The CdfConfig to create. The catalog, schema, and postgres_schema fields are
	// required; all other fields are output only and ignored on input.
	CdfConfig *CdfConfig
	// The user-specified id for the CdfConfig, forming the final segment of its
	// resource name. Must match the pattern `[a-z][a-z0-9_]{0,62}`. Defaults to the
	// Postgres schema name when omitted.
	CdfConfigId *string
}

Request to create a Lakebase CDF configuration (CdfConfig)..

type CreateDataApiOperation

type CreateDataApiOperation struct {
	// contains filtered or unexported fields
}

CreateDataApiOperation tracks the state of the long-running operation started by CreateDataApi.

func (*CreateDataApiOperation) Done

func (o *CreateDataApiOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateDataApiOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateDataApiOperation) Name

func (o *CreateDataApiOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateDataApiOperation) Wait

func (o *CreateDataApiOperation) Wait(ctx context.Context, opts ...lro.Option) (*DataApi, error)

Wait polls the operation until it completes.

type CreateDataApiRequest

type CreateDataApiRequest struct {
	// Parent database:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}
	Parent *string
	// The Data API configuration to create.
	DataApi *DataApi
}

Enable Data API for a database..

type CreateDatabaseOperation

type CreateDatabaseOperation struct {
	// contains filtered or unexported fields
}

CreateDatabaseOperation tracks the state of the long-running operation started by CreateDatabase.

func (*CreateDatabaseOperation) Done

func (o *CreateDatabaseOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateDatabaseOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateDatabaseOperation) Name

func (o *CreateDatabaseOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateDatabaseOperation) Wait

func (o *CreateDatabaseOperation) Wait(ctx context.Context, opts ...lro.Option) (*Database, error)

Wait polls the operation until it completes.

type CreateDatabaseRequest

type CreateDatabaseRequest struct {
	// The Branch where this Database will be created. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string
	// The ID to use for the Database, which will become the final component of the
	// database's resource name. This ID becomes the database name in postgres.
	//
	// This value should be 4-63 characters, and only use characters available in
	// DNS names, as defined by RFC-1123
	//
	// If database_id is not specified in the request, it is generated
	// automatically.
	DatabaseId *string
	// The desired specification of a Database.
	Database *Database
	// If true, update the database if it already exists instead of returning an
	// error.
	ReplaceExisting *bool
}

type CreateEndpointOperation

type CreateEndpointOperation struct {
	// contains filtered or unexported fields
}

CreateEndpointOperation tracks the state of the long-running operation started by CreateEndpoint.

func (*CreateEndpointOperation) Done

func (o *CreateEndpointOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateEndpointOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateEndpointOperation) Name

func (o *CreateEndpointOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateEndpointOperation) Wait

func (o *CreateEndpointOperation) Wait(ctx context.Context, opts ...lro.Option) (*Endpoint, error)

Wait polls the operation until it completes.

type CreateEndpointRequest

type CreateEndpointRequest struct {
	// The Branch where this Endpoint will be created. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string
	// The ID to use for the Endpoint. This becomes the final component of the
	// endpoint's resource name. The ID is required and must be 1-63 characters
	// long, start with a lowercase letter, and contain only lowercase letters,
	// numbers, and hyphens. For example, `primary` becomes
	// `projects/my-app/branches/development/endpoints/primary`.
	EndpointId *string
	// The Endpoint to create.
	Endpoint *Endpoint
	// If true, update the endpoint if it already exists instead of returning an
	// error.
	ReplaceExisting *bool
}

type CreateProjectOperation

type CreateProjectOperation struct {
	// contains filtered or unexported fields
}

CreateProjectOperation tracks the state of the long-running operation started by CreateProject.

func (*CreateProjectOperation) Done

func (o *CreateProjectOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateProjectOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateProjectOperation) Name

func (o *CreateProjectOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateProjectOperation) Wait

func (o *CreateProjectOperation) Wait(ctx context.Context, opts ...lro.Option) (*Project, error)

Wait polls the operation until it completes.

type CreateProjectRequest

type CreateProjectRequest struct {
	// The ID to use for the Project. This becomes the final component of the
	// project's resource name. The ID is required and must be 1-63 characters long,
	// start with a lowercase letter, and contain only lowercase letters, numbers,
	// and hyphens. For example, `my-app` becomes `projects/my-app`.
	ProjectId *string
	// The Project to create.
	Project *Project
}

type CreateRoleOperation

type CreateRoleOperation struct {
	// contains filtered or unexported fields
}

CreateRoleOperation tracks the state of the long-running operation started by CreateRole.

func (*CreateRoleOperation) Done

func (o *CreateRoleOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateRoleOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateRoleOperation) Name

func (o *CreateRoleOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateRoleOperation) Wait

func (o *CreateRoleOperation) Wait(ctx context.Context, opts ...lro.Option) (*Role, error)

Wait polls the operation until it completes.

type CreateRoleRequest

type CreateRoleRequest struct {
	// The Branch where this Role is created. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string
	// The ID to use for the Role, which will become the final component of the
	// role's resource name. This ID becomes the role in Postgres.
	//
	// This value should be 4-63 characters, and valid characters are lowercase
	// letters, numbers, and hyphens, as defined by RFC 1123.
	//
	// If role_id is not specified in the request, it is generated automatically.
	RoleId *string
	// The desired specification of a Role.
	Role *Role
	// If true, update the role if it already exists instead of returning an error.
	//
	// When the role already exists, the provided `role` spec fully replaces the
	// existing one: `membership_roles` is overwritten, not merged. Leaving
	// `membership_roles` empty clears all of the role's existing memberships,
	// including `DATABRICKS_SUPERUSER`. Always send the complete desired list of
	// memberships when using this field.
	ReplaceExisting *bool
}

type CreateSnapshotOperation

type CreateSnapshotOperation struct {
	// contains filtered or unexported fields
}

CreateSnapshotOperation tracks the state of the long-running operation started by CreateSnapshot.

func (*CreateSnapshotOperation) Done

func (o *CreateSnapshotOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateSnapshotOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateSnapshotOperation) Name

func (o *CreateSnapshotOperation) Name() *string

Name returns the server-assigned operation name.

func (*CreateSnapshotOperation) Wait

func (o *CreateSnapshotOperation) Wait(ctx context.Context, opts ...lro.Option) (*Snapshot, error)

Wait polls the operation until it completes.

type CreateSnapshotRequest

type CreateSnapshotRequest struct {
	// The project in which to create the snapshot. Format: projects/{project_id}
	Parent *string
	// The snapshot to create.
	Snapshot *Snapshot
	// Client-chosen ID for the snapshot. It becomes the final segment of the
	// snapshot resource name and cannot be changed after creation.
	SnapshotId *string
}

type CreateSyncedTableOperation

type CreateSyncedTableOperation struct {
	// contains filtered or unexported fields
}

CreateSyncedTableOperation tracks the state of the long-running operation started by CreateSyncedTable.

func (*CreateSyncedTableOperation) Done

func (o *CreateSyncedTableOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*CreateSyncedTableOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateSyncedTableOperation) Name

Name returns the server-assigned operation name.

func (*CreateSyncedTableOperation) Wait

Wait polls the operation until it completes.

type CreateSyncedTableRequest

type CreateSyncedTableRequest struct {
	// The ID to use for the Synced Table. This becomes the final component of the
	// SyncedTable's resource name. ID is required and is the synced table name,
	// containing (catalog, schema, table) tuple. Elements of the tuple are the UC
	// entity names.
	//
	// Example: "{catalog}.{schema}.{table}"
	//
	// synced_table_id represents both of the following:
	//
	// 1. An online VIEW virtual table in the Unity Catalog accessible via the
	// Lakehouse Federation. 2. Postgres table named "{table}" in schema "{schema}"
	// in the connected Postgres database
	SyncedTableId *string
	SyncedTable   *SyncedTable
}

Establish a synchronisation to the Postgres database for Reverse ETL for the source table selected from the Unity Catalog..

type DailySchedule

type DailySchedule struct {
	// The hour of the day, in UTC, at which to take the snapshot, in [0, 23].
	Hour *int
}

Take a snapshot once per day, at the configured hour..

type DataApi

type DataApi struct {
	// Resource name:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
	Name *string `fieldmask:"name"`
	// The database containing this Data API configuration. Format:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}
	Parent *string `fieldmask:"parent"`
	// A timestamp indicating when the Data API was first enabled.
	CreateTime *types.Time `fieldmask:"create_time"`
	// A timestamp indicating when the Data API configuration was last updated.
	UpdateTime *types.Time `fieldmask:"update_time"`
	// The desired Data API configuration.
	Spec *DataApi_DataApiSpec `fieldmask:"spec"`
	// The observed Data API state (read-only).
	Status *DataApi_DataApiStatus `fieldmask:"status"`
}

DataApi represents the Data API (PostgREST) configuration for a Database. At most one DataApi per database. Create enables Data API, Delete disables it..

type DataApiOperationMetadata

type DataApiOperationMetadata struct {
}

type DataApi_DataApiSpec

type DataApi_DataApiSpec struct {
	// Enable aggregate functions (count, sum, avg, etc.) in Data API responses.
	// Default: true.
	DbAggregatesEnabled *bool `fieldmask:"db_aggregates_enabled"`
	// Additional schemas to include in the PostgreSQL search path. Each entry must
	// be a valid PostgreSQL schema name.
	DbExtraSearchPath []string `fieldmask:"db_extra_search_path"`
	// Maximum number of rows returned in a single Data API response. Must be a
	// positive integer.
	DbMaxRows *int `fieldmask:"db_max_rows"`
	// Database schemas exposed through the Data API. Each entry must be a valid
	// PostgreSQL schema name (1-63 chars, [a-zA-Z_][a-zA-Z0-9_$]*). Maximum 100
	// entries. Default: ["public"].
	DbSchemas []string `fieldmask:"db_schemas"`
	// JSON path to the role claim in JWT tokens (e.g., ".sub"). Default: ".sub".
	JwtRoleClaimKey *string `fieldmask:"jwt_role_claim_key"`
	// Maximum lifetime for cached JWT tokens. Zero duration disables caching.
	JwtCacheMaxLifetime *types.Duration `fieldmask:"jwt_cache_max_lifetime"`
	// OpenAPI documentation mode for the Data API endpoint.
	OpenapiMode OpenApiMode `fieldmask:"openapi_mode"`
	// Allowed origins for CORS requests. Each entry should be a valid origin URL,
	// or use "*" to allow all origins.
	ServerCorsAllowedOrigins []string `fieldmask:"server_cors_allowed_origins"`
	// Enable the Server-Timing header in Data API responses.
	ServerTimingEnabled *bool `fieldmask:"server_timing_enabled"`
}

Desired PostgREST configuration (input)..

type DataApi_DataApiStatus

type DataApi_DataApiStatus struct {
	// Actual aggregate function setting read from the database.
	DbAggregatesEnabled *bool `fieldmask:"db_aggregates_enabled"`
	// Actual extra search path schemas read from the database.
	DbExtraSearchPath []string `fieldmask:"db_extra_search_path"`
	// Actual max rows setting read from the database.
	DbMaxRows *int `fieldmask:"db_max_rows"`
	// Actual exposed schemas read from the database.
	DbSchemas []string `fieldmask:"db_schemas"`
	// Actual JWT role claim key read from the database.
	JwtRoleClaimKey *string `fieldmask:"jwt_role_claim_key"`
	// Actual JWT cache max lifetime read from the database.
	JwtCacheMaxLifetime *types.Duration `fieldmask:"jwt_cache_max_lifetime"`
	// Actual OpenAPI mode read from the database.
	OpenapiMode OpenApiMode `fieldmask:"openapi_mode"`
	// Actual CORS allowed origins read from the database.
	ServerCorsAllowedOrigins []string `fieldmask:"server_cors_allowed_origins"`
	// Actual Server-Timing header setting read from the database.
	ServerTimingEnabled *bool `fieldmask:"server_timing_enabled"`
	// Data API endpoint URL.
	Url *string `fieldmask:"url"`
	// Schemas available in the database (for reference when configuring
	// db_schemas).
	AvailableSchemas []string `fieldmask:"available_schemas"`
}

Observed state (output-only)..

type Database

type Database struct {
	// The resource name of the database. Format:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}
	Name *string `fieldmask:"name"`
	// The branch containing this database. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string `fieldmask:"parent"`
	// A timestamp indicating when the database was created.
	CreateTime *types.Time `fieldmask:"create_time"`
	// A timestamp indicating when the database was last updated.
	UpdateTime *types.Time `fieldmask:"update_time"`
	// The desired state of the Database.
	Spec *Database_DatabaseSpec `fieldmask:"spec"`
	// The observed state of the Database.
	Status *Database_DatabaseStatus `fieldmask:"status"`
	// The part of the name, chosen by the user when the resource was created.
	DatabaseId *string `fieldmask:"database_id"`
}

Database represents a Postgres database within a Branch..

type DatabaseCredential

type DatabaseCredential struct {
	// The OAuth token that can be used as a password when connecting to a database.
	Token *string
	// Timestamp in UTC of when this credential expires.
	ExpireTime *types.Time
}

type DatabaseOperationMetadata

type DatabaseOperationMetadata struct {
}

type Database_DatabaseSpec

type Database_DatabaseSpec struct {
	// The name of the role that owns the database. Format:
	// projects/{project_id}/branches/{branch_id}/roles/{role_id}
	//
	// To change the owner, pass valid existing Role name when updating the Database
	//
	// A database always has an owner.
	Role *string `fieldmask:"role"`
	// The name of the Postgres database.
	//
	// This expects a valid Postgres identifier as specified in the link below.
	// https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
	// Required when creating the Database.
	//
	// To rename, pass a valid postgres identifier when updating the Database.
	PostgresDatabase *string `fieldmask:"postgres_database"`
}

type Database_DatabaseStatus

type Database_DatabaseStatus struct {
	// The name of the role that owns the database. Format:
	// projects/{project_id}/branches/{branch_id}/roles/{role_id}
	Role *string `fieldmask:"role"`
	// The name of the Postgres database.
	PostgresDatabase *string `fieldmask:"postgres_database"`
	// Part of the resource name.
	DatabaseId *string `fieldmask:"database_id"`
}

type DayOfWeek

type DayOfWeek string

The day of the week on which a weekly snapshot is taken.

const (
	DayOfWeek_Unspecified DayOfWeek = ""
	// Monday.
	DayOfWeek_Monday DayOfWeek = "MONDAY"
	// Tuesday.
	DayOfWeek_Tuesday DayOfWeek = "TUESDAY"
	// Wednesday.
	DayOfWeek_Wednesday DayOfWeek = "WEDNESDAY"
	// Thursday.
	DayOfWeek_Thursday DayOfWeek = "THURSDAY"
	// Friday.
	DayOfWeek_Friday DayOfWeek = "FRIDAY"
	// Saturday.
	DayOfWeek_Saturday DayOfWeek = "SATURDAY"
	// Sunday.
	DayOfWeek_Sunday DayOfWeek = "SUNDAY"
)

type DeleteBranchOperation

type DeleteBranchOperation struct {
	// contains filtered or unexported fields
}

DeleteBranchOperation tracks the state of the long-running operation started by DeleteBranch.

func (*DeleteBranchOperation) Done

func (o *DeleteBranchOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteBranchOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteBranchOperation) Name

func (o *DeleteBranchOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteBranchOperation) Wait

func (o *DeleteBranchOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteBranchRequest

type DeleteBranchRequest struct {
	// The full resource path of the branch to delete. Format:
	// projects/{project_id}/branches/{branch_id}
	Name *string
	// If true, permanently delete the branch; if false, soft delete.
	Purge *bool
}

type DeleteCatalogOperation

type DeleteCatalogOperation struct {
	// contains filtered or unexported fields
}

DeleteCatalogOperation tracks the state of the long-running operation started by DeleteCatalog.

func (*DeleteCatalogOperation) Done

func (o *DeleteCatalogOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteCatalogOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteCatalogOperation) Name

func (o *DeleteCatalogOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteCatalogOperation) Wait

func (o *DeleteCatalogOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteCatalogRequest

type DeleteCatalogRequest struct {
	// The full resource path of the catalog to delete.
	//
	// Format: "catalogs/{catalog_id}".
	Name *string
}

type DeleteCdfConfigOperation

type DeleteCdfConfigOperation struct {
	// contains filtered or unexported fields
}

DeleteCdfConfigOperation tracks the state of the long-running operation started by DeleteCdfConfig.

func (*DeleteCdfConfigOperation) Done

func (o *DeleteCdfConfigOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteCdfConfigOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteCdfConfigOperation) Name

func (o *DeleteCdfConfigOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteCdfConfigOperation) Wait

func (o *DeleteCdfConfigOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteCdfConfigRequest

type DeleteCdfConfigRequest struct {
	// The resource name of the CdfConfig to delete. Format:
	// projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
	Name *string
	// When true, also drops the replicated Delta tables in Unity Catalog. When
	// false (the default), the replicated tables are preserved at their last synced
	// state.
	Force *bool
}

Request to delete a Lakebase CDF configuration (CdfConfig)..

type DeleteDataApiOperation

type DeleteDataApiOperation struct {
	// contains filtered or unexported fields
}

DeleteDataApiOperation tracks the state of the long-running operation started by DeleteDataApi.

func (*DeleteDataApiOperation) Done

func (o *DeleteDataApiOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteDataApiOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteDataApiOperation) Name

func (o *DeleteDataApiOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteDataApiOperation) Wait

func (o *DeleteDataApiOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteDataApiRequest

type DeleteDataApiRequest struct {
	// Resource name:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
	Name *string
}

Disable Data API for a database..

type DeleteDatabaseOperation

type DeleteDatabaseOperation struct {
	// contains filtered or unexported fields
}

DeleteDatabaseOperation tracks the state of the long-running operation started by DeleteDatabase.

func (*DeleteDatabaseOperation) Done

func (o *DeleteDatabaseOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteDatabaseOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteDatabaseOperation) Name

func (o *DeleteDatabaseOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteDatabaseOperation) Wait

func (o *DeleteDatabaseOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteDatabaseRequest

type DeleteDatabaseRequest struct {
	// The resource name of the postgres database. Format:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}
	Name *string
}

type DeleteEndpointOperation

type DeleteEndpointOperation struct {
	// contains filtered or unexported fields
}

DeleteEndpointOperation tracks the state of the long-running operation started by DeleteEndpoint.

func (*DeleteEndpointOperation) Done

func (o *DeleteEndpointOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteEndpointOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteEndpointOperation) Name

func (o *DeleteEndpointOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteEndpointOperation) Wait

func (o *DeleteEndpointOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteEndpointRequest

type DeleteEndpointRequest struct {
	// The full resource path of the endpoint to delete. Format:
	// projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
	Name *string
}

type DeleteProjectOperation

type DeleteProjectOperation struct {
	// contains filtered or unexported fields
}

DeleteProjectOperation tracks the state of the long-running operation started by DeleteProject.

func (*DeleteProjectOperation) Done

func (o *DeleteProjectOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteProjectOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteProjectOperation) Name

func (o *DeleteProjectOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteProjectOperation) Wait

func (o *DeleteProjectOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteProjectRequest

type DeleteProjectRequest struct {
	// The full resource path of the project to delete. Format:
	// projects/{project_id}
	Name *string
	// If true, permanently deletes the project (hard delete). If false or unset,
	// performs a soft delete.
	Purge *bool
}

type DeleteRoleOperation

type DeleteRoleOperation struct {
	// contains filtered or unexported fields
}

DeleteRoleOperation tracks the state of the long-running operation started by DeleteRole.

func (*DeleteRoleOperation) Done

func (o *DeleteRoleOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteRoleOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteRoleOperation) Name

func (o *DeleteRoleOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteRoleOperation) Wait

func (o *DeleteRoleOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteRoleRequest

type DeleteRoleRequest struct {
	// The full resource path of the role to delete. Format:
	// projects/{project_id}/branches/{branch_id}/roles/{role_id}
	Name *string
	// Reassign objects. If this is set, all objects owned by the role are
	// reassigned to the role specified in this parameter.
	//
	// NOTE: setting this requires spinning up a compute to succeed, since it
	// involves running SQL queries.
	ReassignOwnedTo *string
}

type DeleteSnapshotOperation

type DeleteSnapshotOperation struct {
	// contains filtered or unexported fields
}

DeleteSnapshotOperation tracks the state of the long-running operation started by DeleteSnapshot.

func (*DeleteSnapshotOperation) Done

func (o *DeleteSnapshotOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteSnapshotOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteSnapshotOperation) Name

func (o *DeleteSnapshotOperation) Name() *string

Name returns the server-assigned operation name.

func (*DeleteSnapshotOperation) Wait

func (o *DeleteSnapshotOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteSnapshotRequest

type DeleteSnapshotRequest struct {
	// The resource name of the snapshot to delete. Format:
	// projects/{project_id}/snapshots/{snapshot_id}
	Name *string
}

type DeleteSyncedTableOperation

type DeleteSyncedTableOperation struct {
	// contains filtered or unexported fields
}

DeleteSyncedTableOperation tracks the state of the long-running operation started by DeleteSyncedTable.

func (*DeleteSyncedTableOperation) Done

func (o *DeleteSyncedTableOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*DeleteSyncedTableOperation) Metadata

Metadata returns metadata associated with the operation.

func (*DeleteSyncedTableOperation) Name

Name returns the server-assigned operation name.

func (*DeleteSyncedTableOperation) Wait

func (o *DeleteSyncedTableOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type DeleteSyncedTableRequest

type DeleteSyncedTableRequest struct {
	// The Full resource name of the synced table, of the format
	// "synced_tables/{catalog}.{schema}.{table}", where (catalog, schema, table)
	// are the UC entity names.
	Name *string
}

type DeltaTableSyncInfo

type DeltaTableSyncInfo struct {
	// The Delta Lake commit version that was last successfully synced.
	DeltaCommitVersion *int64
	// The timestamp when the above Delta version was committed in the source Delta
	// table. Note: This is the Delta commit time, not the time the data was written
	// to the synced table.
	DeltaCommitTime *types.Time
}

type Endpoint

type Endpoint struct {
	// Output only. The full resource path of the endpoint. Format:
	// projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
	Name *string `fieldmask:"name"`
	// System-generated unique ID for the endpoint.
	Uid *string `fieldmask:"uid"`
	// The branch containing this endpoint (API resource hierarchy). Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string `fieldmask:"parent"`
	// A timestamp indicating when the compute endpoint was created.
	CreateTime *types.Time `fieldmask:"create_time"`
	// A timestamp indicating when the compute endpoint was last updated.
	UpdateTime *types.Time `fieldmask:"update_time"`
	// The spec contains the compute endpoint configuration, including autoscaling
	// limits, suspend timeout, and disabled state.
	Spec *EndpointSpec `fieldmask:"spec"`
	// Current operational status of the compute endpoint.
	Status *EndpointStatus `fieldmask:"status"`
	// The part of the name, chosen by the user when the resource was created.
	EndpointId *string `fieldmask:"endpoint_id"`
}

type EndpointGroupSpec

type EndpointGroupSpec struct {
	// The minimum number of computes in the endpoint group. Currently, this must be
	// equal to max. This must be greater than or equal to 1.
	Min *int `fieldmask:"min"`
	// The maximum number of computes in the endpoint group. Currently, this must be
	// equal to min. Set to 1 for single compute endpoints, to disable HA. To
	// manually suspend all computes in an endpoint group, set disabled to true on
	// the EndpointSpec.
	Max *int `fieldmask:"max"`
	// Whether to allow read-only connections to read-write endpoints. Only relevant
	// for read-write endpoints where size.max > 1.
	EnableReadableSecondaries *bool `fieldmask:"enable_readable_secondaries"`
}

type EndpointGroupStatus

type EndpointGroupStatus struct {
	// The minimum number of computes in the endpoint group. Currently, this must be
	// equal to max. This must be greater than or equal to 1.
	Min *int `fieldmask:"min"`
	// The maximum number of computes in the endpoint group. Currently, this must be
	// equal to min. Set to 1 for single compute endpoints, to disable HA. To
	// manually suspend all computes in an endpoint group, set disabled to true on
	// the EndpointSpec.
	Max *int `fieldmask:"max"`
	// Whether read-only connections to read-write endpoints are allowed. Only
	// relevant if read replicas are configured by specifying size.max > 1.
	EnableReadableSecondaries *bool `fieldmask:"enable_readable_secondaries"`
}

type EndpointHosts

type EndpointHosts struct {
	// The hostname to connect to this endpoint. For read-write endpoints, this is a
	// read-write hostname which connects to the primary compute. For read-only
	// endpoints, this is a read-only hostname which allows read-only operations.
	Host *string `fieldmask:"host"`
	// An optionally defined read-only host for the endpoint, without pooling. For
	// read-only endpoints, this attribute is always defined and is equivalent to
	// host. For read-write endpoints, this attribute is defined if the enclosing
	// endpoint is a group with greater than 1 computes configured, and has readable
	// secondaries enabled.
	ReadOnlyHost *string `fieldmask:"read_only_host"`
	// The read-write hostname of the compute endpoint, with pooling. This attribute
	// is only defined for read-write endpoints.
	ReadWritePooledHost *string `fieldmask:"read_write_pooled_host"`
	// The read-only hostname of the compute endpoint, with pooling. This attribute
	// is always defined for read-only endpoints, and may be defined for read-write
	// endpoints if configured with read replicas and allow read-only connections.
	ReadOnlyPooledHost *string `fieldmask:"read_only_pooled_host"`
}

Encapsulates various hostnames (r/w or r/o, pooled or not) for an endpoint..

type EndpointOperationMetadata

type EndpointOperationMetadata struct {
}

type EndpointSettings

type EndpointSettings struct {
	// A raw representation of Postgres settings.
	PgSettings map[string]string `fieldmask:"pg_settings"`
}

A collection of settings for a compute endpoint..

type EndpointSpec

type EndpointSpec struct {
	// The endpoint type. A branch can only have one READ_WRITE endpoint.
	EndpointType EndpointType `fieldmask:"endpoint_type"`
	// The minimum number of Compute Units. Minimum value is 0.5.
	AutoscalingLimitMinCu *float64 `fieldmask:"autoscaling_limit_min_cu"`
	// The maximum number of Compute Units. The maximum value is 64. The difference
	// between the minimum and maximum Compute Units (max - min) must not exceed 16.
	AutoscalingLimitMaxCu *float64 `fieldmask:"autoscaling_limit_max_cu"`
	// Whether to restrict connections to the compute endpoint. Enabling this option
	// schedules a suspend compute operation. A disabled compute endpoint cannot be
	// enabled by a connection or console action.
	Disabled *bool `fieldmask:"disabled"`
	// Duration of inactivity after which the compute endpoint is automatically
	// suspended. One of suspend_timeout_duration or no_suspension can be provided.
	// When not specified default suspension behavior will be used (consult with
	// documentation).
	//
	// When updating this field, use "spec.suspension" in the update_mask.
	Suspension isEndpointSpec_Suspension
	Settings   *EndpointSettings `fieldmask:"settings"`
	// Settings for optional HA configuration of the endpoint. If unspecified, the
	// endpoint defaults to non HA settings, with a single compute backing the
	// endpoint (and no readable secondaries for Read/Write endpoints).
	Group *EndpointGroupSpec `fieldmask:"group"`
	// contains filtered or unexported fields
}

type EndpointSpec_Suspension_NoSuspension

type EndpointSpec_Suspension_NoSuspension struct {
	NoSuspension bool `fieldmask:"no_suspension"`
}

EndpointSpec_Suspension_NoSuspension selects NoSuspension for EndpointSpec.Suspension. When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.suspension` in the update_mask.

type EndpointSpec_Suspension_SuspendTimeoutDuration

type EndpointSpec_Suspension_SuspendTimeoutDuration struct {
	SuspendTimeoutDuration types.Duration `fieldmask:"suspend_timeout_duration"`
}

EndpointSpec_Suspension_SuspendTimeoutDuration selects SuspendTimeoutDuration for EndpointSpec.Suspension. Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with `no_suspension`. When updating, use `spec.suspension` in the update_mask.

type EndpointStatus

type EndpointStatus struct {
	// The endpoint type. A branch can only have one READ_WRITE endpoint.
	EndpointType EndpointType `fieldmask:"endpoint_type"`
	// Contains host information for connecting to the endpoint.
	Hosts *EndpointHosts `fieldmask:"hosts"`
	// A timestamp indicating when the compute endpoint was last active.
	LastActiveTime *types.Time `fieldmask:"last_active_time"`
	// The minimum number of Compute Units.
	AutoscalingLimitMinCu *float64 `fieldmask:"autoscaling_limit_min_cu"`
	// The maximum number of Compute Units. The maximum value is 64. The difference
	// between the minimum and maximum Compute Units (max - min) must not exceed 16.
	AutoscalingLimitMaxCu *float64             `fieldmask:"autoscaling_limit_max_cu"`
	CurrentState          EndpointStatus_State `fieldmask:"current_state"`
	PendingState          EndpointStatus_State `fieldmask:"pending_state"`
	// Whether to restrict connections to the compute endpoint. Enabling this option
	// schedules a suspend compute operation. A disabled compute endpoint cannot be
	// enabled by a connection or console action.
	Disabled *bool `fieldmask:"disabled"`
	// Duration of inactivity after which the compute endpoint is automatically
	// suspended.
	SuspendTimeoutDuration *types.Duration   `fieldmask:"suspend_timeout_duration"`
	Settings               *EndpointSettings `fieldmask:"settings"`
	// Details on the HA configuration of the endpoint.
	Group *EndpointGroupStatus `fieldmask:"group"`
	// Part of the resource name.
	EndpointId *string `fieldmask:"endpoint_id"`
}

type EndpointStatus_State

type EndpointStatus_State string

The state of the compute endpoint.

const (
	EndpointStatus_State_Unspecified EndpointStatus_State = ""
	EndpointStatus_State_Init        EndpointStatus_State = "INIT"
	EndpointStatus_State_Active      EndpointStatus_State = "ACTIVE"
	EndpointStatus_State_Idle        EndpointStatus_State = "IDLE"
	EndpointStatus_State_Degraded    EndpointStatus_State = "DEGRADED"
)

type EndpointType

type EndpointType string

The compute endpoint type. Either `read_write` or `read_only`.

const (
	EndpointType_Unspecified           EndpointType = ""
	EndpointType_EndpointTypeReadWrite EndpointType = "ENDPOINT_TYPE_READ_WRITE"
	EndpointType_EndpointTypeReadOnly  EndpointType = "ENDPOINT_TYPE_READ_ONLY"
)

type ErrorCode

type ErrorCode string

Error codes returned by Databricks APIs to indicate specific failure conditions.

const (
	ErrorCode_Unspecified ErrorCode = ""
	// Internal error. This means that some invariants expected by the underlying
	// system have been broken. This error code is reserved for serious errors,
	// which generally cannot be resolved by the user.
	//
	// Prefer this over all kinds of detailed error messages (e.g IO_ERROR), unless
	// there's some automation that relies on the custom error code.
	//
	// Maps to: - google.rpc.Code: INTERNAL = 13; - HTTP code: 500 Internal Server
	// Error
	ErrorCode_InternalError ErrorCode = "INTERNAL_ERROR"
	// The service is currently unavailable. This is most likely a transient
	// condition, which can be corrected by retrying with a backoff. Note that it is
	// not always safe to retry non-idempotent operations.
	//
	// Prefer this over SERVICE_UNDER_MAINTENANCE,
	// WORKSPACE_TEMPORARILY_UNAVAILABLE.
	//
	// See
	// https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
	// for guideline on how to pick this vs RESOURCE_EXHAUSTED.
	//
	// Maps to: - google.rpc.Code: UNAVAILABLE = 14; - HTTP code: 503 Service
	// Unavailable
	ErrorCode_TemporarilyUnavailable ErrorCode = "TEMPORARILY_UNAVAILABLE"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes. Indicates that an IOException has been internally
	// thrown.
	ErrorCode_IoError ErrorCode = "IO_ERROR"
	// The request is invalid. Prefer more specific error code whenever possible.
	// Also see similar recommendation for the google.rpc.Code.FAILED_PRECONDITION.
	//
	// Prefer this error code over MALFORMED_REQUEST, INVALID_STATE,
	// UNPARSEABLE_HTTP_ERROR.
	//
	// Maps to: - google.rpc.Code: FAILED_PRECONDITION = 9; - HTTP code: 400 Bad
	// Request
	ErrorCode_BadRequest ErrorCode = "BAD_REQUEST"
	// An external service is unavailable temporarily as it is being
	// updated/re-deployed. Indicates gateway proxy to safely retry the request.
	ErrorCode_ServiceUnderMaintenance ErrorCode = "SERVICE_UNDER_MAINTENANCE"
	// A workspace is temporarily unavailable as the workspace is being re-assigned.
	ErrorCode_WorkspaceTemporarilyUnavailable ErrorCode = "WORKSPACE_TEMPORARILY_UNAVAILABLE"
	// The deadline expired before the operation could complete. For operations that
	// change the state of the system, this error may be returned even if the
	// operation has completed successfully. For example, a successful response from
	// a server could have been delayed long enough for the deadline to expire. When
	// possible - implementations should make sure further processing of the request
	// is aborted, e.g. by throwing an exception instead of making the RPC request,
	// making the database query, etc.
	//
	// Maps to: - google.rpc.Code: DEADLINE_EXCEEDED = 4; - HTTP code: 504 Gateway
	// Timeout
	ErrorCode_DeadlineExceeded ErrorCode = "DEADLINE_EXCEEDED"
	// The operation was canceled by the caller. An example - client closed the
	// connection without waiting for a response.
	//
	// Maps to: - google.rpc.Code: CANCELLED = 1; - HTTP code: 499 Client Closed
	// Request
	ErrorCode_Cancelled ErrorCode = "CANCELLED"
	// The operation is rejected because of either rate limiting or resource quota,
	// such as the client has sent too many requests recently or the client has
	// allocated too many resources.
	//
	// See
	// https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
	// for guideline on how to pick this vs TEMPORARILY_UNAVAILABLE.
	//
	// Maps to: - google.rpc.Code: RESOURCE_EXHAUSTED = 8; - HTTP code: 429 Too Many
	// Requests
	ErrorCode_ResourceExhausted ErrorCode = "RESOURCE_EXHAUSTED"
	// The operation was aborted, typically due to a concurrency issue such as a
	// sequencer check failure, transaction abort, or transaction conflict.
	//
	// Maps to: - google.rpc.Code: ABORTED = 10; - HTTP code: 409 Conflict
	ErrorCode_Aborted ErrorCode = "ABORTED"
	// Operation was performed on a resource that does not exist, e.g. file or
	// directory was not found.
	//
	// Maps to: - google.rpc.Code: NOT_FOUND = 5; - HTTP code: 404 Not Found
	ErrorCode_NotFound ErrorCode = "NOT_FOUND"
	// Operation was rejected due a conflict with an existing resource, e.g.
	// attempted to create file or directory that already exists.
	//
	// Prefer this over RESOURCE_CONFLICT.
	//
	// Maps to: - google.rpc.Code: ALREADY_EXISTS = 6; - HTTP code: 409 Conflict
	ErrorCode_AlreadyExists ErrorCode = "ALREADY_EXISTS"
	// The request does not have valid authentication (AuthN) credentials for the
	// operation.
	//
	// Prefer this over CUSTOMER_UNAUTHORIZED, unless you need to keep consistent
	// behavior with legacy code. For authorization (AuthZ) errors use
	// PERMISSION_DENIED. Maps to: - google.rpc.Code: UNAUTHENTICATED = 16; - HTTP
	// code: 401 Unauthorized
	ErrorCode_Unauthenticated ErrorCode = "UNAUTHENTICATED"
	// The service is currently unavailable. Please note that the unavailability may
	// or may not be transient. That means if this is a non-transient condition,
	// retrying it does not work. If the unavailability is certainly a transient
	// condition, pleases use `TEMPORARILY_UNAVAILABLE` which signals its transient
	// nature explicitly. An example of this error code’s use case is that when
	// DNS resolution fails, the DNS resolver does not know whether it is because
	// the domain name is completely wrong (non-transient situation) or the domain
	// name is valid but the DNS server does not have an entry for this domain name
	// yet (transient situation). Hence, `UNAVAILABLE` is suitable for this case.
	//
	// Maps to: - google.rpc.Code: UNAVAILABLE = 14; - HTTP code: 503 Service
	// Unavailable
	ErrorCode_Unavailable ErrorCode = "UNAVAILABLE"
	// Supplied value for a parameter was invalid (e.g., giving a number for a
	// string parameter).
	//
	// Maps to: - google.rpc.Code: INVALID_ARGUMENT = 3; - HTTP code: 400 Bad
	// Request
	ErrorCode_InvalidParameterValue ErrorCode = "INVALID_PARAMETER_VALUE"
	// Indicates that the given API endpoint does not exist. Legacy, when possible -
	// NOT_IMPLEMENTED should be used instead to indicate that API doesn't exist.
	//
	// Maps to: - google.rpc.Code: NOT_FOUND = 5; - HTTP code: 404 Not Found
	ErrorCode_EndpointNotFound ErrorCode = "ENDPOINT_NOT_FOUND"
	// Indicates that the given API request was malformed.
	ErrorCode_MalformedRequest ErrorCode = "MALFORMED_REQUEST"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes. If one or more of the inputs to a given RPC are not in
	// a valid state for the action.
	ErrorCode_InvalidState ErrorCode = "INVALID_STATE"
	// The caller does not have permission to execute the specified operation.
	// PERMISSION_DENIED must not be used for rejections caused by exhausting some
	// resource, use RESOURCE_EXHAUSTED instead for those errors. PERMISSION_DENIED
	// must not be used if the caller can not be identified, use
	// CUSTOMER_UNAUTHORIZED instead for those errors. This error code does not
	// imply the request is valid or the requested entity exists or satisfies other
	// pre-conditions.
	//
	// Maps to: - google.rpc.Code: PERMISSION_DENIED = 7; - HTTP code: 403 Forbidden
	ErrorCode_PermissionDenied ErrorCode = "PERMISSION_DENIED"
	// NOTE: Deprecated due to inconsistent mapping in legacy code, see
	// https://docs.google.com/document/d/17TZIKX_Y39cJMBr333lc-d5dTvvBLSu3DPUyGU5eMJg/edit?disco=AAAAzVGt6FA.
	// Prefer using NOT_FOUND or PERMISSION_DENIED.
	//
	// If a given user/entity is trying to use a feature which has been disabled.
	//
	// Maps to: - google.rpc.Code: NOT_FOUND = 5; - HTTP code: 404 Not Found
	ErrorCode_FeatureDisabled ErrorCode = "FEATURE_DISABLED"
	// The request does not have valid authentication (AuthN) credentials for the
	// operation.
	//
	// For authentication (AuthN) errors prefer using UNAUTHENTICATED, unless you
	// need to keep consistent behavior with legacy code. For authorization (AuthZ)
	// errors use PERMISSION_DENIED.
	//
	// Important: name is confusing, this error code is for authentication (AuthN)
	// errors, not authorization (AuthZ) errors. It maps to 401 Unauthorized and
	// suffers from the same confusing naming. See
	// https://datatracker.ietf.org/doc/html/rfc7235#section-3.1 - "[...] status
	// code indicates that the request has not been applied because it lacks valid
	// authentication credentials for the target resource. [...] If the request
	// included authentication credentials, then the 401 response indicates that
	// authorization has been refused for those credentials."
	//
	// Also, see https://stackoverflow.com/a/6937030/16352922, it covers it pretty
	// well.
	//
	// Maps to: - google.rpc.Code: UNAUTHENTICATED = 16; - HTTP code: 401
	// Unauthorized
	ErrorCode_CustomerUnauthorized ErrorCode = "CUSTOMER_UNAUTHORIZED"
	// The operation is rejected because of request rate limit, for example rate
	// limiting applied to users, workspaces, IP addresses, etc.
	//
	// Prefer a more generic RESOURCE_EXHAUSTED for the new use cases.
	//
	// See
	// https://docs.google.com/document/d/1FL8p2sbYWqBPL-UvhzI7uXAw4EoLG7Rj6PAOQWZRSOk/edit#
	// for guideline on the rate limiting vs throttling.
	//
	// Maps to: - google.rpc.Code: RESOURCE_EXHAUSTED = 8; - HTTP code: 429 Too Many
	// Requests
	ErrorCode_RequestLimitExceeded ErrorCode = "REQUEST_LIMIT_EXCEEDED"
	// Indicates API request was rejected due a conflict with an existing resource.
	ErrorCode_ResourceConflict ErrorCode = "RESOURCE_CONFLICT"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes. Indicates that the HTTP response cannot be correctly
	// deserialized. This currently is only used in DUST test clients, and not by
	// any real service code.
	ErrorCode_UnparseableHttpError ErrorCode = "UNPARSEABLE_HTTP_ERROR"
	// The operation is not implemented or is not supported/enabled in this service.
	//
	// Maps to: - google.rpc.Code: UNIMPLEMENTED = 12; - HTTP code: 501 Not
	// Implemented
	ErrorCode_NotImplemented ErrorCode = "NOT_IMPLEMENTED"
	// Unrecoverable data loss or corruption.
	//
	// One of the major use cases is to indicate that server failed to validate the
	// integrity of the request. This error can occur when the checksum specified in
	// the `X-Databricks-Checksum` request header (or trailer) doesn't match the
	// actual request content checksum.
	//
	// Note, in case of the severe corruption that results in a malformed request,
	// the server may send a generic `400 Bad Request` response rather than sending
	// this error code.
	//
	// Maps to: - google.rpc.Code: DATA_LOSS = 15; - HTTP code: 500 Internal Server
	// Error
	ErrorCode_DataLoss ErrorCode = "DATA_LOSS"
	// If the user attempts to perform an invalid state transition on a shard.
	ErrorCode_InvalidStateTransition ErrorCode = "INVALID_STATE_TRANSITION"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes. Unable to perform the operation because the shard was
	// locked by some other operation.
	ErrorCode_CouldNotAcquireLock ErrorCode = "COULD_NOT_ACQUIRE_LOCK"
	// NOTE: Deprecated, prefer using ALREADY_EXISTS. Unlike ALREADY_EXISTS - this
	// maps to HTTP code 400 Bad Request due to legacy reasons, remapping will be a
	// backwards incompatible change.
	//
	// Operation was performed on a resource that already exists.
	ErrorCode_ResourceAlreadyExists ErrorCode = "RESOURCE_ALREADY_EXISTS"
	// NOTE: Deprecated, prefer using NOT_FOUND - see the note for the
	// RESOURCE_ALREADY_EXISTS, because this pair of codes is related and
	// RESOURCE_ALREADY_EXISTS has bad mapping to the HTTP codes we added new error
	// codes NOT_FOUND and ALREADY_EXISTS, and recommend to use them instead.
	//
	// Operation was performed on a resource that does not exist.
	ErrorCode_ResourceDoesNotExist ErrorCode = "RESOURCE_DOES_NOT_EXIST"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_QuotaExceeded ErrorCode = "QUOTA_EXCEEDED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_MaxBlockSizeExceeded ErrorCode = "MAX_BLOCK_SIZE_EXCEEDED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_MaxReadSizeExceeded ErrorCode = "MAX_READ_SIZE_EXCEEDED"
	ErrorCode_PartialDelete       ErrorCode = "PARTIAL_DELETE"
	ErrorCode_MaxListSizeExceeded ErrorCode = "MAX_LIST_SIZE_EXCEEDED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_DryRunFailed ErrorCode = "DRY_RUN_FAILED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes. Cluster request was rejected because it would exceed a
	// resource limit.
	ErrorCode_ResourceLimitExceeded ErrorCode = "RESOURCE_LIMIT_EXCEEDED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_DirectoryNotEmpty ErrorCode = "DIRECTORY_NOT_EMPTY"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_DirectoryProtected ErrorCode = "DIRECTORY_PROTECTED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_MaxNotebookSizeExceeded  ErrorCode = "MAX_NOTEBOOK_SIZE_EXCEEDED"
	ErrorCode_MaxChildNodeSizeExceeded ErrorCode = "MAX_CHILD_NODE_SIZE_EXCEEDED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_SearchQueryTooLong ErrorCode = "SEARCH_QUERY_TOO_LONG"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_SearchQueryTooShort ErrorCode = "SEARCH_QUERY_TOO_SHORT"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_ManagedResourceGroupDoesNotExist ErrorCode = "MANAGED_RESOURCE_GROUP_DOES_NOT_EXIST"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_PermissionNotPropagated ErrorCode = "PERMISSION_NOT_PROPAGATED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_DeploymentTimeout ErrorCode = "DEPLOYMENT_TIMEOUT"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_GitConflict ErrorCode = "GIT_CONFLICT"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_GitUnknownRef ErrorCode = "GIT_UNKNOWN_REF"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_GitSensitiveTokenDetected ErrorCode = "GIT_SENSITIVE_TOKEN_DETECTED"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_GitUrlNotOnAllowList ErrorCode = "GIT_URL_NOT_ON_ALLOW_LIST"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_GitRemoteError ErrorCode = "GIT_REMOTE_ERROR"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_ProjectsOperationTimeout ErrorCode = "PROJECTS_OPERATION_TIMEOUT"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_IpynbFileInRepo ErrorCode = "IPYNB_FILE_IN_REPO"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_InsecurePartnerResponse ErrorCode = "INSECURE_PARTNER_RESPONSE"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_MalformedPartnerResponse ErrorCode = "MALFORMED_PARTNER_RESPONSE"
	ErrorCode_MetastoreDoesNotExist    ErrorCode = "METASTORE_DOES_NOT_EXIST"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_DacDoesNotExist               ErrorCode = "DAC_DOES_NOT_EXIST"
	ErrorCode_CatalogDoesNotExist           ErrorCode = "CATALOG_DOES_NOT_EXIST"
	ErrorCode_SchemaDoesNotExist            ErrorCode = "SCHEMA_DOES_NOT_EXIST"
	ErrorCode_TableDoesNotExist             ErrorCode = "TABLE_DOES_NOT_EXIST"
	ErrorCode_ShareDoesNotExist             ErrorCode = "SHARE_DOES_NOT_EXIST"
	ErrorCode_RecipientDoesNotExist         ErrorCode = "RECIPIENT_DOES_NOT_EXIST"
	ErrorCode_StorageCredentialDoesNotExist ErrorCode = "STORAGE_CREDENTIAL_DOES_NOT_EXIST"
	ErrorCode_ExternalLocationDoesNotExist  ErrorCode = "EXTERNAL_LOCATION_DOES_NOT_EXIST"
	ErrorCode_PrincipalDoesNotExist         ErrorCode = "PRINCIPAL_DOES_NOT_EXIST"
	ErrorCode_ProviderDoesNotExist          ErrorCode = "PROVIDER_DOES_NOT_EXIST"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_MetastoreAlreadyExists ErrorCode = "METASTORE_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_DacAlreadyExists ErrorCode = "DAC_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_CatalogAlreadyExists ErrorCode = "CATALOG_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_SchemaAlreadyExists ErrorCode = "SCHEMA_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_TableAlreadyExists ErrorCode = "TABLE_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_ShareAlreadyExists ErrorCode = "SHARE_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_RecipientAlreadyExists ErrorCode = "RECIPIENT_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_StorageCredentialAlreadyExists ErrorCode = "STORAGE_CREDENTIAL_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_ExternalLocationAlreadyExists ErrorCode = "EXTERNAL_LOCATION_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_ProviderAlreadyExists ErrorCode = "PROVIDER_ALREADY_EXISTS"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_CatalogNotEmpty ErrorCode = "CATALOG_NOT_EMPTY"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_SchemaNotEmpty ErrorCode = "SCHEMA_NOT_EMPTY"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_MetastoreNotEmpty ErrorCode = "METASTORE_NOT_EMPTY"
	// NOTE: Deprecated and kept to maintain backwards compatibility for public APIs
	// that use it, avoid using it in the new APIs, refer error codes listed in the
	// http://go/error-codes.
	ErrorCode_ProviderShareNotAccessible ErrorCode = "PROVIDER_SHARE_NOT_ACCESSIBLE"
)

type GenerateDatabaseCredentialRequest

type GenerateDatabaseCredentialRequest struct {
	// The returned token will be scoped to UC tables with the specified
	// permissions.
	Claims []RequestedClaims
	// The endpoint resource name for which this credential will be generated.
	// Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
	Endpoint *string
	// Expiration information for the credential. Users can specify either
	// expire_time or ttl. If unspecified, maximum allowed duration (1 hour) is
	// used.
	Expiration isGenerateDatabaseCredentialRequest_Expiration
}

type GenerateDatabaseCredentialRequest_Expiration_ExpireTime

type GenerateDatabaseCredentialRequest_Expiration_ExpireTime struct {
	ExpireTime types.Time
}

GenerateDatabaseCredentialRequest_Expiration_ExpireTime selects ExpireTime for GenerateDatabaseCredentialRequest.Expiration. Timestamp in UTC of when this credential should expire. Must be at least 300 seconds (5 minutes) and at most 1 hour from the current time.

type GenerateDatabaseCredentialRequest_Expiration_Ttl

type GenerateDatabaseCredentialRequest_Expiration_Ttl struct {
	Ttl types.Duration
}

GenerateDatabaseCredentialRequest_Expiration_Ttl selects Ttl for GenerateDatabaseCredentialRequest.Expiration. The requested time-to-live for the generated credential token. Must be at least 300 seconds (5 minutes) and at most 3600 seconds (1 hour).

type GetBranchRequest

type GetBranchRequest struct {
	// The full resource path of the branch to retrieve. Format:
	// projects/{project_id}/branches/{branch_id}
	Name *string
}

type GetCatalogRequest

type GetCatalogRequest struct {
	// The full resource path of the catalog to retrieve.
	//
	// Format: "catalogs/{catalog_id}".
	Name *string
}

type GetCdfConfigRequest

type GetCdfConfigRequest struct {
	// The resource name of the CdfConfig to retrieve. Format:
	// projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
	Name *string
}

Request to retrieve a single CdfConfig..

type GetCdfStatusRequest

type GetCdfStatusRequest struct {
	// The resource name of the CdfStatus to retrieve. Format:
	// projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}/cdf-statuses/{cdf_status}
	Name *string
}

Request to retrieve the status of a single replicated table (CdfStatus)..

type GetDataApiRequest

type GetDataApiRequest struct {
	// Resource name:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}/data-api
	Name *string
}

Get Data API configuration for a database..

type GetDatabaseRequest

type GetDatabaseRequest struct {
	// The name of the Database to retrieve. Format:
	// projects/{project_id}/branches/{branch_id}/databases/{database_id}
	Name *string
}

type GetEndpointRequest

type GetEndpointRequest struct {
	// The full resource path of the endpoint to retrieve. Format:
	// projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
	Name *string
}

type GetOperationRequest

type GetOperationRequest struct {
	// The name of the operation resource.
	Name *string
}

The request message for `GetOperation` method..

type GetProjectRequest

type GetProjectRequest struct {
	// The full resource path of the project to retrieve. Format:
	// projects/{project_id}
	Name *string
}

type GetRoleRequest

type GetRoleRequest struct {
	// The full resource path of the role to retrieve. Format:
	// projects/{project_id}/branches/{branch_id}/roles/{role_id}
	Name *string
}

type GetSnapshotRequest

type GetSnapshotRequest struct {
	// The resource name of the snapshot to retrieve. Format:
	// projects/{project_id}/snapshots/{snapshot_id}
	Name *string
}

type GetSnapshotScheduleRequest

type GetSnapshotScheduleRequest struct {
	// The resource name of the branch's snapshot schedule. Format:
	// projects/{project_id}/branches/{branch_id}/snapshot-schedule
	Name *string
}

Request to retrieve the snapshot schedule for a branch..

type GetSyncedTableRequest

type GetSyncedTableRequest struct {
	// The Full resource name of the synced table. Format:
	// "synced_tables/{catalog}.{schema}.{table}", where (catalog, schema, table)
	// are the entity names in the Unity Catalog.
	Name *string
}

type InitialBranchSpec

type InitialBranchSpec struct {
	// Whether the initial default branch should be protected from deletion.
	IsProtected *bool `fieldmask:"is_protected"`
}

Configuration for the initial default branch created during project creation..

type InitialEndpointSpec

type InitialEndpointSpec struct {
	// Settings for HA configuration of the endpoint.
	Group *EndpointGroupSpec `fieldmask:"group"`
	// The minimum number of Compute Units for the initial endpoint.
	AutoscalingLimitMinCu *float64 `fieldmask:"autoscaling_limit_min_cu"`
	// The maximum number of Compute Units for the initial endpoint.
	AutoscalingLimitMaxCu *float64 `fieldmask:"autoscaling_limit_max_cu"`
	Suspension            isInitialEndpointSpec_Suspension
	// contains filtered or unexported fields
}

Configuration for the initial Read/Write endpoint created during project creation..

type InitialEndpointSpec_Suspension_NoSuspension

type InitialEndpointSpec_Suspension_NoSuspension struct {
	NoSuspension bool `fieldmask:"no_suspension"`
}

InitialEndpointSpec_Suspension_NoSuspension selects NoSuspension for InitialEndpointSpec.Suspension. When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with `suspend_timeout_duration`.

type InitialEndpointSpec_Suspension_SuspendTimeoutDuration

type InitialEndpointSpec_Suspension_SuspendTimeoutDuration struct {
	SuspendTimeoutDuration types.Duration `fieldmask:"suspend_timeout_duration"`
}

InitialEndpointSpec_Suspension_SuspendTimeoutDuration selects SuspendTimeoutDuration for InitialEndpointSpec.Suspension. Duration of inactivity after which the initial endpoint is automatically suspended. If specified, should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with `no_suspension`.

type ListBranchesRequest

type ListBranchesRequest struct {
	// The Project that owns this collection of branches. Format:
	// projects/{project_id}
	Parent *string
	// Page token from a previous response. If not provided, returns the first page.
	PageToken *string
	// Upper bound for items returned. Cannot be negative.
	PageSize *int
	// Whether to include soft-deleted branches in the response. When true, deleted
	// branches are included alongside active branches. Purged branches are never
	// returned.
	ShowDeleted *bool
}

type ListBranchesResponse

type ListBranchesResponse struct {
	// List of branches in the project.
	Branches []Branch
	// Token to request the next page of branches.
	NextPageToken *string
}

type ListCdfConfigsRequest

type ListCdfConfigsRequest struct {
	// The parent database to list CdfConfigs for. Format:
	// projects/{project}/branches/{branch}/databases/{database}
	Parent *string
	// Maximum number of CdfConfigs to return.
	PageSize *int
	// Pagination token returned by a previous ListCdfConfigs call. Empty on the
	// first page.
	PageToken *string
}

Request to list the Lakebase CDF configurations (CdfConfigs) under a database..

type ListCdfConfigsResponse

type ListCdfConfigsResponse struct {
	// The CdfConfigs under the parent database.
	CdfConfigs []CdfConfig
	// Token to retrieve the next page of results; empty when there are no more.
	NextPageToken *string
}

Response to a ListCdfConfigs request, containing a page of CdfConfigs and a token for fetching the next page..

type ListCdfStatusesRequest

type ListCdfStatusesRequest struct {
	// The parent CdfConfig to list CdfStatuses for. Format:
	// projects/{project}/branches/{branch}/databases/{database}/cdf-configs/{cdf_config}
	Parent *string
	// Maximum number of CdfStatuses to return.
	PageSize *int
	// Pagination token returned by a previous ListCdfStatuses call. Empty on the
	// first page.
	PageToken *string
}

Request to list the statuses of all tables replicated under a Lakebase CDF configuration (CdfConfig)..

type ListCdfStatusesResponse

type ListCdfStatusesResponse struct {
	// The replicated tables under the parent CdfConfig.
	CdfStatuses []CdfStatus
	// Token to retrieve the next page of results; empty when there are no more.
	NextPageToken *string
}

Response to a ListCdfStatuses request, containing a page of replicated table statuses and a token for fetching the next page..

type ListDatabasesRequest

type ListDatabasesRequest struct {
	// The Branch that owns this collection of databases. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string
	// Pagination token to go to the next page of Databases. Requests first page if
	// absent.
	PageToken *string
	// Upper bound for items returned.
	PageSize *int
}

List Databases..

type ListDatabasesResponse

type ListDatabasesResponse struct {
	// List of databases.
	Databases []Database
	// Pagination token to request the next page of databases.
	NextPageToken *string
}

type ListEndpointsRequest

type ListEndpointsRequest struct {
	// The Branch that owns this collection of endpoints. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string
	// Page token from a previous response. If not provided, returns the first page.
	PageToken *string
	// Upper bound for items returned. Cannot be negative.
	PageSize *int
}

type ListEndpointsResponse

type ListEndpointsResponse struct {
	// List of compute endpoints in the branch.
	Endpoints []Endpoint
	// Token to request the next page of compute endpoints.
	NextPageToken *string
}

type ListProjectsRequest

type ListProjectsRequest struct {
	// Page token from a previous response. If not provided, returns the first page.
	PageToken *string
	// Upper bound for items returned. Cannot be negative. The maximum value is 100.
	PageSize *int
	// Whether to include soft-deleted projects in the response. When true,
	// soft-deleted projects are included alongside active projects. Hard-deleted
	// and already-purged projects are never returned.
	ShowDeleted *bool
}

type ListProjectsResponse

type ListProjectsResponse struct {
	// List of all projects in the workspace that the user has permission to access.
	Projects []Project
	// Token to request the next page of projects.
	NextPageToken *string
}

type ListRolesRequest

type ListRolesRequest struct {
	// The Branch that owns this collection of roles. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent *string
	// Page token from a previous response. If not provided, returns the first page.
	PageToken *string
	// Upper bound for items returned. Cannot be negative.
	PageSize *int
}

type ListRolesResponse

type ListRolesResponse struct {
	// List of Postgres roles in the branch.
	Roles []Role
	// Token to request the next page of Postgres roles.
	NextPageToken *string
}

type ListSnapshotsRequest

type ListSnapshotsRequest struct {
	// The project that owns the snapshots. Format: projects/{project_id}
	Parent *string
	// Page token from a previous response; omit for the first page.
	PageToken *string
	// Maximum number of snapshots to return per page.
	PageSize *int
}

type ListSnapshotsResponse

type ListSnapshotsResponse struct {
	// The snapshots in the project.
	Snapshots []Snapshot
	// Token to retrieve the next page; empty if there are no more pages.
	NextPageToken *string
}

type MonthlySchedule

type MonthlySchedule struct {
	// The day of the month on which to take the snapshot, in [1, 31]. In shorter
	// months the snapshot is taken on the last day instead (day 31 runs on Feb 28
	// or 29, and on Apr 30), so every month gets exactly one snapshot.
	Day *int
	// The hour of the day, in UTC, at which to take the snapshot, in [0, 23].
	Hour *int
}

Take a snapshot once per month, on the configured day at the configured hour..

type NewPipelineSpec

type NewPipelineSpec struct {
	// UC catalog for the pipeline to store intermediate files (checkpoints, event
	// logs etc). This needs to be a standard catalog where the user has permissions
	// to create Delta tables.
	StorageCatalog *string
	// UC schema for the pipeline to store intermediate files (checkpoints, event
	// logs etc). This needs to be in the standard catalog where the user has
	// permissions to create Delta tables.
	StorageSchema *string
	// Budget policy to set on the newly created pipeline.
	BudgetPolicyId *string
	// Release channel of the underlying pipeline's runtime. Some source table
	// configurations (e.g., read-time CDF) require PREVIEW. Defaults to CURRENT if
	// not specified.
	PipelineChannel NewPipelineSpec_PipelineChannel
}

type NewPipelineSpec_PipelineChannel

type NewPipelineSpec_PipelineChannel string

Release channel of the underlying pipeline's runtime. PREVIEW provides early access to the latest features but may be less stable. Some source table configurations (e.g., read-time CDF) require PREVIEW. Defaults to CURRENT if not specified.

const (
	NewPipelineSpec_PipelineChannel_Unspecified NewPipelineSpec_PipelineChannel = ""
	// Uses the stable, generally available runtime.
	NewPipelineSpec_PipelineChannel_Current NewPipelineSpec_PipelineChannel = "CURRENT"
	// Uses the latest preview runtime. Required for Auto CDF (read-time CDF)
	// sources.
	NewPipelineSpec_PipelineChannel_Preview NewPipelineSpec_PipelineChannel = "PREVIEW"
)

type OpenApiMode

type OpenApiMode string

Controls how the Data API exposes the OpenAPI documentation endpoint. Only IGNORE_PRIVILEGES and DISABLED are supported today; "follow-privileges" is not implemented yet (it may be added later as value 3 — adding new enum values is backward-compatible).

const (
	OpenApiMode_Unspecified OpenApiMode = ""
	// Generate OpenAPI output ignoring the privileges of the requesting role.
	OpenApiMode_OpenApiModeIgnorePrivileges OpenApiMode = "OPEN_API_MODE_IGNORE_PRIVILEGES"
	// Disable the OpenAPI documentation endpoint entirely.
	OpenApiMode_OpenApiModeDisabled OpenApiMode = "OPEN_API_MODE_DISABLED"
)

type Operation

type Operation struct {
	// The server-assigned name, which is only unique within the same service that
	// originally returns it. If you use the default HTTP mapping, the `name` should
	// be a resource name ending with `operations/{unique_id}`.
	Name *string
	// Service-specific metadata associated with the operation. It typically
	// contains progress information and common metadata such as create time. Some
	// services might not provide such metadata.
	Metadata json.RawMessage
	// If the value is `false`, it means the operation is still in progress. If
	// `true`, the operation is completed, and either `error` or `response` is
	// available.
	Done *bool
	// The operation result, which can be either an `error` or a valid `response`.
	// If `done` == `false`, neither `error` nor `response` is set. If `done` ==
	// `true`, exactly one of `error` or `response` can be set. Some services might
	// not provide the result.
	Result isOperation_Result
}

This resource represents a long-running operation that is the result of a network API call..

type Operation_Result_Error

type Operation_Result_Error struct {
	Error ApiError
}

Operation_Result_Error selects Error for Operation.Result. The error result of the operation in case of failure or cancellation.

type Operation_Result_Response

type Operation_Result_Response struct {
	Response json.RawMessage
}

Operation_Result_Response selects Response for Operation.Result. The normal, successful response of the operation.

type Project

type Project struct {
	// Output only. The full resource path of the project. Format:
	// projects/{project_id}
	Name *string `fieldmask:"name"`
	// System-generated unique ID for the project.
	Uid *string `fieldmask:"uid"`
	// A timestamp indicating when the project was created.
	CreateTime *types.Time `fieldmask:"create_time"`
	// A timestamp indicating when the project was last updated.
	UpdateTime *types.Time `fieldmask:"update_time"`
	// The spec contains the project configuration, including display_name,
	// pg_version (Postgres version), history_retention_duration, and
	// default_endpoint_settings.
	Spec *ProjectSpec `fieldmask:"spec"`
	// The current status of a Project.
	Status *ProjectStatus `fieldmask:"status"`
	// Configuration settings for the initial Read/Write endpoint created inside the
	// initial branch for a newly created project. If omitted, the initial endpoint
	// created will have default settings, without high availability configured.
	// This field does not apply to any endpoints created after project creation.
	// Use spec.default_endpoint_settings to configure default settings for
	// endpoints created after project creation.
	InitialEndpointSpec *InitialEndpointSpec `fieldmask:"initial_endpoint_spec"`
	// A timestamp indicating when the project was soft-deleted. Empty if the
	// project is not deleted, otherwise set to a timestamp in the past.
	DeleteTime *types.Time `fieldmask:"delete_time"`
	// A timestamp indicating when the project is scheduled for permanent deletion.
	// Empty if the project is not deleted, otherwise set to a timestamp in the
	// future.
	PurgeTime *types.Time `fieldmask:"purge_time"`
	// Configuration for the initial default branch created as part of project
	// creation. Allows overriding branch protection. These settings only apply at
	// creation time and do not affect resources created after project creation.
	InitialBranchSpec *InitialBranchSpec `fieldmask:"initial_branch_spec"`
	// The part of the name, chosen by the user when the resource was created.
	ProjectId *string `fieldmask:"project_id"`
}

type ProjectCustomTag

type ProjectCustomTag struct {
	// The key of the custom tag.
	Key *string
	// The value of the custom tag.
	Value *string
}

type ProjectDefaultEndpointSettings

type ProjectDefaultEndpointSettings struct {
	// The minimum number of Compute Units. Minimum value is 0.5.
	AutoscalingLimitMinCu *float64 `fieldmask:"autoscaling_limit_min_cu"`
	// The maximum number of Compute Units. Minimum value is 0.5.
	AutoscalingLimitMaxCu *float64 `fieldmask:"autoscaling_limit_max_cu"`
	Suspension            isProjectDefaultEndpointSettings_Suspension
	// A raw representation of Postgres settings.
	PgSettings map[string]string `fieldmask:"pg_settings"`
	// contains filtered or unexported fields
}

A collection of settings for a compute endpoint..

type ProjectDefaultEndpointSettings_Suspension_NoSuspension

type ProjectDefaultEndpointSettings_Suspension_NoSuspension struct {
	NoSuspension bool `fieldmask:"no_suspension"`
}

ProjectDefaultEndpointSettings_Suspension_NoSuspension selects NoSuspension for ProjectDefaultEndpointSettings.Suspension. When set to true, explicitly disables automatic suspension (never suspend). Should be set to true when provided. Mutually exclusive with `suspend_timeout_duration`. When updating, use `spec.project_default_settings.suspension` in the update_mask.

type ProjectDefaultEndpointSettings_Suspension_SuspendTimeoutDuration

type ProjectDefaultEndpointSettings_Suspension_SuspendTimeoutDuration struct {
	SuspendTimeoutDuration types.Duration `fieldmask:"suspend_timeout_duration"`
}

ProjectDefaultEndpointSettings_Suspension_SuspendTimeoutDuration selects SuspendTimeoutDuration for ProjectDefaultEndpointSettings.Suspension. Duration of inactivity after which the compute endpoint is automatically suspended. If specified should be between 60s and 604800s (1 minute to 1 week). Mutually exclusive with `no_suspension`. When updating, use `spec.project_default_settings.suspension` in the update_mask.

type ProjectOperationMetadata

type ProjectOperationMetadata struct {
}

type ProjectSpec

type ProjectSpec struct {
	// Human-readable project name. Length should be between 1 and 256 characters.
	DisplayName *string `fieldmask:"display_name"`
	// The major Postgres version number. The set of supported versions may vary;
	// consult the API documentation for currently accepted values.
	PgVersion *int `fieldmask:"pg_version"`
	// The number of seconds to retain the shared history for point in time recovery
	// for all branches in this project. Value should be between 172800s (2 days)
	// and 3024000s (35 days).
	HistoryRetentionDuration *types.Duration                 `fieldmask:"history_retention_duration"`
	DefaultEndpointSettings  *ProjectDefaultEndpointSettings `fieldmask:"default_endpoint_settings"`
	// The desired budget policy to associate with the project. See
	// status.budget_policy_id for the policy that is actually applied to the
	// project.
	BudgetPolicyId *string `fieldmask:"budget_policy_id"`
	// Custom tags to associate with the project. Forwarded to LBM for billing and
	// cost tracking. To update tags, provide the new tag list and include
	// "spec.custom_tags" in the update_mask. To clear all tags, provide an empty
	// list and include "spec.custom_tags" in the update_mask. To preserve existing
	// tags, omit this field from the update_mask (or use wildcard "*" which
	// auto-excludes empty tags).
	CustomTags []ProjectCustomTag `fieldmask:"custom_tags"`
	// Whether to enable PG native password login on all endpoints in this project.
	// Defaults to false.
	EnablePgNativeLogin *bool `fieldmask:"enable_pg_native_login"`
	// The full resource path for the default branch of the project Format:
	// projects/{project_id}/branches/{branch_id}
	DefaultBranch *string `fieldmask:"default_branch"`
}

type ProjectStatus

type ProjectStatus struct {
	// The effective human-readable project name.
	DisplayName *string `fieldmask:"display_name"`
	// The effective major Postgres version number.
	PgVersion *int `fieldmask:"pg_version"`
	// The effective number of seconds to retain the shared history for point in
	// time recovery.
	HistoryRetentionDuration *types.Duration `fieldmask:"history_retention_duration"`
	// The effective default endpoint settings.
	DefaultEndpointSettings *ProjectDefaultEndpointSettings `fieldmask:"default_endpoint_settings"`
	// The logical size limit for a branch.
	BranchLogicalSizeLimitBytes *int64 `fieldmask:"branch_logical_size_limit_bytes"`
	// The current space occupied by the project in storage.
	SyntheticStorageSizeBytes *int64 `fieldmask:"synthetic_storage_size_bytes"`
	// The most recent time when any endpoint of this project was active.
	ComputeLastActiveTime *types.Time `fieldmask:"compute_last_active_time"`
	// The budget policy that is applied to the project.
	BudgetPolicyId *string `fieldmask:"budget_policy_id"`
	// The effective custom tags associated with the project.
	CustomTags []ProjectCustomTag `fieldmask:"custom_tags"`
	// The email of the project owner.
	Owner *string `fieldmask:"owner"`
	// Whether to enable PG native password login on all endpoints in this project.
	EnablePgNativeLogin *bool `fieldmask:"enable_pg_native_login"`
	// The full resource path of the default branch of the project
	DefaultBranch *string `fieldmask:"default_branch"`
	// Part of the resource name.
	ProjectId *string `fieldmask:"project_id"`
}

type ProvisioningInfo

type ProvisioningInfo struct {
}

The provisioning state of a resource in Unity Catalog..

type ProvisioningInfo_State

type ProvisioningInfo_State string
const (
	ProvisioningInfo_State_Unspecified  ProvisioningInfo_State = ""
	ProvisioningInfo_State_Provisioning ProvisioningInfo_State = "PROVISIONING"
	ProvisioningInfo_State_Active       ProvisioningInfo_State = "ACTIVE"
	ProvisioningInfo_State_Failed       ProvisioningInfo_State = "FAILED"
	ProvisioningInfo_State_Deleting     ProvisioningInfo_State = "DELETING"
	ProvisioningInfo_State_Updating     ProvisioningInfo_State = "UPDATING"
	ProvisioningInfo_State_Degraded     ProvisioningInfo_State = "DEGRADED"
)

type ProvisioningPhase

type ProvisioningPhase string

The current phase of the data synchronization pipeline.

const (
	ProvisioningPhase_Unspecified ProvisioningPhase = ""
	// Ingestion phase of the synced table. This is when the synced table is
	// ingesting data from the delta table.
	ProvisioningPhase_ProvisioningPhaseMain ProvisioningPhase = "PROVISIONING_PHASE_MAIN"
	// Index scan phase of the synced table. This is when the synced table is
	// creating indexes on the ingested data.
	ProvisioningPhase_ProvisioningPhaseIndexScan ProvisioningPhase = "PROVISIONING_PHASE_INDEX_SCAN"
	// Index sort phase of the synced table. This is when the synced table is
	// creating indexes on the ingested data.
	ProvisioningPhase_ProvisioningPhaseIndexSort ProvisioningPhase = "PROVISIONING_PHASE_INDEX_SORT"
)

type RequestedClaims

type RequestedClaims struct {
	PermissionSet RequestedClaims_PermissionSet
	Resources     []RequestedResource
}

type RequestedClaims_PermissionSet

type RequestedClaims_PermissionSet string
const (
	RequestedClaims_PermissionSet_Unspecified RequestedClaims_PermissionSet = ""
	RequestedClaims_PermissionSet_ReadOnly    RequestedClaims_PermissionSet = "READ_ONLY"
)

type RequestedResource

type RequestedResource struct {
	ResourceName isRequestedResource_ResourceName
}

type RequestedResource_ResourceName_TableName

type RequestedResource_ResourceName_TableName struct {
	TableName string
}

RequestedResource_ResourceName_TableName selects TableName for RequestedResource.ResourceName. The full Unity Catalog table name.

type Role

type Role struct {
	// Output only. The full resource path of the role. Format:
	// projects/{project_id}/branches/{branch_id}/roles/{role_id}
	Name *string `fieldmask:"name"`
	// The Branch where this Role exists. Format:
	// projects/{project_id}/branches/{branch_id}
	Parent     *string     `fieldmask:"parent"`
	CreateTime *types.Time `fieldmask:"create_time"`
	UpdateTime *types.Time `fieldmask:"update_time"`
	// The spec contains the role configuration, including identity type,
	// authentication method, and role attributes.
	Spec *Role_RoleSpec `fieldmask:"spec"`
	// Current status of the role, including its identity type, authentication
	// method, and role attributes.
	Status *Role_RoleStatus `fieldmask:"status"`
	// The part of the name, chosen by the user when the resource was created.
	RoleId *string `fieldmask:"role_id"`
}

Role represents a Postgres role within a Branch..

type RoleOperationMetadata

type RoleOperationMetadata struct {
}

type Role_Attributes

type Role_Attributes struct {
	Createdb   *bool `fieldmask:"createdb"`
	Createrole *bool `fieldmask:"createrole"`
	Bypassrls  *bool `fieldmask:"bypassrls"`
}

Attributes that can be granted to a Postgres role. We are only implementing a subset for now, see xref: https://www.postgresql.org/docs/16/sql-createrole.html The values follow Postgres keyword naming e.g. CREATEDB, BYPASSRLS, etc. which is why they don't include typical underscores between words..

type Role_AuthMethod

type Role_AuthMethod string

How the role is authenticated when connecting to Postgres.

const (
	Role_AuthMethod_Unspecified Role_AuthMethod = ""
	// NO_LOGIN means this role cannot be used for interactive access
	Role_AuthMethod_NoLogin Role_AuthMethod = "NO_LOGIN"
	// PG_PASSWORD_SCRAM_SHA_256 is a password-based authentication
	Role_AuthMethod_PgPasswordScramSha256 Role_AuthMethod = "PG_PASSWORD_SCRAM_SHA_256"
	// LAKEBASE_OAUTH_V1 is for logging in with the managed identities like the
	// <Databricks> service principal, <Databricks> Group or <Databricks> user.
	Role_AuthMethod_LakebaseOauthV1 Role_AuthMethod = "LAKEBASE_OAUTH_V1"
)

type Role_IdentityType

type Role_IdentityType string

The type of the <Databricks> managed identity that this Role represents. Leave empty if you wish to create a regular Postgres role not associated with a <Databricks> identity.

const (
	Role_IdentityType_Unspecified Role_IdentityType = ""
	// A user in a <Databricks> workspace.
	Role_IdentityType_User Role_IdentityType = "USER"
	// A service principal in a <Databricks> workspace.
	Role_IdentityType_ServicePrincipal Role_IdentityType = "SERVICE_PRINCIPAL"
	// A group in a <Databricks> workspace.
	Role_IdentityType_Group Role_IdentityType = "GROUP"
)

type Role_MembershipRole

type Role_MembershipRole string

Roles that the DatabaseInstanceRole can be a member of.

const (
	Role_MembershipRole_Unspecified Role_MembershipRole = ""
	// Indicates membership in DATABRICKS_SUPERUSER, the highest set of privileges
	// exposed to customers.
	Role_MembershipRole_DatabricksSuperuser Role_MembershipRole = "DATABRICKS_SUPERUSER"
)

type Role_RoleSpec

type Role_RoleSpec struct {
	// An enum value for a standard role that this role is a member of.
	MembershipRoles []Role_MembershipRole `fieldmask:"membership_roles"`
	// The type of role. When specifying a managed-identity, the chosen role_id must
	// be a valid:
	//
	// * application ID for SERVICE_PRINCIPAL * user email for USER * group name for
	// GROUP
	IdentityType Role_IdentityType `fieldmask:"identity_type"`
	// The desired API-exposed Postgres role attribute to associate with the role.
	// Optional.
	Attributes *Role_Attributes `fieldmask:"attributes"`
	// Controls how the Postgres role authenticates when a client opens a database
	// connection. Supported values:
	//
	// * LAKEBASE_OAUTH_V1: the role authenticates by presenting a Databricks OAuth
	// access token derived from the backing managed identity (the <Databricks>
	// user, service principal, or group named by the role's `postgres_role`). No
	// static password exists for roles using this method. *
	// PG_PASSWORD_SCRAM_SHA_256: the role authenticates with a Postgres password
	// verified server-side using the SCRAM-SHA-256 mechanism. Lakebase generates a
	// password for the role. * NO_LOGIN: the role cannot open a Postgres session at
	// all. Useful for roles that exist only to own objects or to aggregate
	// privileges that are then granted to other, loginable roles.
	//
	// If auth_method is left unspecified, a meaningful authentication method is
	// derived from the identity_type: * For the managed identities, OAUTH is used.
	// * For the regular postgres roles, authentication based on postgres passwords
	// is used.
	//
	// NOTE: for the <Databricks> identity type GROUP, LAKEBASE_OAUTH_V1 is the
	// default auth method (group can login as well).
	AuthMethod Role_AuthMethod `fieldmask:"auth_method"`
	// The name of the Postgres role.
	//
	// This expects a valid Postgres identifier as specified in the link below.
	// https://www.postgresql.org/docs/current/sql-syntax-lexical.html#SQL-SYNTAX-IDENTIFIERS
	//
	// Required when creating the Role.
	//
	// If you wish to create a Postgres Role backed by a managed <Databricks>
	// identity, then postgres_role must be one of the following:
	//
	// 1. user email for IdentityType.USER 2. app ID for
	// IdentityType.SERVICE_PRINCIPAL 2. group name for IdentityType.GROUP
	PostgresRole *string `fieldmask:"postgres_role"`
}

type Role_RoleStatus

type Role_RoleStatus struct {
	// An enum value for a standard role that this role is a member of.
	MembershipRoles []Role_MembershipRole `fieldmask:"membership_roles"`
	// The type of the role.
	IdentityType Role_IdentityType `fieldmask:"identity_type"`
	// The PG role attributes associated with the role.
	Attributes *Role_Attributes `fieldmask:"attributes"`
	AuthMethod Role_AuthMethod  `fieldmask:"auth_method"`
	// The name of the Postgres role.
	PostgresRole *string `fieldmask:"postgres_role"`
	// Part of the resource name.
	RoleId *string `fieldmask:"role_id"`
}

type ScheduleCadence

type ScheduleCadence struct {
	// The recurrence pattern. Exactly one arm must be set; an unset cadence is
	// rejected with INVALID_PARAMETER_VALUE.
	Schedule isScheduleCadence_Schedule
	// How long snapshots from this cadence are kept before automatic deletion. Must
	// be at least 1 hour. Applied when a snapshot is taken; not retroactive, so
	// changing it affects only later snapshots.
	Retention *types.Duration
}

One cadence at which automatic snapshots are taken..

type ScheduleCadence_Schedule_DailySchedule

type ScheduleCadence_Schedule_DailySchedule struct {
	DailySchedule DailySchedule
}

ScheduleCadence_Schedule_DailySchedule selects DailySchedule for ScheduleCadence.Schedule. Take a snapshot once per day.

type ScheduleCadence_Schedule_MonthlySchedule

type ScheduleCadence_Schedule_MonthlySchedule struct {
	MonthlySchedule MonthlySchedule
}

ScheduleCadence_Schedule_MonthlySchedule selects MonthlySchedule for ScheduleCadence.Schedule. Take a snapshot once per month.

type ScheduleCadence_Schedule_WeeklySchedule

type ScheduleCadence_Schedule_WeeklySchedule struct {
	WeeklySchedule WeeklySchedule
}

ScheduleCadence_Schedule_WeeklySchedule selects WeeklySchedule for ScheduleCadence.Schedule. Take a snapshot once per week.

type Snapshot

type Snapshot struct {
	// The resource name of the snapshot. Format:
	// projects/{project_id}/snapshots/{snapshot_id}
	Name *string
	// Unique system-generated ID for the snapshot.
	Uid *string
	// When the snapshot was created.
	CreateTime *types.Time
	// Client-provided configuration of the snapshot.
	Spec *SnapshotSpec
	// Server-observed state of the snapshot.
	Status *SnapshotStatus
	// The user-chosen ID; the final segment of `name`.
	SnapshotId *string
}

An immutable, point-in-time copy of a branch's data within a project. It remains available after the source branch is deleted..

type SnapshotOperationMetadata

type SnapshotOperationMetadata struct {
}

Metadata for the long-running snapshot Create and Delete operations..

type SnapshotSchedule

type SnapshotSchedule struct {
	// The resource name of the branch's snapshot schedule. Format:
	// projects/{project_id}/branches/{branch_id}/snapshot-schedule
	Name *string `fieldmask:"name"`
	// The cadences at which automatic snapshots are taken. Update replaces the
	// whole set; an empty set disables automatic snapshots. Order is not
	// significant. When several cadences fire together, one snapshot is taken,
	// retained for the longest of their retentions.
	Schedule []ScheduleCadence `fieldmask:"schedule"`
}

The automatic snapshot cadences for a branch. There is exactly one schedule per branch (singleton); it is configured in place, not created or deleted.

Name: projects/{project_id}/branches/{branch_id}/snapshot-schedule.

type SnapshotScheduleOperationMetadata

type SnapshotScheduleOperationMetadata struct {
}

Metadata for the long-running snapshot schedule Update operation..

type SnapshotSpec

type SnapshotSpec struct {
	// The source branch to snapshot. Format:
	// projects/{project_id}/branches/{branch_id}
	SourceBranch *string
	// The point in time to snapshot from. If unset, the current head of the source
	// branch is used. The chosen LSN or timestamp must fall within the project's
	// point-in-time-recovery window (its history_retention_duration); otherwise the
	// request returns INVALID_PARAMETER_VALUE.
	PointInTime isSnapshotSpec_PointInTime
	// Expiration policy. If unset, the snapshot is kept until deleted.
	Expiration isSnapshotSpec_Expiration
}

Client-provided configuration of the snapshot..

type SnapshotSpec_Expiration_ExpireTime

type SnapshotSpec_Expiration_ExpireTime struct {
	ExpireTime types.Time
}

SnapshotSpec_Expiration_ExpireTime selects ExpireTime for SnapshotSpec.Expiration. Absolute time at which the snapshot is deleted. Mutually exclusive with `ttl` and `no_expiry`.

type SnapshotSpec_Expiration_NoExpiry

type SnapshotSpec_Expiration_NoExpiry struct {
	NoExpiry bool
}

SnapshotSpec_Expiration_NoExpiry selects NoExpiry for SnapshotSpec.Expiration. If true, the snapshot never expires. Mutually exclusive with `ttl` and `expire_time`.

type SnapshotSpec_Expiration_Ttl

type SnapshotSpec_Expiration_Ttl struct {
	Ttl types.Duration
}

SnapshotSpec_Expiration_Ttl selects Ttl for SnapshotSpec.Expiration. Time-to-live. The snapshot expires this long after it is created. Mutually exclusive with `expire_time` and `no_expiry`. Reads report the resolved absolute `expire_time` instead.

type SnapshotSpec_PointInTime_SourceBranchLsn

type SnapshotSpec_PointInTime_SourceBranchLsn struct {
	SourceBranchLsn string
}

SnapshotSpec_PointInTime_SourceBranchLsn selects SourceBranchLsn for SnapshotSpec.PointInTime. LSN to snapshot from, e.g. `16/B374D848`. Mutually exclusive with `source_branch_time`.

type SnapshotSpec_PointInTime_SourceBranchTime

type SnapshotSpec_PointInTime_SourceBranchTime struct {
	SourceBranchTime types.Time
}

SnapshotSpec_PointInTime_SourceBranchTime selects SourceBranchTime for SnapshotSpec.PointInTime. Timestamp to snapshot from. Mutually exclusive with `source_branch_lsn`.

type SnapshotStatus

type SnapshotStatus struct {
	// The source branch the snapshot was taken from. Format:
	// projects/{project_id}/branches/{branch_id}
	SourceBranch *string
	// Observed expiration state of the snapshot.
	Expiration isSnapshotStatus_Expiration
	// Full logical size of the snapshot, in bytes.
	FullSizeBytes *int64
	// Incremental storage size in bytes since the previous snapshot. Unset when the
	// snapshot is not billed on incremental usage.
	DiffSizeBytes *int64
}

Server-observed state of a snapshot..

type SnapshotStatus_Expiration_ExpireTime

type SnapshotStatus_Expiration_ExpireTime struct {
	ExpireTime types.Time
}

SnapshotStatus_Expiration_ExpireTime selects ExpireTime for SnapshotStatus.Expiration. Absolute time at which the snapshot is deleted.

type SnapshotStatus_Expiration_NoExpiry

type SnapshotStatus_Expiration_NoExpiry struct {
	NoExpiry bool
}

SnapshotStatus_Expiration_NoExpiry selects NoExpiry for SnapshotStatus.Expiration. True if the snapshot never expires.

type SyncedTable

type SyncedTable struct {
	// Output only. The Full resource name of the synced table in Postgres where
	// (catalog, schema, table) are the UC entity names.
	//
	// Format "synced_tables/{catalog}.{schema}.{table}"
	//
	// For the corresponding source table in the Unity catalog look for the
	// "source_table_full_name" attribute.
	Name *string
	// The Unity Catalog table ID for this synced table.
	Uid *string
	// Configuration details of the synced table, such as the source table,
	// scheduling policy, etc. This attribute is specified at creation time and most
	// fields are returned as is on subsequent queries.
	Spec *SyncedTable_SyncedTableSpec
	// Synced Table data synchronization status.
	Status     *SyncedTable_SyncedTableStatus
	CreateTime *types.Time
	// The part of the name, chosen by the user when the resource was created.
	SyncedTableId *string
}

type SyncedTableOperationMetadata

type SyncedTableOperationMetadata struct {
}

Metadata for SyncedTable long-running operations..

type SyncedTablePipelineProgress

type SyncedTablePipelineProgress struct {
	// The source table Delta version that was last processed by the pipeline. The
	// pipeline may not have completely processed this version yet.
	LatestVersionCurrentlyProcessing *int64
	// The number of rows that have been synced in this update.
	SyncedRowCount *int64
	// The total number of rows that need to be synced in this update. This number
	// may be an estimate.
	TotalRowCount *int64
	// The completion ratio of this update. This is a number between 0 and 1.
	SyncProgressCompletion *float64
	// The estimated time remaining to complete this update in seconds.
	EstimatedCompletionTimeSeconds *float64
}

Progress information of the Synced Table data synchronization pipeline..

type SyncedTablePosition

type SyncedTablePosition struct {
	// The starting timestamp of the most recent successful synchronization from the
	// source table to the destination (synced) table. Note this is the starting
	// timestamp of the sync operation, not the end time. E.g., for a batch, this is
	// the time when the sync operation started.
	SyncStartTime *types.Time
	// The end timestamp of the most recent successful synchronization. This is the
	// time when the data is available in the synced table.
	SyncEndTime *types.Time
	// Information about the source system at the time of the last sync.
	SourceSyncInfo isSyncedTablePosition_SourceSyncInfo
}

type SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo

type SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo struct {
	DeltaTableSyncInfo DeltaTableSyncInfo
}

SyncedTablePosition_SourceSyncInfo_DeltaTableSyncInfo selects DeltaTableSyncInfo for SyncedTablePosition.SourceSyncInfo.

type SyncedTableState

type SyncedTableState string

The state of a synced table.

const (
	SyncedTableState_Unspecified SyncedTableState = ""
	// The synced table has just been created and resources are being provisioned.
	// This is also the catch-all state if there is not a more suitable state to
	// report for the synced table.
	SyncedTableState_SyncedTableProvisioning SyncedTableState = "SYNCED_TABLE_PROVISIONING"
	// The synced table is provisioning resources for the data synchronization
	// pipeline.
	SyncedTableState_SyncedTableProvisioningPipelineResources SyncedTableState = "SYNCED_TABLE_PROVISIONING_PIPELINE_RESOURCES"
	// The synced table is executing the initial data synchronization.
	SyncedTableState_SyncedTableProvisioningInitialSnapshot SyncedTableState = "SYNCED_TABLE_PROVISIONING_INITIAL_SNAPSHOT"
	// The synced table is ready to serve data.
	SyncedTableState_SyncedTableOnline SyncedTableState = "SYNCED_TABLE_ONLINE"
	// The synced table is ready to serve data and is continuously updating. Only
	// shown for synced tables using the "Continuous" sync mode.
	SyncedTableState_SyncedTableOnlineContinuousUpdate SyncedTableState = "SYNCED_TABLE_ONLINE_CONTINUOUS_UPDATE"
	// The synced table is ready to serve data and an active update is in progress.
	// Only shown for synced tables using the "Triggered" sync mode.
	SyncedTableState_SyncedTableOnlineTriggeredUpdate SyncedTableState = "SYNCED_TABLE_ONLINE_TRIGGERED_UPDATE"
	// The synced table is ready to serve data and there are no active updates. Only
	// shown for synced tables using the "Triggered" sync mode.
	SyncedTableState_SyncedTableOnlineNoPendingUpdate SyncedTableState = "SYNCED_TABLE_ONLINE_NO_PENDING_UPDATE"
	// The synced table has encountered an internal error and is not available for
	// serving.
	SyncedTableState_SyncedTableOffline SyncedTableState = "SYNCED_TABLE_OFFLINE"
	// The synced table is not available for serving because the data
	// synchronization pipeline has failed. Please review the pipeline event logs to
	// troubleshoot.
	SyncedTableState_SyncedTableOfflineFailed SyncedTableState = "SYNCED_TABLE_OFFLINE_FAILED"
	// The data synchronization pipeline has encountered an error but the synced
	// table is still available for serving (potentially stale) data. Please review
	// the pipeline event logs to troubleshoot.
	SyncedTableState_SyncedTableOnlinePipelineFailed SyncedTableState = "SYNCED_TABLE_ONLINE_PIPELINE_FAILED"
	// The synced table is available for serving, and is provisioning resources for
	// a newly started data synchronization pipeline.
	SyncedTableState_SyncedTableOnlineUpdatingPipelineResources SyncedTableState = "SYNCED_TABLE_ONLINE_UPDATING_PIPELINE_RESOURCES"
)

type SyncedTable_SyncedTableSpec

type SyncedTable_SyncedTableSpec struct {
	// The Postgres database name where the synced table will be created in.
	//
	// If this synced table is created inside a Lakebase Catalog, this attribute can
	// be omitted on creation and is inferred from the postgres_database associated
	// with the Lakebase Catalog. If specified when inside a Lakebase Catalog, the
	// value must match.
	//
	// A value must be specified when creating a synced table inside a Standard
	// Catalog.
	PostgresDatabase *string
	// The full resource name the branch associated with the table.
	//
	// Format: "projects/{project_id}/branches/{branch_id}".
	Branch *string
	// Scheduling policy of the underlying pipeline.
	SchedulingPolicy SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy
	// Three-part (catalog, schema, table) name of the source Delta table.
	//
	// For the corresponding destination table, use any of the two:
	//
	// * synced_table_id used at the creation of the SyncedTable * "name" consisting
	// of "synced_tables/" prefix and the full name of the destination table.
	SourceTableFullName *string
	// Primary Key columns to be used for data insert/update in the destination.
	PrimaryKeyColumns []string
	// Time series key to deduplicate (tie-break) rows with the same primary key.
	TimeseriesKey *string
	// ID of an existing pipeline to bin-pack this synced table into. At most one of
	// existing_pipeline_id and new_pipeline_spec should be defined.
	//
	// The pipeline used for the synced table is returned via the top level
	// pipeline_id attribute.
	ExistingPipelineId *string
	// If true, the synced table's logical database and schema resources in PG will
	// be created if they do not already exist. The request will fail if this is
	// false and the database/schema do not exist.
	//
	// Defaults to true if omitted.
	CreateDatabaseObjectsIfMissing *bool
	// Specification for creating a new pipeline. At most one of
	// existing_pipeline_id and new_pipeline_spec should be defined.
	//
	// The pipeline used for the synced table is returned via the top level
	// pipeline_id attribute.
	NewPipelineSpec *NewPipelineSpec
	// When true, enables accelerated sync mode for the initial data load. This
	// significantly improves performance for large tables. Requires workspace-level
	// enablement through Lakebase Accelerated Sync preview.
	AcceleratedSync *bool
	// Override the default Delta->PG type mapping for specific columns. A
	// TypeOverride with PG_SPECIFIC_TYPE_UNSPECIFIED is rejected; a valid pg_type
	// must be set.
	TypeOverrides []SyncedTable_SyncedTableSpec_TypeOverride
	// Extra PostgreSQL-only columns to add to the synced table.
	ExtraColumns []SyncedTable_SyncedTableSpec_ExtraColumn
}

type SyncedTable_SyncedTableSpec_ExtraColumn

type SyncedTable_SyncedTableSpec_ExtraColumn struct {
	// Name of the column.
	ColumnName *string
	// PostgreSQL type of the column, for example "tsvector" or "vector(1024)".
	ColumnType  *string
	Maintenance SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance
	// SQL expression used to compute the column's value, for example
	// "to_tsvector('english', content)".
	Compute *string
}

An extra PostgreSQL column to add to the synced table..

type SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance

type SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance string

How the column's value is populated and kept up to date.

const (
	SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance_Unspecified SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance = ""
	// The value is computed by PostgreSQL and stored.
	SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance_StoredGenerated SyncedTable_SyncedTableSpec_ExtraColumn_Maintenance = "STORED_GENERATED"
)

type SyncedTable_SyncedTableSpec_PgSpecificType

type SyncedTable_SyncedTableSpec_PgSpecificType string

PostgreSQL-specific target types that can override the default Delta-to-PG mapping.

const (
	SyncedTable_SyncedTableSpec_PgSpecificType_Unspecified SyncedTable_SyncedTableSpec_PgSpecificType = ""
	// Maps the column to the pgvector vector type.
	SyncedTable_SyncedTableSpec_PgSpecificType_PgSpecificTypeVector SyncedTable_SyncedTableSpec_PgSpecificType = "PG_SPECIFIC_TYPE_VECTOR"
	// Maps the column to the pgvector half-precision halfvec type.
	SyncedTable_SyncedTableSpec_PgSpecificType_PgSpecificTypeHalfvec SyncedTable_SyncedTableSpec_PgSpecificType = "PG_SPECIFIC_TYPE_HALFVEC"
	// Maps the column to a length-bounded character varying(N) type.
	SyncedTable_SyncedTableSpec_PgSpecificType_PgSpecificTypeVarchar SyncedTable_SyncedTableSpec_PgSpecificType = "PG_SPECIFIC_TYPE_VARCHAR"
)

type SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy

type SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy string

Scheduling policy of the synced table's underlying pipeline.

const (
	SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy_Unspecified SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy = ""
	// Pipeline runs continuously after generating the initial data. Requires the
	// source table to have Change Data Feed (CDF) enabled.
	SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy_Continuous SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy = "CONTINUOUS"
	// Pipeline stops after generating the initial data and can be triggered later
	// (manually, through a cron job or through data triggers). Requires the source
	// table to have Change Data Feed (CDF) enabled.
	SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy_Triggered SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy = "TRIGGERED"
	// Pipeline stops after generating the initial data and can be triggered later
	// (manually, through a cron job or through data triggers). Successive updates
	// always perform a full copy of the source table data (no incremental updates).
	// Does not require the source table to have Change Data Feed (CDF) enabled.
	SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy_Snapshot SyncedTable_SyncedTableSpec_SyncedTableSchedulingPolicy = "SNAPSHOT"
)

type SyncedTable_SyncedTableSpec_TypeOverride

type SyncedTable_SyncedTableSpec_TypeOverride struct {
	// Name of the source column whose target PostgreSQL type should be overridden.
	ColumnName *string
	// PostgreSQL-specific target type to use for the column.
	PgType SyncedTable_SyncedTableSpec_PgSpecificType
	// Size parameter for the target type, for types that take one (e.g. vector
	// dimension, varchar length). Required when the chosen pg_type needs a size.
	Size *int
}

Overrides the default Delta-to-PostgreSQL type mapping for a single column..

type SyncedTable_SyncedTableStatus

type SyncedTable_SyncedTableStatus struct {
	// A text description of the current state of the synced table.
	Message *string
	// The state of the synced table.
	DetailedState SyncedTableState
	// Summary of the last successful synchronization from source to destination.
	LastSync            *SyncedTablePosition
	OngoingSyncProgress *SyncedTablePipelineProgress
	// The current phase of the data synchronization pipeline.
	ProvisioningPhase ProvisioningPhase
	// The last source table Delta version that was successfully synced to the
	// synced table.
	LastProcessedCommitVersion *int64
	// The end timestamp of the last time any data was synchronized from the source
	// table to the synced table. This is when the data is available in the synced
	// table.
	LastSyncTime *types.Time
	// ID of the associated pipeline.
	PipelineId *string
	// The provisioning state of the synced table entity in Unity Catalog.
	UnityCatalogProvisioningState ProvisioningInfo_State
	// The full resource name of the project associated with the table.
	//
	// Format: "projects/{project_id}".
	Project *string
}

type UndeleteBranchOperation

type UndeleteBranchOperation struct {
	// contains filtered or unexported fields
}

UndeleteBranchOperation tracks the state of the long-running operation started by UndeleteBranch.

func (*UndeleteBranchOperation) Done

func (o *UndeleteBranchOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UndeleteBranchOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UndeleteBranchOperation) Name

func (o *UndeleteBranchOperation) Name() *string

Name returns the server-assigned operation name.

func (*UndeleteBranchOperation) Wait

func (o *UndeleteBranchOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type UndeleteBranchRequest

type UndeleteBranchRequest struct {
	// The full resource path of the branch to undelete. Format:
	// projects/{project_id}/branches/{branch_id}
	Name *string
}

type UndeleteProjectOperation

type UndeleteProjectOperation struct {
	// contains filtered or unexported fields
}

UndeleteProjectOperation tracks the state of the long-running operation started by UndeleteProject.

func (*UndeleteProjectOperation) Done

func (o *UndeleteProjectOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UndeleteProjectOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UndeleteProjectOperation) Name

func (o *UndeleteProjectOperation) Name() *string

Name returns the server-assigned operation name.

func (*UndeleteProjectOperation) Wait

func (o *UndeleteProjectOperation) Wait(ctx context.Context, opts ...lro.Option) error

Wait polls the operation until it completes.

type UndeleteProjectRequest

type UndeleteProjectRequest struct {
	// The full resource path of the project to undelete. Format:
	// projects/{project_id}
	Name *string
}

Request to restore a soft-deleted project within its retention period..

type UpdateBranchOperation

type UpdateBranchOperation struct {
	// contains filtered or unexported fields
}

UpdateBranchOperation tracks the state of the long-running operation started by UpdateBranch.

func (*UpdateBranchOperation) Done

func (o *UpdateBranchOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UpdateBranchOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateBranchOperation) Name

func (o *UpdateBranchOperation) Name() *string

Name returns the server-assigned operation name.

func (*UpdateBranchOperation) Wait

func (o *UpdateBranchOperation) Wait(ctx context.Context, opts ...lro.Option) (*Branch, error)

Wait polls the operation until it completes.

type UpdateBranchRequest

type UpdateBranchRequest struct {
	// The Branch to update.
	//
	// The branch's `name` field is used to identify the branch to update. Format:
	// projects/{project_id}/branches/{branch_id}
	Branch *Branch
	// The list of fields to update.
	UpdateMask *types.FieldMask[Branch]
}

type UpdateDataApiOperation

type UpdateDataApiOperation struct {
	// contains filtered or unexported fields
}

UpdateDataApiOperation tracks the state of the long-running operation started by UpdateDataApi.

func (*UpdateDataApiOperation) Done

func (o *UpdateDataApiOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UpdateDataApiOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateDataApiOperation) Name

func (o *UpdateDataApiOperation) Name() *string

Name returns the server-assigned operation name.

func (*UpdateDataApiOperation) Wait

func (o *UpdateDataApiOperation) Wait(ctx context.Context, opts ...lro.Option) (*DataApi, error)

Wait polls the operation until it completes.

type UpdateDataApiRequest

type UpdateDataApiRequest struct {
	// The Data API configuration to update. The data_api's `name` field identifies
	// the resource.
	DataApi *DataApi
	// The list of fields to update.
	UpdateMask *types.FieldMask[DataApi]
}

Update Data API configuration for a database..

type UpdateDatabaseOperation

type UpdateDatabaseOperation struct {
	// contains filtered or unexported fields
}

UpdateDatabaseOperation tracks the state of the long-running operation started by UpdateDatabase.

func (*UpdateDatabaseOperation) Done

func (o *UpdateDatabaseOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UpdateDatabaseOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateDatabaseOperation) Name

func (o *UpdateDatabaseOperation) Name() *string

Name returns the server-assigned operation name.

func (*UpdateDatabaseOperation) Wait

func (o *UpdateDatabaseOperation) Wait(ctx context.Context, opts ...lro.Option) (*Database, error)

Wait polls the operation until it completes.

type UpdateDatabaseRequest

type UpdateDatabaseRequest struct {
	// The Database to update.
	//
	// The database's `name` field is used to identify the database to update.
	// Format: projects/{project_id}/branches/{branch_id}/databases/{database_id}
	Database *Database
	// The list of fields to update.
	UpdateMask *types.FieldMask[Database]
}

type UpdateEndpointOperation

type UpdateEndpointOperation struct {
	// contains filtered or unexported fields
}

UpdateEndpointOperation tracks the state of the long-running operation started by UpdateEndpoint.

func (*UpdateEndpointOperation) Done

func (o *UpdateEndpointOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UpdateEndpointOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateEndpointOperation) Name

func (o *UpdateEndpointOperation) Name() *string

Name returns the server-assigned operation name.

func (*UpdateEndpointOperation) Wait

func (o *UpdateEndpointOperation) Wait(ctx context.Context, opts ...lro.Option) (*Endpoint, error)

Wait polls the operation until it completes.

type UpdateEndpointRequest

type UpdateEndpointRequest struct {
	// The Endpoint to update.
	//
	// The endpoint's `name` field is used to identify the endpoint to update.
	// Format: projects/{project_id}/branches/{branch_id}/endpoints/{endpoint_id}
	Endpoint *Endpoint
	// The list of fields to update.
	UpdateMask *types.FieldMask[Endpoint]
}

type UpdateProjectOperation

type UpdateProjectOperation struct {
	// contains filtered or unexported fields
}

UpdateProjectOperation tracks the state of the long-running operation started by UpdateProject.

func (*UpdateProjectOperation) Done

func (o *UpdateProjectOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UpdateProjectOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateProjectOperation) Name

func (o *UpdateProjectOperation) Name() *string

Name returns the server-assigned operation name.

func (*UpdateProjectOperation) Wait

func (o *UpdateProjectOperation) Wait(ctx context.Context, opts ...lro.Option) (*Project, error)

Wait polls the operation until it completes.

type UpdateProjectRequest

type UpdateProjectRequest struct {
	// The Project to update.
	//
	// The project's `name` field is used to identify the project to update. Format:
	// projects/{project_id}
	Project *Project
	// The list of fields to update.
	UpdateMask *types.FieldMask[Project]
}

type UpdateRoleOperation

type UpdateRoleOperation struct {
	// contains filtered or unexported fields
}

UpdateRoleOperation tracks the state of the long-running operation started by UpdateRole.

func (*UpdateRoleOperation) Done

func (o *UpdateRoleOperation) Done(ctx context.Context, opts ...call.Option) (bool, error)

Done refreshes the operation and reports whether it has completed.

func (*UpdateRoleOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateRoleOperation) Name

func (o *UpdateRoleOperation) Name() *string

Name returns the server-assigned operation name.

func (*UpdateRoleOperation) Wait

func (o *UpdateRoleOperation) Wait(ctx context.Context, opts ...lro.Option) (*Role, error)

Wait polls the operation until it completes.

type UpdateRoleRequest

type UpdateRoleRequest struct {
	// The Postgres Role to update.
	//
	// The role's `name` field is used to identify the role to update. Format:
	// projects/{project_id}/branches/{branch_id}/roles/{role_id}
	Role *Role
	// The list of fields to update.
	UpdateMask *types.FieldMask[Role]
}

type UpdateSnapshotScheduleOperation

type UpdateSnapshotScheduleOperation struct {
	// contains filtered or unexported fields
}

UpdateSnapshotScheduleOperation tracks the state of the long-running operation started by UpdateSnapshotSchedule.

func (*UpdateSnapshotScheduleOperation) Done

Done refreshes the operation and reports whether it has completed.

func (*UpdateSnapshotScheduleOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateSnapshotScheduleOperation) Name

Name returns the server-assigned operation name.

func (*UpdateSnapshotScheduleOperation) Wait

Wait polls the operation until it completes.

type UpdateSnapshotScheduleRequest

type UpdateSnapshotScheduleRequest struct {
	// The snapshot schedule to set. Its `name` identifies the branch. Format:
	// projects/{project_id}/branches/{branch_id}/snapshot-schedule
	SnapshotSchedule *SnapshotSchedule
	// Fields to update. The only updatable path is `schedule`, which replaces the
	// entire set of cadences.
	UpdateMask *types.FieldMask[SnapshotSchedule]
}

Request to set the snapshot schedule for a branch. Returns a completed long-running operation whose response is the persisted snapshot schedule..

type WeeklySchedule

type WeeklySchedule struct {
	// The day of the week on which to take the snapshot.
	DayOfWeek DayOfWeek
	// The hour of the day, in UTC, at which to take the snapshot, in [0, 23].
	Hour *int
}

Take a snapshot once per week, on the configured day at the configured hour..

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL