environments

package
v0.0.1-dev.2 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 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 BaseEnvironmentType

type BaseEnvironmentType string

If changed, also update estore/namespaces/defaultbaseenvironments/latest.proto

const (
	BaseEnvironmentType_Unspecified BaseEnvironmentType = ""
	BaseEnvironmentType_Cpu         BaseEnvironmentType = "CPU"
	BaseEnvironmentType_Gpu         BaseEnvironmentType = "GPU"
)

type Client

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

func NewClient

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

func (*Client) CreateWorkspaceBaseEnvironment

func (c *Client) CreateWorkspaceBaseEnvironment(ctx context.Context, req CreateWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*CreateWorkspaceBaseEnvironmentOperation, error)

Creates a new WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously generate a materialized environment to optimize dependency resolution and is only marked as done when the materialized environment has been successfully generated or has failed.

func (*Client) DeleteWorkspaceBaseEnvironment

func (c *Client) DeleteWorkspaceBaseEnvironment(ctx context.Context, req DeleteWorkspaceBaseEnvironmentRequest, opts ...call.Option) 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.

func (*Client) GetDefaultWorkspaceBaseEnvironment

func (c *Client) GetDefaultWorkspaceBaseEnvironment(ctx context.Context, req GetDefaultWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*DefaultWorkspaceBaseEnvironment, error)

Gets the default WorkspaceBaseEnvironment configuration for the workspace. Returns the current default base environment settings for both CPU and GPU compute.

func (*Client) GetWorkspaceBaseEnvironment

func (c *Client) GetWorkspaceBaseEnvironment(ctx context.Context, req GetWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*WorkspaceBaseEnvironment, error)

Retrieves a WorkspaceBaseEnvironment by its name.

func (*Client) ListWorkspaceBaseEnvironments

func (c *Client) ListWorkspaceBaseEnvironments(ctx context.Context, req ListWorkspaceBaseEnvironmentsRequest, opts ...call.Option) (*ListWorkspaceBaseEnvironmentsResponse, error)

Lists all WorkspaceBaseEnvironments in the workspace.

<Databricks> provides the following base environments:

- `workspace-base-environments/databricks_ai_...`: includes popular AI and deep learning packages for serverless GPU compute. - `workspace-base-environments/databricks_ml_...`: includes popular ML packages for serverless compute.

Databricks-provided base environments are versioned. For example, `workspace-base-environments/databricks_ml_v5` corresponds to the ML environment built on environment version 5.

func (*Client) ListWorkspaceBaseEnvironmentsIter

func (c *Client) ListWorkspaceBaseEnvironmentsIter(ctx context.Context, req ListWorkspaceBaseEnvironmentsRequest, opts ...call.Option) iter.Seq2[*WorkspaceBaseEnvironment, error]

ListWorkspaceBaseEnvironmentsIter returns an iterator that iterates over the results of ListWorkspaceBaseEnvironments.

For example:

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

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

Callers who need custom pagination logic should use ListWorkspaceBaseEnvironments directly.

func (*Client) RefreshWorkspaceBaseEnvironment

func (c *Client) RefreshWorkspaceBaseEnvironment(ctx context.Context, req RefreshWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*RefreshWorkspaceBaseEnvironmentOperation, error)

Refreshes the materialized environment for a WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has failed. The existing materialized environment remains available until it expires.

func (*Client) UpdateDefaultWorkspaceBaseEnvironment

func (c *Client) UpdateDefaultWorkspaceBaseEnvironment(ctx context.Context, req UpdateDefaultWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*DefaultWorkspaceBaseEnvironment, error)

Updates the default WorkspaceBaseEnvironment configuration for the workspace. Sets the specified base environments as the workspace defaults for CPU and/or GPU compute.

func (*Client) UpdateWorkspaceBaseEnvironment

func (c *Client) UpdateWorkspaceBaseEnvironment(ctx context.Context, req UpdateWorkspaceBaseEnvironmentRequest, opts ...call.Option) (*UpdateWorkspaceBaseEnvironmentOperation, error)

Updates an existing WorkspaceBaseEnvironment. This is a long-running operation. The operation will asynchronously regenerate the materialized environment and is only marked as done when the materialized environment has been successfully generated or has failed. The existing materialized environment remains available until it expires.

type CreateWorkspaceBaseEnvironmentOperation

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

CreateWorkspaceBaseEnvironmentOperation tracks the state of the long-running operation started by CreateWorkspaceBaseEnvironment.

func (*CreateWorkspaceBaseEnvironmentOperation) Done

Done refreshes the operation and reports whether it has completed.

func (*CreateWorkspaceBaseEnvironmentOperation) Metadata

Metadata returns metadata associated with the operation.

func (*CreateWorkspaceBaseEnvironmentOperation) Name

Name returns the server-assigned operation name.

func (*CreateWorkspaceBaseEnvironmentOperation) Wait

Wait polls the operation until it completes.

type CreateWorkspaceBaseEnvironmentRequest

type CreateWorkspaceBaseEnvironmentRequest struct {
	// Required. The workspace base environment to create.
	WorkspaceBaseEnvironment *WorkspaceBaseEnvironment
	// 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
	// A unique identifier for this request. A random UUID is recommended. This
	// request is only idempotent if a request_id is provided.
	RequestId *string
}

Request message for CreateWorkspaceBaseEnvironment..

type DefaultWorkspaceBaseEnvironment

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

A singleton resource representing the default workspace base environment configuration. This resource contains the workspace base environments that are used as defaults for serverless notebooks and jobs in the workspace, for both CPU and GPU compute types..

type DeleteWorkspaceBaseEnvironmentRequest

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

Request message for DeleteWorkspaceBaseEnvironment..

type EnvironmentSpec

type EnvironmentSpec struct {
	// List of pip dependencies, as supported by the version of pip in this
	// environment. Each dependency is a valid pip requirements file line per
	// https://pip.pypa.io/en/stable/reference/requirements-file-format/. Allowed
	// dependencies include a requirement specifier, an archive URL, a local project
	// path (such as WSFS or UC Volumes in <Databricks>), or a VCS project URL.
	Dependencies []string
	// Environment version used by the environment. Each version comes with a
	// specific Python version and a set of Python packages. The version is a
	// string, consisting of an integer.
	EnvironmentVersion *string
}

Environment specification for a WorkspaceBaseEnvironment. Contains the environment version and dependencies configuration..

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 GetDefaultWorkspaceBaseEnvironmentRequest

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

Request message for GetDefaultWorkspaceBaseEnvironment..

type GetOperationRequest

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

The request message for `GetOperation` method..

type GetWorkspaceBaseEnvironmentRequest

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

Request message for GetWorkspaceBaseEnvironment..

type ListWorkspaceBaseEnvironmentsRequest

type ListWorkspaceBaseEnvironmentsRequest struct {
	// The maximum number of environments to return per page. Default is 1000.
	PageSize *int
	// Page token for pagination. Received from a previous
	// ListWorkspaceBaseEnvironments call.
	PageToken *string
}

Request message for ListWorkspaceBaseEnvironments..

type ListWorkspaceBaseEnvironmentsResponse

type ListWorkspaceBaseEnvironmentsResponse struct {
	// The list of workspace base environments.
	WorkspaceBaseEnvironments []WorkspaceBaseEnvironment
	// Token to retrieve the next page of results. Empty if there are no more
	// results.
	NextPageToken *string
}

Response message for ListWorkspaceBaseEnvironments..

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 RefreshWorkspaceBaseEnvironmentOperation

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

RefreshWorkspaceBaseEnvironmentOperation tracks the state of the long-running operation started by RefreshWorkspaceBaseEnvironment.

func (*RefreshWorkspaceBaseEnvironmentOperation) Done

Done refreshes the operation and reports whether it has completed.

func (*RefreshWorkspaceBaseEnvironmentOperation) Metadata

Metadata returns metadata associated with the operation.

func (*RefreshWorkspaceBaseEnvironmentOperation) Name

Name returns the server-assigned operation name.

func (*RefreshWorkspaceBaseEnvironmentOperation) Wait

Wait polls the operation until it completes.

type RefreshWorkspaceBaseEnvironmentRequest

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

Request message for RefreshWorkspaceBaseEnvironments..

type UpdateDefaultWorkspaceBaseEnvironmentRequest

type UpdateDefaultWorkspaceBaseEnvironmentRequest struct {
	// Required. The default workspace base environment configuration to update.
	DefaultWorkspaceBaseEnvironment *DefaultWorkspaceBaseEnvironment
	// 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 *types.FieldMask[DefaultWorkspaceBaseEnvironment]
}

Request message for UpdateDefaultWorkspaceBaseEnvironment..

type UpdateWorkspaceBaseEnvironmentOperation

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

UpdateWorkspaceBaseEnvironmentOperation tracks the state of the long-running operation started by UpdateWorkspaceBaseEnvironment.

func (*UpdateWorkspaceBaseEnvironmentOperation) Done

Done refreshes the operation and reports whether it has completed.

func (*UpdateWorkspaceBaseEnvironmentOperation) Metadata

Metadata returns metadata associated with the operation.

func (*UpdateWorkspaceBaseEnvironmentOperation) Name

Name returns the server-assigned operation name.

func (*UpdateWorkspaceBaseEnvironmentOperation) Wait

Wait polls the operation until it completes.

type UpdateWorkspaceBaseEnvironmentRequest

type UpdateWorkspaceBaseEnvironmentRequest struct {
	Name *string
	// Required. The workspace base environment with updated fields. The name field
	// is used to identify the environment to update.
	WorkspaceBaseEnvironment *WorkspaceBaseEnvironment
}

Request message for UpdateWorkspaceBaseEnvironment..

type WorkspaceBaseEnvironment

type WorkspaceBaseEnvironment struct {
	// The resource name of the workspace base environment. Format:
	// workspace-base-environments/{workspace-base-environment}
	Name *string
	// Human-readable display name for the workspace base environment.
	DisplayName *string
	// The WSFS or UC Volumes path to the environment YAML file.
	Filepath *string
	// User ID of the creator.
	CreatorUserId *string
	// Timestamp when the environment was created.
	CreateTime *types.Time
	// User ID of the last user who updated the environment.
	LastUpdatedUserId *string
	// Timestamp when the environment was last updated.
	UpdateTime *types.Time
	// The status of the materialized workspace base environment.
	Status WorkspaceBaseEnvironmentCache_Status
	// Status message providing additional details about the environment status.
	Message *string
	// Whether this is the default environment for the workspace.
	IsDefault *bool
	// The type of base environment (CPU or GPU).
	BaseEnvironmentType BaseEnvironmentType
	// The environment specification containing version and dependencies.
	Spec *EnvironmentSpec
}

A WorkspaceBaseEnvironment defines a workspace-level environment configuration consisting of an environment version and a list of dependencies..

type WorkspaceBaseEnvironmentCache

type WorkspaceBaseEnvironmentCache struct {
}

Materialized environment information for a WorkspaceBaseEnvironment..

type WorkspaceBaseEnvironmentCache_Status

type WorkspaceBaseEnvironmentCache_Status string

Status of the environment materialization.

const (
	WorkspaceBaseEnvironmentCache_Status_Unspecified WorkspaceBaseEnvironmentCache_Status = ""
	// Materialized environment creation is pending.
	WorkspaceBaseEnvironmentCache_Status_Pending WorkspaceBaseEnvironmentCache_Status = "PENDING"
	// Materialized environment has been successfully created.
	WorkspaceBaseEnvironmentCache_Status_Created WorkspaceBaseEnvironmentCache_Status = "CREATED"
	// Materialized environment creation failed.
	WorkspaceBaseEnvironmentCache_Status_Failed WorkspaceBaseEnvironmentCache_Status = "FAILED"
	// Materialized environment has expired.
	WorkspaceBaseEnvironmentCache_Status_Expired WorkspaceBaseEnvironmentCache_Status = "EXPIRED"
	// Materialized environment is invalid.
	WorkspaceBaseEnvironmentCache_Status_Invalid WorkspaceBaseEnvironmentCache_Status = "INVALID"
	// Materialized environment is being refreshed.
	WorkspaceBaseEnvironmentCache_Status_Refreshing WorkspaceBaseEnvironmentCache_Status = "REFRESHING"
)

type WorkspaceBaseEnvironmentOperationMetadata

type WorkspaceBaseEnvironmentOperationMetadata struct {
}

Metadata for the WorkspaceBaseEnvironment long-running operations. This message tracks the progress of the workspace base environment long-running process..

Jump to

Keyboard shortcuts

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