Documentation
¶
Overview ¶
Manage software artifacts and their versions in Unity Catalog.
Index ¶
- type GetSoftwareArtifactRequest
- type GetSoftwareArtifactVersionRequest
- type ImageAccelerationDetail
- type ImageAccelerationDetailStatus
- type ListSoftwareArtifactVersionsRequest
- type ListSoftwareArtifactVersionsResponse
- type ListSoftwareArtifactsRequest
- type ListSoftwareArtifactsResponse
- type ResolveSoftwareArtifactVersionRequest
- type ResolveSoftwareArtifactVersionResponse
- type SoftwareArtifact
- type SoftwareArtifactVersion
- type SoftwareArtifactsAPI
- func (a *SoftwareArtifactsAPI) GetSoftwareArtifact(ctx context.Context, request GetSoftwareArtifactRequest) (*SoftwareArtifact, error)
- func (a *SoftwareArtifactsAPI) GetSoftwareArtifactVersion(ctx context.Context, request GetSoftwareArtifactVersionRequest) (*SoftwareArtifactVersion, error)
- func (a *SoftwareArtifactsAPI) ListSoftwareArtifactVersions(ctx context.Context, request ListSoftwareArtifactVersionsRequest) listing.Iterator[SoftwareArtifactVersion]
- func (a *SoftwareArtifactsAPI) ListSoftwareArtifactVersionsAll(ctx context.Context, request ListSoftwareArtifactVersionsRequest) ([]SoftwareArtifactVersion, error)
- func (a *SoftwareArtifactsAPI) ListSoftwareArtifacts(ctx context.Context, request ListSoftwareArtifactsRequest) listing.Iterator[SoftwareArtifact]
- func (a *SoftwareArtifactsAPI) ListSoftwareArtifactsAll(ctx context.Context, request ListSoftwareArtifactsRequest) ([]SoftwareArtifact, error)
- func (a *SoftwareArtifactsAPI) ResolveSoftwareArtifactVersion(ctx context.Context, request ResolveSoftwareArtifactVersionRequest) (*ResolveSoftwareArtifactVersionResponse, error)
- func (a *SoftwareArtifactsAPI) UpdateSoftwareArtifact(ctx context.Context, request UpdateSoftwareArtifactRequest) (*SoftwareArtifact, error)
- type SoftwareArtifactsInterface
- type SoftwareArtifactsServicedeprecated
- type UpdateSoftwareArtifactRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetSoftwareArtifactRequest ¶
type GetSoftwareArtifactRequest struct {
// Resource name of the artifact, of the form
// `software-artifacts/{catalog}.{schema}.{artifact}`.
Name string `json:"-" url:"-"`
}
func (*GetSoftwareArtifactRequest) UnmarshalJSON ¶
func (s *GetSoftwareArtifactRequest) UnmarshalJSON(b []byte) error
type GetSoftwareArtifactVersionRequest ¶
type GetSoftwareArtifactVersionRequest struct {
// Resource name of the version, of the form
// `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.
Name string `json:"-" url:"-"`
}
func (*GetSoftwareArtifactVersionRequest) UnmarshalJSON ¶
func (s *GetSoftwareArtifactVersionRequest) UnmarshalJSON(b []byte) error
type ImageAccelerationDetail ¶
type ImageAccelerationDetail struct {
// Image acceleration status for the version.
Status ImageAccelerationDetailStatus `json:"status,omitempty"`
}
Image acceleration information for a software artifact version.
func (*ImageAccelerationDetail) UnmarshalJSON ¶
func (s *ImageAccelerationDetail) UnmarshalJSON(b []byte) error
type ImageAccelerationDetailStatus ¶
type ImageAccelerationDetailStatus string
Image acceleration status for a software artifact version.
const ImageAccelerationDetailStatusSuccess ImageAccelerationDetailStatus = `SUCCESS`
const ImageAccelerationDetailStatusUnspecified ImageAccelerationDetailStatus = `UNSPECIFIED`
func (*ImageAccelerationDetailStatus) Set ¶
func (f *ImageAccelerationDetailStatus) Set(v string) error
Set raw string value and validate it against allowed values
func (*ImageAccelerationDetailStatus) String ¶
func (f *ImageAccelerationDetailStatus) String() string
String representation for fmt.Print
func (*ImageAccelerationDetailStatus) Type ¶
func (f *ImageAccelerationDetailStatus) Type() string
Type always returns ImageAccelerationDetailStatus to satisfy [pflag.Value] interface
func (*ImageAccelerationDetailStatus) Values ¶
func (f *ImageAccelerationDetailStatus) Values() []ImageAccelerationDetailStatus
Values returns all possible values for ImageAccelerationDetailStatus.
There is no guarantee on the order of the values in the slice.
type ListSoftwareArtifactVersionsRequest ¶
type ListSoftwareArtifactVersionsRequest struct {
// Maximum number of versions to return. If omitted or set to 0, the page
// size defaults to 50. The maximum value is 50; values above 50 or below 0
// are rejected.
PageSize int `json:"-" url:"page_size,omitempty"`
// Opaque continuation token from a previous response's next_page_token.
// Omit for the first page.
PageToken string `json:"-" url:"page_token,omitempty"`
// Resource name of the parent artifact, of the form
// `software-artifacts/{catalog}.{schema}.{artifact}`.
Parent string `json:"-" url:"-"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListSoftwareArtifactVersionsRequest) MarshalJSON ¶
func (s ListSoftwareArtifactVersionsRequest) MarshalJSON() ([]byte, error)
func (*ListSoftwareArtifactVersionsRequest) UnmarshalJSON ¶
func (s *ListSoftwareArtifactVersionsRequest) UnmarshalJSON(b []byte) error
type ListSoftwareArtifactVersionsResponse ¶
type ListSoftwareArtifactVersionsResponse struct {
// Opaque token to pass as the next request's page_token. Empty when there
// are no more pages.
NextPageToken string `json:"next_page_token,omitempty"`
// The versions of the requested software artifact.
SoftwareArtifactVersions []SoftwareArtifactVersion `json:"software_artifact_versions,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
Response containing a page of software artifact versions.
func (ListSoftwareArtifactVersionsResponse) MarshalJSON ¶
func (s ListSoftwareArtifactVersionsResponse) MarshalJSON() ([]byte, error)
func (*ListSoftwareArtifactVersionsResponse) UnmarshalJSON ¶
func (s *ListSoftwareArtifactVersionsResponse) UnmarshalJSON(b []byte) error
type ListSoftwareArtifactsRequest ¶
type ListSoftwareArtifactsRequest struct {
// Maximum number of software artifacts to return. If omitted or set to 0,
// the page size defaults to 50. The maximum value is 50; values above 50 or
// below 0 are rejected.
PageSize int `json:"-" url:"page_size,omitempty"`
// Opaque continuation token from a previous response's next_page_token.
// Omit for the first page.
PageToken string `json:"-" url:"page_token,omitempty"`
// Resource name of the parent schema, of the form
// `schemas/{catalog}.{schema}`.
Parent string `json:"-" url:"parent"`
ForceSendFields []string `json:"-" url:"-"`
}
func (ListSoftwareArtifactsRequest) MarshalJSON ¶
func (s ListSoftwareArtifactsRequest) MarshalJSON() ([]byte, error)
func (*ListSoftwareArtifactsRequest) UnmarshalJSON ¶
func (s *ListSoftwareArtifactsRequest) UnmarshalJSON(b []byte) error
type ListSoftwareArtifactsResponse ¶
type ListSoftwareArtifactsResponse struct {
// Opaque token to pass as the next request's page_token. Empty when there
// are no more pages.
NextPageToken string `json:"next_page_token,omitempty"`
// The software artifacts under the requested schema.
SoftwareArtifacts []SoftwareArtifact `json:"software_artifacts,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
Response containing a page of software artifacts.
func (ListSoftwareArtifactsResponse) MarshalJSON ¶
func (s ListSoftwareArtifactsResponse) MarshalJSON() ([]byte, error)
func (*ListSoftwareArtifactsResponse) UnmarshalJSON ¶
func (s *ListSoftwareArtifactsResponse) UnmarshalJSON(b []byte) error
type ResolveSoftwareArtifactVersionRequest ¶
type ResolveSoftwareArtifactVersionRequest struct {
// Image tag alias selecting the version.
Alias string `json:"alias"`
// Resource name of the software artifact containing the alias.
Parent string `json:"-" url:"-"`
}
Request to resolve a software artifact version from its tag alias.
func (*ResolveSoftwareArtifactVersionRequest) UnmarshalJSON ¶
func (s *ResolveSoftwareArtifactVersionRequest) UnmarshalJSON(b []byte) error
type ResolveSoftwareArtifactVersionResponse ¶
type ResolveSoftwareArtifactVersionResponse struct {
// The software artifact version selected by the alias.
SoftwareArtifactVersion *SoftwareArtifactVersion `json:"software_artifact_version,omitempty"`
}
Response containing the resolved software artifact version.
func (*ResolveSoftwareArtifactVersionResponse) UnmarshalJSON ¶
func (s *ResolveSoftwareArtifactVersionResponse) UnmarshalJSON(b []byte) error
type SoftwareArtifact ¶
type SoftwareArtifact struct {
// Time at which this software artifact was created.
CreateTime *time.Time `json:"create_time,omitempty"`
// Principal name of the software artifact creator.
CreatedBy string `json:"created_by,omitempty"`
// Resource name of the artifact, of the form
// `software-artifacts/{catalog}.{schema}.{artifact}`.
Name string `json:"name,omitempty"`
// Principal name (a user, service principal, or group) that owns this
// artifact.
Owner string `json:"owner,omitempty"`
// Time at which this software artifact was last updated.
UpdateTime *time.Time `json:"update_time,omitempty"`
// Principal name that last updated this software artifact.
UpdatedBy string `json:"updated_by,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
A software artifact in a Unity Catalog schema.
func (SoftwareArtifact) MarshalJSON ¶
func (s SoftwareArtifact) MarshalJSON() ([]byte, error)
func (*SoftwareArtifact) UnmarshalJSON ¶
func (s *SoftwareArtifact) UnmarshalJSON(b []byte) error
type SoftwareArtifactVersion ¶
type SoftwareArtifactVersion struct {
// Time at which this software artifact version was created.
CreateTime *time.Time `json:"create_time,omitempty"`
// Principal name of the software artifact version creator.
CreatedBy string `json:"created_by,omitempty"`
// Content digest of the version, for example `sha256:...`.
Digest string `json:"digest,omitempty"`
// Image acceleration information for this version.
ImageAccelerationDetails *ImageAccelerationDetail `json:"image_acceleration_details,omitempty"`
// Resource name of the version, of the form
// `software-artifacts/{catalog}.{schema}.{artifact}/versions/{version}`.
Name string `json:"name,omitempty"`
// Tags (aliases) that currently point at this version, for example `latest`
// or `v1.2.3`. Bounded at 10 per version; a version pointed at by more tags
// returns an arbitrary 10 of them.
Tags []string `json:"tags,omitempty"`
// Time at which this software artifact version was last updated.
UpdateTime *time.Time `json:"update_time,omitempty"`
// Principal name that last updated this software artifact version.
UpdatedBy string `json:"updated_by,omitempty"`
ForceSendFields []string `json:"-" url:"-"`
}
An immutable version of a software artifact, identified by its content digest.
func (SoftwareArtifactVersion) MarshalJSON ¶
func (s SoftwareArtifactVersion) MarshalJSON() ([]byte, error)
func (*SoftwareArtifactVersion) UnmarshalJSON ¶
func (s *SoftwareArtifactVersion) UnmarshalJSON(b []byte) error
type SoftwareArtifactsAPI ¶
type SoftwareArtifactsAPI struct {
// contains filtered or unexported fields
}
Manage software artifacts and their versions in Unity Catalog.
func NewSoftwareArtifacts ¶
func NewSoftwareArtifacts(client *client.DatabricksClient) *SoftwareArtifactsAPI
func (*SoftwareArtifactsAPI) GetSoftwareArtifact ¶
func (a *SoftwareArtifactsAPI) GetSoftwareArtifact(ctx context.Context, request GetSoftwareArtifactRequest) (*SoftwareArtifact, error)
func (*SoftwareArtifactsAPI) GetSoftwareArtifactVersion ¶
func (a *SoftwareArtifactsAPI) GetSoftwareArtifactVersion(ctx context.Context, request GetSoftwareArtifactVersionRequest) (*SoftwareArtifactVersion, error)
func (*SoftwareArtifactsAPI) ListSoftwareArtifactVersions ¶
func (a *SoftwareArtifactsAPI) ListSoftwareArtifactVersions(ctx context.Context, request ListSoftwareArtifactVersionsRequest) listing.Iterator[SoftwareArtifactVersion]
Lists the versions of a software artifact.
func (*SoftwareArtifactsAPI) ListSoftwareArtifactVersionsAll ¶
func (a *SoftwareArtifactsAPI) ListSoftwareArtifactVersionsAll(ctx context.Context, request ListSoftwareArtifactVersionsRequest) ([]SoftwareArtifactVersion, error)
Lists the versions of a software artifact.
func (*SoftwareArtifactsAPI) ListSoftwareArtifacts ¶
func (a *SoftwareArtifactsAPI) ListSoftwareArtifacts(ctx context.Context, request ListSoftwareArtifactsRequest) listing.Iterator[SoftwareArtifact]
Lists software artifacts in a schema.
func (*SoftwareArtifactsAPI) ListSoftwareArtifactsAll ¶
func (a *SoftwareArtifactsAPI) ListSoftwareArtifactsAll(ctx context.Context, request ListSoftwareArtifactsRequest) ([]SoftwareArtifact, error)
Lists software artifacts in a schema.
func (*SoftwareArtifactsAPI) ResolveSoftwareArtifactVersion ¶
func (a *SoftwareArtifactsAPI) ResolveSoftwareArtifactVersion(ctx context.Context, request ResolveSoftwareArtifactVersionRequest) (*ResolveSoftwareArtifactVersionResponse, error)
func (*SoftwareArtifactsAPI) UpdateSoftwareArtifact ¶
func (a *SoftwareArtifactsAPI) UpdateSoftwareArtifact(ctx context.Context, request UpdateSoftwareArtifactRequest) (*SoftwareArtifact, error)
type SoftwareArtifactsInterface ¶
type SoftwareArtifactsInterface interface {
// Gets a software artifact.
GetSoftwareArtifact(ctx context.Context, request GetSoftwareArtifactRequest) (*SoftwareArtifact, error)
// Gets a software artifact version.
GetSoftwareArtifactVersion(ctx context.Context, request GetSoftwareArtifactVersionRequest) (*SoftwareArtifactVersion, error)
// Lists the versions of a software artifact.
//
// This method is generated by Databricks SDK Code Generator.
ListSoftwareArtifactVersions(ctx context.Context, request ListSoftwareArtifactVersionsRequest) listing.Iterator[SoftwareArtifactVersion]
// Lists the versions of a software artifact.
//
// This method is generated by Databricks SDK Code Generator.
ListSoftwareArtifactVersionsAll(ctx context.Context, request ListSoftwareArtifactVersionsRequest) ([]SoftwareArtifactVersion, error)
// Lists software artifacts in a schema.
//
// This method is generated by Databricks SDK Code Generator.
ListSoftwareArtifacts(ctx context.Context, request ListSoftwareArtifactsRequest) listing.Iterator[SoftwareArtifact]
// Lists software artifacts in a schema.
//
// This method is generated by Databricks SDK Code Generator.
ListSoftwareArtifactsAll(ctx context.Context, request ListSoftwareArtifactsRequest) ([]SoftwareArtifact, error)
// Resolves a software artifact version from its tag alias.
ResolveSoftwareArtifactVersion(ctx context.Context, request ResolveSoftwareArtifactVersionRequest) (*ResolveSoftwareArtifactVersionResponse, error)
// Updates a software artifact. The name is immutable; only the owner may be
// changed. The destination owner must exist in the account. The caller needs
// MANAGE_ACCESS_CONTROL on the artifact. The response contains its name and the
// requested owner; audit fields are omitted.
UpdateSoftwareArtifact(ctx context.Context, request UpdateSoftwareArtifactRequest) (*SoftwareArtifact, error)
}
type SoftwareArtifactsService
deprecated
type SoftwareArtifactsService interface {
// Gets a software artifact.
GetSoftwareArtifact(ctx context.Context, request GetSoftwareArtifactRequest) (*SoftwareArtifact, error)
// Gets a software artifact version.
GetSoftwareArtifactVersion(ctx context.Context, request GetSoftwareArtifactVersionRequest) (*SoftwareArtifactVersion, error)
// Lists the versions of a software artifact.
ListSoftwareArtifactVersions(ctx context.Context, request ListSoftwareArtifactVersionsRequest) (*ListSoftwareArtifactVersionsResponse, error)
// Lists software artifacts in a schema.
ListSoftwareArtifacts(ctx context.Context, request ListSoftwareArtifactsRequest) (*ListSoftwareArtifactsResponse, error)
// Resolves a software artifact version from its tag alias.
ResolveSoftwareArtifactVersion(ctx context.Context, request ResolveSoftwareArtifactVersionRequest) (*ResolveSoftwareArtifactVersionResponse, error)
// Updates a software artifact. The name is immutable; only the owner may be
// changed. The destination owner must exist in the account. The caller
// needs MANAGE_ACCESS_CONTROL on the artifact. The response contains its
// name and the requested owner; audit fields are omitted.
UpdateSoftwareArtifact(ctx context.Context, request UpdateSoftwareArtifactRequest) (*SoftwareArtifact, error)
}
Manage software artifacts and their versions in Unity Catalog.
Deprecated: Do not use this interface, it will be removed in a future version of the SDK.
type UpdateSoftwareArtifactRequest ¶
type UpdateSoftwareArtifactRequest struct {
// Resource name of the artifact, of the form
// `software-artifacts/{catalog}.{schema}.{artifact}`.
Name string `json:"-" url:"-"`
// The software artifact to update. Its name identifies the existing
// artifact; only owner may be changed.
SoftwareArtifact SoftwareArtifact `json:"software_artifact"`
// Fields to update, relative to `software_artifact`. Accepts `owner` or
// `*`; owner is the only mutable field, so both select the same update.
// Output-only values in the resource are ignored.
UpdateMask fieldmask.FieldMask `json:"-" url:"update_mask"`
}
func (*UpdateSoftwareArtifactRequest) UnmarshalJSON ¶
func (s *UpdateSoftwareArtifactRequest) UnmarshalJSON(b []byte) error