environments

type BaseEnvironmentType string

type CreateWorkspaceBaseEnvironmentOperationInterface interface {

	// Wait blocks until the long-running operation is completed. If no timeout is
	// specified, this will poll indefinitely. If a timeout is provided and the operation
	// didn't finish within the timeout, this function will return an error, otherwise
	// returns successful response and any errors encountered.
	Wait(ctx context.Context, opts ...api.Option) (*WorkspaceBaseEnvironment, error)

	// Name returns the name of the long-running operation. The name is assigned
	// by the server and is unique within the service from which the operation is created.
	Name() string

	// Metadata returns metadata associated with the long-running operation.
	// If the metadata is not available, the returned metadata and error are both nil.
	Metadata() (*WorkspaceBaseEnvironmentOperationMetadata, error)

	// Done reports whether the long-running operation has completed.
	Done() (bool, error)
}

type CreateWorkspaceBaseEnvironmentRequest struct {
	// A unique identifier for this request. A random UUID is recommended. This
	// request is only idempotent if a request_id is provided.
	RequestId string `json:"-" url:"request_id,omitempty"`
	// Required. The workspace base environment to create.
	WorkspaceBaseEnvironment WorkspaceBaseEnvironment `json:"workspace_base_environment"`
	// The ID to use for the workspace base environment, which will become the
	// final component of the resource name. This value should be 4-63
	// characters, and valid characters are /[a-z][0-9]-/.
	WorkspaceBaseEnvironmentId string `json:"-" url:"workspace_base_environment_id,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type DatabricksServiceExceptionWithDetailsProto struct {
	Details []json.RawMessage `json:"details,omitempty"`

	ErrorCode ErrorCode `json:"error_code,omitempty"`

	Message string `json:"message,omitempty"`

	StackTrace string `json:"stack_trace,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type DefaultWorkspaceBaseEnvironment struct {
	// The default workspace base environment for CPU compute. Format:
	// workspace-base-environments/{workspace_base_environment}
	CpuWorkspaceBaseEnvironment string `json:"cpu_workspace_base_environment,omitempty"`
	// The default workspace base environment for GPU compute. Format:
	// workspace-base-environments/{workspace_base_environment}
	GpuWorkspaceBaseEnvironment string `json:"gpu_workspace_base_environment,omitempty"`
	// The resource name of this singleton resource. Format:
	// default-workspace-base-environment
	Name string `json:"name,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type DeleteWorkspaceBaseEnvironmentRequest struct {
	// Required. The resource name of the workspace base environment to delete.
	// Format: workspace-base-environments/{workspace_base_environment}
	Name string `json:"-" url:"-"`
}

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

type EnvironmentsInterface interface {
	CreateWorkspaceBaseEnvironment(ctx context.Context, request CreateWorkspaceBaseEnvironmentRequest) (CreateWorkspaceBaseEnvironmentOperationInterface, error)

	// Deletes a WorkspaceBaseEnvironment. Deleting a base environment may impact
	// linked notebooks and jobs. This operation is irreversible and should be
	// performed only when you are certain the environment is no longer needed.
	DeleteWorkspaceBaseEnvironment(ctx context.Context, request DeleteWorkspaceBaseEnvironmentRequest) error

	// Gets the default WorkspaceBaseEnvironment configuration for the workspace.
	// Returns the current default base environment settings for both CPU and GPU
	// compute.
	GetDefaultWorkspaceBaseEnvironment(ctx context.Context, request GetDefaultWorkspaceBaseEnvironmentRequest) (*DefaultWorkspaceBaseEnvironment, error)

	// Gets the status of a long-running operation. Clients can use this method to
	// poll the operation result.
	GetOperation(ctx context.Context, request GetOperationRequest) (*Operation, error)

	// Retrieves a WorkspaceBaseEnvironment by its name.
	GetWorkspaceBaseEnvironment(ctx context.Context, request GetWorkspaceBaseEnvironmentRequest) (*WorkspaceBaseEnvironment, error)

	// Lists all WorkspaceBaseEnvironments in the workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListWorkspaceBaseEnvironments(ctx context.Context, request ListWorkspaceBaseEnvironmentsRequest) listing.Iterator[WorkspaceBaseEnvironment]

	// Lists all WorkspaceBaseEnvironments in the workspace.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListWorkspaceBaseEnvironmentsAll(ctx context.Context, request ListWorkspaceBaseEnvironmentsRequest) ([]WorkspaceBaseEnvironment, error)

	RefreshWorkspaceBaseEnvironment(ctx context.Context, request RefreshWorkspaceBaseEnvironmentRequest) (RefreshWorkspaceBaseEnvironmentOperationInterface, error)

	// Updates the default WorkspaceBaseEnvironment configuration for the workspace.
	// Sets the specified base environments as the workspace defaults for CPU and/or
	// GPU compute.
	UpdateDefaultWorkspaceBaseEnvironment(ctx context.Context, request UpdateDefaultWorkspaceBaseEnvironmentRequest) (*DefaultWorkspaceBaseEnvironment, error)

	UpdateWorkspaceBaseEnvironment(ctx context.Context, request UpdateWorkspaceBaseEnvironmentRequest) (UpdateWorkspaceBaseEnvironmentOperationInterface, error)
}

type ErrorCode string

type GetDefaultWorkspaceBaseEnvironmentRequest struct {
	// A static resource name of the default workspace base environment. Format:
	// default-workspace-base-environment
	Name string `json:"-" url:"-"`
}

type GetOperationRequest struct {
	// The name of the operation resource.
	Name string `json:"-" url:"-"`
}

type GetWorkspaceBaseEnvironmentRequest struct {
	// Required. The resource name of the workspace base environment to
	// retrieve. Format:
	// workspace-base-environments/{workspace_base_environment}
	Name string `json:"-" url:"-"`
}

type ListWorkspaceBaseEnvironmentsRequest struct {
	// The maximum number of environments to return per page. Default is 1000.
	PageSize int `json:"-" url:"page_size,omitempty"`
	// Page token for pagination. Received from a previous
	// ListWorkspaceBaseEnvironments call.
	PageToken string `json:"-" url:"page_token,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type ListWorkspaceBaseEnvironmentsResponse struct {
	// Token to retrieve the next page of results. Empty if there are no more
	// results.
	NextPageToken string `json:"next_page_token,omitempty"`
	// The list of workspace base environments.
	WorkspaceBaseEnvironments []WorkspaceBaseEnvironment `json:"workspace_base_environments,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type Operation struct {
	// 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 `json:"done,omitempty"`
	// The error result of the operation in case of failure or cancellation.
	Error *DatabricksServiceExceptionWithDetailsProto `json:"error,omitempty"`
	// 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 `json:"metadata,omitempty"`
	// 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 `json:"name,omitempty"`
	// The normal, successful response of the operation.
	Response json.RawMessage `json:"response,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type RefreshWorkspaceBaseEnvironmentOperationInterface interface {

	// Wait blocks until the long-running operation is completed. If no timeout is
	// specified, this will poll indefinitely. If a timeout is provided and the operation
	// didn't finish within the timeout, this function will return an error, otherwise
	// returns successful response and any errors encountered.
	Wait(ctx context.Context, opts ...api.Option) (*WorkspaceBaseEnvironment, error)

	// Name returns the name of the long-running operation. The name is assigned
	// by the server and is unique within the service from which the operation is created.
	Name() string

	// Metadata returns metadata associated with the long-running operation.
	// If the metadata is not available, the returned metadata and error are both nil.
	Metadata() (*WorkspaceBaseEnvironmentOperationMetadata, error)

	// Done reports whether the long-running operation has completed.
	Done() (bool, error)
}

type RefreshWorkspaceBaseEnvironmentRequest struct {
	// Required. The resource name of the workspace base environment to delete.
	// Format: workspace-base-environments/{workspace_base_environment}
	Name string `json:"-" url:"-"`
}

type UpdateDefaultWorkspaceBaseEnvironmentRequest struct {
	// Required. The default workspace base environment configuration to update.
	DefaultWorkspaceBaseEnvironment DefaultWorkspaceBaseEnvironment `json:"default_workspace_base_environment"`
	// The resource name of this singleton resource. Format:
	// default-workspace-base-environment
	Name string `json:"-" url:"-"`
	// Field mask specifying which fields to update. Use comma as the separator
	// for multiple fields (no space). The special value '*' indicates that all
	// fields should be updated (full replacement). Valid field paths:
	// cpu_workspace_base_environment, gpu_workspace_base_environment
	//
	// To unset one or both defaults, include the field path(s) in the mask and
	// omit them from the request body. To unset both, you must list both paths
	// explicitly — the wildcard '*' cannot be used to unset fields.
	UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}

type UpdateWorkspaceBaseEnvironmentOperationInterface interface {

	// Wait blocks until the long-running operation is completed. If no timeout is
	// specified, this will poll indefinitely. If a timeout is provided and the operation
	// didn't finish within the timeout, this function will return an error, otherwise
	// returns successful response and any errors encountered.
	Wait(ctx context.Context, opts ...api.Option) (*WorkspaceBaseEnvironment, error)

	// Name returns the name of the long-running operation. The name is assigned
	// by the server and is unique within the service from which the operation is created.
	Name() string

	// Metadata returns metadata associated with the long-running operation.
	// If the metadata is not available, the returned metadata and error are both nil.
	Metadata() (*WorkspaceBaseEnvironmentOperationMetadata, error)

	// Done reports whether the long-running operation has completed.
	Done() (bool, error)
}

type UpdateWorkspaceBaseEnvironmentRequest struct {
	Name string `json:"-" url:"-"`
	// Required. The workspace base environment with updated fields. The name
	// field is used to identify the environment to update.
	WorkspaceBaseEnvironment WorkspaceBaseEnvironment `json:"workspace_base_environment"`
}

type WorkspaceBaseEnvironment struct {
	// The type of base environment (CPU or GPU).
	BaseEnvironmentType BaseEnvironmentType `json:"base_environment_type,omitempty"`
	// Timestamp when the environment was created.
	CreateTime *time.Time `json:"create_time,omitempty"`
	// User ID of the creator.
	CreatorUserId string `json:"creator_user_id,omitempty"`
	// Human-readable display name for the workspace base environment.
	DisplayName string `json:"display_name"`
	// The WSFS or UC Volumes path to the environment YAML file.
	Filepath string `json:"filepath,omitempty"`
	// Whether this is the default environment for the workspace.
	IsDefault bool `json:"is_default,omitempty"`
	// User ID of the last user who updated the environment.
	LastUpdatedUserId string `json:"last_updated_user_id,omitempty"`
	// Status message providing additional details about the environment status.
	Message string `json:"message,omitempty"`
	// The resource name of the workspace base environment. Format:
	// workspace-base-environments/{workspace-base-environment}
	Name string `json:"name,omitempty"`
	// The status of the materialized workspace base environment.
	Status WorkspaceBaseEnvironmentCacheStatus `json:"status,omitempty"`
	// Timestamp when the environment was last updated.
	UpdateTime *time.Time `json:"update_time,omitempty"`

	ForceSendFields []string `json:"-" url:"-"`
}

type WorkspaceBaseEnvironmentCacheStatus string

type WorkspaceBaseEnvironmentOperationMetadata struct {
}