marketplace

package
v0.42.0 Latest Latest
Warning

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

Go to latest
Published: Jun 3, 2024 License: Apache-2.0 Imports: 7 Imported by: 12

Documentation

Overview

These APIs allow you to manage Consumer Fulfillments, Consumer Installations, Consumer Listings, Consumer Personalization Requests, Consumer Providers, Provider Exchange Filters, Provider Exchanges, Provider Files, Provider Listings, Provider Personalization Requests, Provider Provider Analytics Dashboards, Provider Providers, etc.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddExchangeForListingRequest

type AddExchangeForListingRequest struct {
	ExchangeId string `json:"exchange_id"`

	ListingId string `json:"listing_id"`
}

type AddExchangeForListingResponse

type AddExchangeForListingResponse struct {
	ExchangeForListing *ExchangeListing `json:"exchange_for_listing,omitempty"`
}

type AssetType

type AssetType string
const AssetTypeAssetTypeDataTable AssetType = `ASSET_TYPE_DATA_TABLE`
const AssetTypeAssetTypeGitRepo AssetType = `ASSET_TYPE_GIT_REPO`
const AssetTypeAssetTypeMedia AssetType = `ASSET_TYPE_MEDIA`
const AssetTypeAssetTypeModel AssetType = `ASSET_TYPE_MODEL`
const AssetTypeAssetTypeNotebook AssetType = `ASSET_TYPE_NOTEBOOK`
const AssetTypeAssetTypeUnspecified AssetType = `ASSET_TYPE_UNSPECIFIED`

func (*AssetType) Set

func (f *AssetType) Set(v string) error

Set raw string value and validate it against allowed values

func (*AssetType) String

func (f *AssetType) String() string

String representation for fmt.Print

func (*AssetType) Type

func (f *AssetType) Type() string

Type always returns AssetType to satisfy [pflag.Value] interface

type BatchGetListingsRequest added in v0.42.0

type BatchGetListingsRequest struct {
	Ids []string `json:"-" url:"ids,omitempty"`
}

Get one batch of listings. One may specify up to 50 IDs per request.

type BatchGetListingsResponse added in v0.42.0

type BatchGetListingsResponse struct {
	Listings []Listing `json:"listings,omitempty"`
}

type BatchGetProvidersRequest added in v0.42.0

type BatchGetProvidersRequest struct {
	Ids []string `json:"-" url:"ids,omitempty"`
}

Get one batch of providers. One may specify up to 50 IDs per request.

type BatchGetProvidersResponse added in v0.42.0

type BatchGetProvidersResponse struct {
	Providers []ProviderInfo `json:"providers,omitempty"`
}

type Category

type Category string
const CategoryAdvertisingAndMarketing Category = `ADVERTISING_AND_MARKETING`
const CategoryClimateAndEnvironment Category = `CLIMATE_AND_ENVIRONMENT`
const CategoryCommerce Category = `COMMERCE`
const CategoryDemographics Category = `DEMOGRAPHICS`
const CategoryEconomics Category = `ECONOMICS`
const CategoryEducation Category = `EDUCATION`
const CategoryEnergy Category = `ENERGY`
const CategoryFinancial Category = `FINANCIAL`
const CategoryGaming Category = `GAMING`
const CategoryGeospatial Category = `GEOSPATIAL`
const CategoryHealth Category = `HEALTH`
const CategoryLookupTables Category = `LOOKUP_TABLES`
const CategoryManufacturing Category = `MANUFACTURING`
const CategoryMedia Category = `MEDIA`
const CategoryOther Category = `OTHER`
const CategoryPublicSector Category = `PUBLIC_SECTOR`
const CategoryRetail Category = `RETAIL`
const CategoryScienceAndResearch Category = `SCIENCE_AND_RESEARCH`
const CategorySecurity Category = `SECURITY`
const CategorySports Category = `SPORTS`
const CategoryTransportationAndLogistics Category = `TRANSPORTATION_AND_LOGISTICS`
const CategoryTravelAndTourism Category = `TRAVEL_AND_TOURISM`

func (*Category) Set

func (f *Category) Set(v string) error

Set raw string value and validate it against allowed values

func (*Category) String

func (f *Category) String() string

String representation for fmt.Print

func (*Category) Type

func (f *Category) Type() string

Type always returns Category to satisfy [pflag.Value] interface

type ConsumerFulfillmentsAPI

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

Fulfillments are entities that allow consumers to preview installations.

func NewConsumerFulfillments

func NewConsumerFulfillments(client *client.DatabricksClient) *ConsumerFulfillmentsAPI

func (*ConsumerFulfillmentsAPI) Get

Get listing content metadata.

Get a high level preview of the metadata of listing installable content.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerFulfillmentsAPI) GetAll

Get listing content metadata.

Get a high level preview of the metadata of listing installable content.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerFulfillmentsAPI) GetByListingId

Get listing content metadata.

Get a high level preview of the metadata of listing installable content.

func (*ConsumerFulfillmentsAPI) Impl

Impl returns low-level ConsumerFulfillments API implementation Deprecated: use MockConsumerFulfillmentsInterface instead.

func (*ConsumerFulfillmentsAPI) List

List all listing fulfillments.

Get all listings fulfillments associated with a listing. A _fulfillment_ is a potential installation. Standard installations contain metadata about the attached share or git repo. Only one of these fields will be present. Personalized installations contain metadata about the attached share or git repo, as well as the Delta Sharing recipient type.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerFulfillmentsAPI) ListAll

List all listing fulfillments.

Get all listings fulfillments associated with a listing. A _fulfillment_ is a potential installation. Standard installations contain metadata about the attached share or git repo. Only one of these fields will be present. Personalized installations contain metadata about the attached share or git repo, as well as the Delta Sharing recipient type.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerFulfillmentsAPI) ListByListingId

func (a *ConsumerFulfillmentsAPI) ListByListingId(ctx context.Context, listingId string) (*ListFulfillmentsResponse, error)

List all listing fulfillments.

Get all listings fulfillments associated with a listing. A _fulfillment_ is a potential installation. Standard installations contain metadata about the attached share or git repo. Only one of these fields will be present. Personalized installations contain metadata about the attached share or git repo, as well as the Delta Sharing recipient type.

func (*ConsumerFulfillmentsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockConsumerFulfillmentsInterface instead.

type ConsumerFulfillmentsInterface

type ConsumerFulfillmentsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockConsumerFulfillmentsInterface instead.
	WithImpl(impl ConsumerFulfillmentsService) ConsumerFulfillmentsInterface

	// Impl returns low-level ConsumerFulfillments API implementation
	// Deprecated: use MockConsumerFulfillmentsInterface instead.
	Impl() ConsumerFulfillmentsService

	// Get listing content metadata.
	//
	// Get a high level preview of the metadata of listing installable content.
	//
	// This method is generated by Databricks SDK Code Generator.
	Get(ctx context.Context, request GetListingContentMetadataRequest) listing.Iterator[SharedDataObject]

	// Get listing content metadata.
	//
	// Get a high level preview of the metadata of listing installable content.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetAll(ctx context.Context, request GetListingContentMetadataRequest) ([]SharedDataObject, error)

	// Get listing content metadata.
	//
	// Get a high level preview of the metadata of listing installable content.
	GetByListingId(ctx context.Context, listingId string) (*GetListingContentMetadataResponse, error)

	// List all listing fulfillments.
	//
	// Get all listings fulfillments associated with a listing. A _fulfillment_ is a
	// potential installation. Standard installations contain metadata about the
	// attached share or git repo. Only one of these fields will be present.
	// Personalized installations contain metadata about the attached share or git
	// repo, as well as the Delta Sharing recipient type.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListFulfillmentsRequest) listing.Iterator[ListingFulfillment]

	// List all listing fulfillments.
	//
	// Get all listings fulfillments associated with a listing. A _fulfillment_ is a
	// potential installation. Standard installations contain metadata about the
	// attached share or git repo. Only one of these fields will be present.
	// Personalized installations contain metadata about the attached share or git
	// repo, as well as the Delta Sharing recipient type.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListFulfillmentsRequest) ([]ListingFulfillment, error)

	// List all listing fulfillments.
	//
	// Get all listings fulfillments associated with a listing. A _fulfillment_ is a
	// potential installation. Standard installations contain metadata about the
	// attached share or git repo. Only one of these fields will be present.
	// Personalized installations contain metadata about the attached share or git
	// repo, as well as the Delta Sharing recipient type.
	ListByListingId(ctx context.Context, listingId string) (*ListFulfillmentsResponse, error)
}

type ConsumerFulfillmentsService

type ConsumerFulfillmentsService interface {

	// Get listing content metadata.
	//
	// Get a high level preview of the metadata of listing installable content.
	//
	// Use GetAll() to get all SharedDataObject instances, which will iterate over every result page.
	Get(ctx context.Context, request GetListingContentMetadataRequest) (*GetListingContentMetadataResponse, error)

	// List all listing fulfillments.
	//
	// Get all listings fulfillments associated with a listing. A _fulfillment_
	// is a potential installation. Standard installations contain metadata
	// about the attached share or git repo. Only one of these fields will be
	// present. Personalized installations contain metadata about the attached
	// share or git repo, as well as the Delta Sharing recipient type.
	//
	// Use ListAll() to get all ListingFulfillment instances, which will iterate over every result page.
	List(ctx context.Context, request ListFulfillmentsRequest) (*ListFulfillmentsResponse, error)
}

Fulfillments are entities that allow consumers to preview installations.

type ConsumerInstallationsAPI

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

Installations are entities that allow consumers to interact with Databricks Marketplace listings.

func NewConsumerInstallations

func NewConsumerInstallations(client *client.DatabricksClient) *ConsumerInstallationsAPI

func (*ConsumerInstallationsAPI) Create

Install from a listing.

Install payload associated with a Databricks Marketplace listing.

func (*ConsumerInstallationsAPI) Delete

Uninstall from a listing.

Uninstall an installation associated with a Databricks Marketplace listing.

func (*ConsumerInstallationsAPI) DeleteByListingIdAndInstallationId

func (a *ConsumerInstallationsAPI) DeleteByListingIdAndInstallationId(ctx context.Context, listingId string, installationId string) error

Uninstall from a listing.

Uninstall an installation associated with a Databricks Marketplace listing.

func (*ConsumerInstallationsAPI) Impl

Impl returns low-level ConsumerInstallations API implementation Deprecated: use MockConsumerInstallationsInterface instead.

func (*ConsumerInstallationsAPI) List

List all installations.

List all installations across all listings.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerInstallationsAPI) ListAll

List all installations.

List all installations across all listings.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerInstallationsAPI) ListListingInstallations

List installations for a listing.

List all installations for a particular listing.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerInstallationsAPI) ListListingInstallationsAll

func (a *ConsumerInstallationsAPI) ListListingInstallationsAll(ctx context.Context, request ListInstallationsRequest) ([]InstallationDetail, error)

List installations for a listing.

List all installations for a particular listing.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerInstallationsAPI) ListListingInstallationsByListingId

func (a *ConsumerInstallationsAPI) ListListingInstallationsByListingId(ctx context.Context, listingId string) (*ListInstallationsResponse, error)

List installations for a listing.

List all installations for a particular listing.

func (*ConsumerInstallationsAPI) Update

Update an installation.

This is a update API that will update the part of the fields defined in the installation table as well as interact with external services according to the fields not included in the installation table 1. the token will be rotate if the rotateToken flag is true 2. the token will be forcibly rotate if the rotateToken flag is true and the tokenInfo field is empty

func (*ConsumerInstallationsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockConsumerInstallationsInterface instead.

type ConsumerInstallationsInterface

type ConsumerInstallationsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockConsumerInstallationsInterface instead.
	WithImpl(impl ConsumerInstallationsService) ConsumerInstallationsInterface

	// Impl returns low-level ConsumerInstallations API implementation
	// Deprecated: use MockConsumerInstallationsInterface instead.
	Impl() ConsumerInstallationsService

	// Install from a listing.
	//
	// Install payload associated with a Databricks Marketplace listing.
	Create(ctx context.Context, request CreateInstallationRequest) (*Installation, error)

	// Uninstall from a listing.
	//
	// Uninstall an installation associated with a Databricks Marketplace listing.
	Delete(ctx context.Context, request DeleteInstallationRequest) error

	// Uninstall from a listing.
	//
	// Uninstall an installation associated with a Databricks Marketplace listing.
	DeleteByListingIdAndInstallationId(ctx context.Context, listingId string, installationId string) error

	// List all installations.
	//
	// List all installations across all listings.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListAllInstallationsRequest) listing.Iterator[InstallationDetail]

	// List all installations.
	//
	// List all installations across all listings.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListAllInstallationsRequest) ([]InstallationDetail, error)

	// List installations for a listing.
	//
	// List all installations for a particular listing.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListListingInstallations(ctx context.Context, request ListInstallationsRequest) listing.Iterator[InstallationDetail]

	// List installations for a listing.
	//
	// List all installations for a particular listing.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListListingInstallationsAll(ctx context.Context, request ListInstallationsRequest) ([]InstallationDetail, error)

	// List installations for a listing.
	//
	// List all installations for a particular listing.
	ListListingInstallationsByListingId(ctx context.Context, listingId string) (*ListInstallationsResponse, error)

	// Update an installation.
	//
	// This is a update API that will update the part of the fields defined in the
	// installation table as well as interact with external services according to
	// the fields not included in the installation table 1. the token will be rotate
	// if the rotateToken flag is true 2. the token will be forcibly rotate if the
	// rotateToken flag is true and the tokenInfo field is empty
	Update(ctx context.Context, request UpdateInstallationRequest) (*UpdateInstallationResponse, error)
}

type ConsumerInstallationsService

type ConsumerInstallationsService interface {

	// Install from a listing.
	//
	// Install payload associated with a Databricks Marketplace listing.
	Create(ctx context.Context, request CreateInstallationRequest) (*Installation, error)

	// Uninstall from a listing.
	//
	// Uninstall an installation associated with a Databricks Marketplace
	// listing.
	Delete(ctx context.Context, request DeleteInstallationRequest) error

	// List all installations.
	//
	// List all installations across all listings.
	//
	// Use ListAll() to get all InstallationDetail instances, which will iterate over every result page.
	List(ctx context.Context, request ListAllInstallationsRequest) (*ListAllInstallationsResponse, error)

	// List installations for a listing.
	//
	// List all installations for a particular listing.
	//
	// Use ListListingInstallationsAll() to get all InstallationDetail instances, which will iterate over every result page.
	ListListingInstallations(ctx context.Context, request ListInstallationsRequest) (*ListInstallationsResponse, error)

	// Update an installation.
	//
	// This is a update API that will update the part of the fields defined in
	// the installation table as well as interact with external services
	// according to the fields not included in the installation table 1. the
	// token will be rotate if the rotateToken flag is true 2. the token will be
	// forcibly rotate if the rotateToken flag is true and the tokenInfo field
	// is empty
	Update(ctx context.Context, request UpdateInstallationRequest) (*UpdateInstallationResponse, error)
}

Installations are entities that allow consumers to interact with Databricks Marketplace listings.

type ConsumerListingsAPI

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

Listings are the core entities in the Marketplace. They represent the products that are available for consumption.

func NewConsumerListings

func NewConsumerListings(client *client.DatabricksClient) *ConsumerListingsAPI

func (*ConsumerListingsAPI) BatchGet added in v0.42.0

Get one batch of listings. One may specify up to 50 IDs per request.

Batch get a published listing in the Databricks Marketplace that the consumer has access to.

func (*ConsumerListingsAPI) Get

Get listing.

Get a published listing in the Databricks Marketplace that the consumer has access to.

func (*ConsumerListingsAPI) GetById

Get listing.

Get a published listing in the Databricks Marketplace that the consumer has access to.

func (*ConsumerListingsAPI) GetBySummaryName

func (a *ConsumerListingsAPI) GetBySummaryName(ctx context.Context, name string) (*Listing, error)

GetBySummaryName calls ConsumerListingsAPI.ListingSummaryNameToIdMap and returns a single Listing.

Returns an error if there's more than one Listing with the same .Summary.Name.

Note: All Listing instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerListingsAPI) Impl

Impl returns low-level ConsumerListings API implementation Deprecated: use MockConsumerListingsInterface instead.

func (*ConsumerListingsAPI) List

List listings.

List all published listings in the Databricks Marketplace that the consumer has access to.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerListingsAPI) ListAll

func (a *ConsumerListingsAPI) ListAll(ctx context.Context, request ListListingsRequest) ([]Listing, error)

List listings.

List all published listings in the Databricks Marketplace that the consumer has access to.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerListingsAPI) ListingSummaryNameToIdMap

func (a *ConsumerListingsAPI) ListingSummaryNameToIdMap(ctx context.Context, request ListListingsRequest) (map[string]string, error)

ListingSummaryNameToIdMap calls ConsumerListingsAPI.ListAll and creates a map of results with Listing.Summary.Name as key and Listing.Id as value.

Returns an error if there's more than one Listing with the same .Summary.Name.

Note: All Listing instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerListingsAPI) Search

Search listings.

Search published listings in the Databricks Marketplace that the consumer has access to. This query supports a variety of different search parameters and performs fuzzy matching.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerListingsAPI) SearchAll

func (a *ConsumerListingsAPI) SearchAll(ctx context.Context, request SearchListingsRequest) ([]Listing, error)

Search listings.

Search published listings in the Databricks Marketplace that the consumer has access to. This query supports a variety of different search parameters and performs fuzzy matching.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerListingsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockConsumerListingsInterface instead.

type ConsumerListingsInterface

type ConsumerListingsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockConsumerListingsInterface instead.
	WithImpl(impl ConsumerListingsService) ConsumerListingsInterface

	// Impl returns low-level ConsumerListings API implementation
	// Deprecated: use MockConsumerListingsInterface instead.
	Impl() ConsumerListingsService

	// Get one batch of listings. One may specify up to 50 IDs per request.
	//
	// Batch get a published listing in the Databricks Marketplace that the consumer
	// has access to.
	BatchGet(ctx context.Context, request BatchGetListingsRequest) (*BatchGetListingsResponse, error)

	// Get listing.
	//
	// Get a published listing in the Databricks Marketplace that the consumer has
	// access to.
	Get(ctx context.Context, request GetListingRequest) (*GetListingResponse, error)

	// Get listing.
	//
	// Get a published listing in the Databricks Marketplace that the consumer has
	// access to.
	GetById(ctx context.Context, id string) (*GetListingResponse, error)

	// List listings.
	//
	// List all published listings in the Databricks Marketplace that the consumer
	// has access to.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListListingsRequest) listing.Iterator[Listing]

	// List listings.
	//
	// List all published listings in the Databricks Marketplace that the consumer
	// has access to.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListListingsRequest) ([]Listing, error)

	// ListingSummaryNameToIdMap calls [ConsumerListingsAPI.ListAll] and creates a map of results with [Listing].Summary.Name as key and [Listing].Id as value.
	//
	// Returns an error if there's more than one [Listing] with the same .Summary.Name.
	//
	// Note: All [Listing] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListingSummaryNameToIdMap(ctx context.Context, request ListListingsRequest) (map[string]string, error)

	// GetBySummaryName calls [ConsumerListingsAPI.ListingSummaryNameToIdMap] and returns a single [Listing].
	//
	// Returns an error if there's more than one [Listing] with the same .Summary.Name.
	//
	// Note: All [Listing] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetBySummaryName(ctx context.Context, name string) (*Listing, error)

	// Search listings.
	//
	// Search published listings in the Databricks Marketplace that the consumer has
	// access to. This query supports a variety of different search parameters and
	// performs fuzzy matching.
	//
	// This method is generated by Databricks SDK Code Generator.
	Search(ctx context.Context, request SearchListingsRequest) listing.Iterator[Listing]

	// Search listings.
	//
	// Search published listings in the Databricks Marketplace that the consumer has
	// access to. This query supports a variety of different search parameters and
	// performs fuzzy matching.
	//
	// This method is generated by Databricks SDK Code Generator.
	SearchAll(ctx context.Context, request SearchListingsRequest) ([]Listing, error)
}

type ConsumerListingsService

type ConsumerListingsService interface {

	// Get one batch of listings. One may specify up to 50 IDs per request.
	//
	// Batch get a published listing in the Databricks Marketplace that the
	// consumer has access to.
	BatchGet(ctx context.Context, request BatchGetListingsRequest) (*BatchGetListingsResponse, error)

	// Get listing.
	//
	// Get a published listing in the Databricks Marketplace that the consumer
	// has access to.
	Get(ctx context.Context, request GetListingRequest) (*GetListingResponse, error)

	// List listings.
	//
	// List all published listings in the Databricks Marketplace that the
	// consumer has access to.
	//
	// Use ListAll() to get all Listing instances, which will iterate over every result page.
	List(ctx context.Context, request ListListingsRequest) (*ListListingsResponse, error)

	// Search listings.
	//
	// Search published listings in the Databricks Marketplace that the consumer
	// has access to. This query supports a variety of different search
	// parameters and performs fuzzy matching.
	//
	// Use SearchAll() to get all Listing instances, which will iterate over every result page.
	Search(ctx context.Context, request SearchListingsRequest) (*SearchListingsResponse, error)
}

Listings are the core entities in the Marketplace. They represent the products that are available for consumption.

type ConsumerPersonalizationRequestsAPI

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

Personalization Requests allow customers to interact with the individualized Marketplace listing flow.

func (*ConsumerPersonalizationRequestsAPI) Create

Create a personalization request.

Create a personalization request for a listing.

func (*ConsumerPersonalizationRequestsAPI) Get

Get the personalization request for a listing.

Get the personalization request for a listing. Each consumer can make at *most* one personalization request for a listing.

func (*ConsumerPersonalizationRequestsAPI) GetByListingId

Get the personalization request for a listing.

Get the personalization request for a listing. Each consumer can make at *most* one personalization request for a listing.

func (*ConsumerPersonalizationRequestsAPI) Impl

Impl returns low-level ConsumerPersonalizationRequests API implementation Deprecated: use MockConsumerPersonalizationRequestsInterface instead.

func (*ConsumerPersonalizationRequestsAPI) List

List all personalization requests.

List personalization requests for a consumer across all listings.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerPersonalizationRequestsAPI) ListAll

List all personalization requests.

List personalization requests for a consumer across all listings.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerPersonalizationRequestsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockConsumerPersonalizationRequestsInterface instead.

type ConsumerPersonalizationRequestsInterface

type ConsumerPersonalizationRequestsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockConsumerPersonalizationRequestsInterface instead.
	WithImpl(impl ConsumerPersonalizationRequestsService) ConsumerPersonalizationRequestsInterface

	// Impl returns low-level ConsumerPersonalizationRequests API implementation
	// Deprecated: use MockConsumerPersonalizationRequestsInterface instead.
	Impl() ConsumerPersonalizationRequestsService

	// Create a personalization request.
	//
	// Create a personalization request for a listing.
	Create(ctx context.Context, request CreatePersonalizationRequest) (*CreatePersonalizationRequestResponse, error)

	// Get the personalization request for a listing.
	//
	// Get the personalization request for a listing. Each consumer can make at
	// *most* one personalization request for a listing.
	Get(ctx context.Context, request GetPersonalizationRequestRequest) (*GetPersonalizationRequestResponse, error)

	// Get the personalization request for a listing.
	//
	// Get the personalization request for a listing. Each consumer can make at
	// *most* one personalization request for a listing.
	GetByListingId(ctx context.Context, listingId string) (*GetPersonalizationRequestResponse, error)

	// List all personalization requests.
	//
	// List personalization requests for a consumer across all listings.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListAllPersonalizationRequestsRequest) listing.Iterator[PersonalizationRequest]

	// List all personalization requests.
	//
	// List personalization requests for a consumer across all listings.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListAllPersonalizationRequestsRequest) ([]PersonalizationRequest, error)
}

type ConsumerPersonalizationRequestsService

type ConsumerPersonalizationRequestsService interface {

	// Create a personalization request.
	//
	// Create a personalization request for a listing.
	Create(ctx context.Context, request CreatePersonalizationRequest) (*CreatePersonalizationRequestResponse, error)

	// Get the personalization request for a listing.
	//
	// Get the personalization request for a listing. Each consumer can make at
	// *most* one personalization request for a listing.
	Get(ctx context.Context, request GetPersonalizationRequestRequest) (*GetPersonalizationRequestResponse, error)

	// List all personalization requests.
	//
	// List personalization requests for a consumer across all listings.
	//
	// Use ListAll() to get all PersonalizationRequest instances, which will iterate over every result page.
	List(ctx context.Context, request ListAllPersonalizationRequestsRequest) (*ListAllPersonalizationRequestsResponse, error)
}

Personalization Requests allow customers to interact with the individualized Marketplace listing flow.

type ConsumerProvidersAPI

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

Providers are the entities that publish listings to the Marketplace.

func NewConsumerProviders

func NewConsumerProviders(client *client.DatabricksClient) *ConsumerProvidersAPI

func (*ConsumerProvidersAPI) BatchGet added in v0.42.0

Get one batch of providers. One may specify up to 50 IDs per request.

Batch get a provider in the Databricks Marketplace with at least one visible listing.

func (*ConsumerProvidersAPI) Get

Get a provider.

Get a provider in the Databricks Marketplace with at least one visible listing.

func (*ConsumerProvidersAPI) GetById

Get a provider.

Get a provider in the Databricks Marketplace with at least one visible listing.

func (*ConsumerProvidersAPI) GetByName

func (a *ConsumerProvidersAPI) GetByName(ctx context.Context, name string) (*ProviderInfo, error)

GetByName calls ConsumerProvidersAPI.ProviderInfoNameToIdMap and returns a single ProviderInfo.

Returns an error if there's more than one ProviderInfo with the same .Name.

Note: All ProviderInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerProvidersAPI) Impl

Impl returns low-level ConsumerProviders API implementation Deprecated: use MockConsumerProvidersInterface instead.

func (*ConsumerProvidersAPI) List

List providers.

List all providers in the Databricks Marketplace with at least one visible listing.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerProvidersAPI) ListAll

List providers.

List all providers in the Databricks Marketplace with at least one visible listing.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerProvidersAPI) ProviderInfoNameToIdMap

func (a *ConsumerProvidersAPI) ProviderInfoNameToIdMap(ctx context.Context, request ListProvidersRequest) (map[string]string, error)

ProviderInfoNameToIdMap calls ConsumerProvidersAPI.ListAll and creates a map of results with ProviderInfo.Name as key and ProviderInfo.Id as value.

Returns an error if there's more than one ProviderInfo with the same .Name.

Note: All ProviderInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ConsumerProvidersAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockConsumerProvidersInterface instead.

type ConsumerProvidersInterface

type ConsumerProvidersInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockConsumerProvidersInterface instead.
	WithImpl(impl ConsumerProvidersService) ConsumerProvidersInterface

	// Impl returns low-level ConsumerProviders API implementation
	// Deprecated: use MockConsumerProvidersInterface instead.
	Impl() ConsumerProvidersService

	// Get one batch of providers. One may specify up to 50 IDs per request.
	//
	// Batch get a provider in the Databricks Marketplace with at least one visible
	// listing.
	BatchGet(ctx context.Context, request BatchGetProvidersRequest) (*BatchGetProvidersResponse, error)

	// Get a provider.
	//
	// Get a provider in the Databricks Marketplace with at least one visible
	// listing.
	Get(ctx context.Context, request GetProviderRequest) (*GetProviderResponse, error)

	// Get a provider.
	//
	// Get a provider in the Databricks Marketplace with at least one visible
	// listing.
	GetById(ctx context.Context, id string) (*GetProviderResponse, error)

	// List providers.
	//
	// List all providers in the Databricks Marketplace with at least one visible
	// listing.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListProvidersRequest) listing.Iterator[ProviderInfo]

	// List providers.
	//
	// List all providers in the Databricks Marketplace with at least one visible
	// listing.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListProvidersRequest) ([]ProviderInfo, error)

	// ProviderInfoNameToIdMap calls [ConsumerProvidersAPI.ListAll] and creates a map of results with [ProviderInfo].Name as key and [ProviderInfo].Id as value.
	//
	// Returns an error if there's more than one [ProviderInfo] with the same .Name.
	//
	// Note: All [ProviderInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ProviderInfoNameToIdMap(ctx context.Context, request ListProvidersRequest) (map[string]string, error)

	// GetByName calls [ConsumerProvidersAPI.ProviderInfoNameToIdMap] and returns a single [ProviderInfo].
	//
	// Returns an error if there's more than one [ProviderInfo] with the same .Name.
	//
	// Note: All [ProviderInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByName(ctx context.Context, name string) (*ProviderInfo, error)
}

type ConsumerProvidersService

type ConsumerProvidersService interface {

	// Get one batch of providers. One may specify up to 50 IDs per request.
	//
	// Batch get a provider in the Databricks Marketplace with at least one
	// visible listing.
	BatchGet(ctx context.Context, request BatchGetProvidersRequest) (*BatchGetProvidersResponse, error)

	// Get a provider.
	//
	// Get a provider in the Databricks Marketplace with at least one visible
	// listing.
	Get(ctx context.Context, request GetProviderRequest) (*GetProviderResponse, error)

	// List providers.
	//
	// List all providers in the Databricks Marketplace with at least one
	// visible listing.
	//
	// Use ListAll() to get all ProviderInfo instances, which will iterate over every result page.
	List(ctx context.Context, request ListProvidersRequest) (*ListProvidersResponse, error)
}

Providers are the entities that publish listings to the Marketplace.

type ConsumerTerms

type ConsumerTerms struct {
	Version string `json:"version"`
}

type ContactInfo

type ContactInfo struct {
	Company string `json:"company,omitempty"`

	Email string `json:"email,omitempty"`

	FirstName string `json:"first_name,omitempty"`

	LastName string `json:"last_name,omitempty"`

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

contact info for the consumer requesting data or performing a listing installation

func (ContactInfo) MarshalJSON

func (s ContactInfo) MarshalJSON() ([]byte, error)

func (*ContactInfo) UnmarshalJSON

func (s *ContactInfo) UnmarshalJSON(b []byte) error

type Cost

type Cost string
const CostFree Cost = `FREE`
const CostPaid Cost = `PAID`

func (*Cost) Set

func (f *Cost) Set(v string) error

Set raw string value and validate it against allowed values

func (*Cost) String

func (f *Cost) String() string

String representation for fmt.Print

func (*Cost) Type

func (f *Cost) Type() string

Type always returns Cost to satisfy [pflag.Value] interface

type CreateExchangeFilterRequest

type CreateExchangeFilterRequest struct {
	Filter ExchangeFilter `json:"filter"`
}

type CreateExchangeFilterResponse

type CreateExchangeFilterResponse struct {
	FilterId string `json:"filter_id,omitempty"`

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

func (CreateExchangeFilterResponse) MarshalJSON

func (s CreateExchangeFilterResponse) MarshalJSON() ([]byte, error)

func (*CreateExchangeFilterResponse) UnmarshalJSON

func (s *CreateExchangeFilterResponse) UnmarshalJSON(b []byte) error

type CreateExchangeRequest

type CreateExchangeRequest struct {
	Exchange Exchange `json:"exchange"`
}

type CreateExchangeResponse

type CreateExchangeResponse struct {
	ExchangeId string `json:"exchange_id,omitempty"`

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

func (CreateExchangeResponse) MarshalJSON

func (s CreateExchangeResponse) MarshalJSON() ([]byte, error)

func (*CreateExchangeResponse) UnmarshalJSON

func (s *CreateExchangeResponse) UnmarshalJSON(b []byte) error

type CreateFileRequest

type CreateFileRequest struct {
	DisplayName string `json:"display_name,omitempty"`

	FileParent FileParent `json:"file_parent"`

	MarketplaceFileType MarketplaceFileType `json:"marketplace_file_type"`

	MimeType string `json:"mime_type"`

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

func (CreateFileRequest) MarshalJSON

func (s CreateFileRequest) MarshalJSON() ([]byte, error)

func (*CreateFileRequest) UnmarshalJSON

func (s *CreateFileRequest) UnmarshalJSON(b []byte) error

type CreateFileResponse

type CreateFileResponse struct {
	FileInfo *FileInfo `json:"file_info,omitempty"`
	// Pre-signed POST URL to blob storage
	UploadUrl string `json:"upload_url,omitempty"`

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

func (CreateFileResponse) MarshalJSON

func (s CreateFileResponse) MarshalJSON() ([]byte, error)

func (*CreateFileResponse) UnmarshalJSON

func (s *CreateFileResponse) UnmarshalJSON(b []byte) error

type CreateInstallationRequest

type CreateInstallationRequest struct {
	AcceptedConsumerTerms *ConsumerTerms `json:"accepted_consumer_terms,omitempty"`

	CatalogName string `json:"catalog_name,omitempty"`

	ListingId string `json:"-" url:"-"`

	RecipientType DeltaSharingRecipientType `json:"recipient_type,omitempty"`
	// for git repo installations
	RepoDetail *RepoInstallation `json:"repo_detail,omitempty"`

	ShareName string `json:"share_name,omitempty"`

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

func (CreateInstallationRequest) MarshalJSON

func (s CreateInstallationRequest) MarshalJSON() ([]byte, error)

func (*CreateInstallationRequest) UnmarshalJSON

func (s *CreateInstallationRequest) UnmarshalJSON(b []byte) error

type CreateListingRequest

type CreateListingRequest struct {
	Listing Listing `json:"listing"`
}

type CreateListingResponse

type CreateListingResponse struct {
	ListingId string `json:"listing_id,omitempty"`

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

func (CreateListingResponse) MarshalJSON

func (s CreateListingResponse) MarshalJSON() ([]byte, error)

func (*CreateListingResponse) UnmarshalJSON

func (s *CreateListingResponse) UnmarshalJSON(b []byte) error

type CreatePersonalizationRequest

type CreatePersonalizationRequest struct {
	AcceptedConsumerTerms ConsumerTerms `json:"accepted_consumer_terms"`

	Comment string `json:"comment,omitempty"`

	Company string `json:"company,omitempty"`

	FirstName string `json:"first_name,omitempty"`

	IntendedUse string `json:"intended_use"`

	IsFromLighthouse bool `json:"is_from_lighthouse,omitempty"`

	LastName string `json:"last_name,omitempty"`

	ListingId string `json:"-" url:"-"`

	RecipientType DeltaSharingRecipientType `json:"recipient_type,omitempty"`

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

Data request messages also creates a lead (maybe)

func (CreatePersonalizationRequest) MarshalJSON

func (s CreatePersonalizationRequest) MarshalJSON() ([]byte, error)

func (*CreatePersonalizationRequest) UnmarshalJSON

func (s *CreatePersonalizationRequest) UnmarshalJSON(b []byte) error

type CreatePersonalizationRequestResponse

type CreatePersonalizationRequestResponse struct {
	Id string `json:"id,omitempty"`

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

func (CreatePersonalizationRequestResponse) MarshalJSON

func (s CreatePersonalizationRequestResponse) MarshalJSON() ([]byte, error)

func (*CreatePersonalizationRequestResponse) UnmarshalJSON

func (s *CreatePersonalizationRequestResponse) UnmarshalJSON(b []byte) error

type CreateProviderRequest

type CreateProviderRequest struct {
	Provider ProviderInfo `json:"provider"`
}

type CreateProviderResponse

type CreateProviderResponse struct {
	Id string `json:"id,omitempty"`

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

func (CreateProviderResponse) MarshalJSON

func (s CreateProviderResponse) MarshalJSON() ([]byte, error)

func (*CreateProviderResponse) UnmarshalJSON

func (s *CreateProviderResponse) UnmarshalJSON(b []byte) error

type DataRefresh

type DataRefresh string
const DataRefreshDaily DataRefresh = `DAILY`
const DataRefreshHourly DataRefresh = `HOURLY`
const DataRefreshMinute DataRefresh = `MINUTE`
const DataRefreshMonthly DataRefresh = `MONTHLY`
const DataRefreshNone DataRefresh = `NONE`
const DataRefreshQuarterly DataRefresh = `QUARTERLY`
const DataRefreshSecond DataRefresh = `SECOND`
const DataRefreshWeekly DataRefresh = `WEEKLY`
const DataRefreshYearly DataRefresh = `YEARLY`

func (*DataRefresh) Set

func (f *DataRefresh) Set(v string) error

Set raw string value and validate it against allowed values

func (*DataRefresh) String

func (f *DataRefresh) String() string

String representation for fmt.Print

func (*DataRefresh) Type

func (f *DataRefresh) Type() string

Type always returns DataRefresh to satisfy [pflag.Value] interface

type DataRefreshInfo

type DataRefreshInfo struct {
	Interval int64 `json:"interval"`

	Unit DataRefresh `json:"unit"`
}

type DeleteExchangeFilterRequest

type DeleteExchangeFilterRequest struct {
	Id string `json:"-" url:"-"`
}

Delete an exchange filter

type DeleteExchangeFilterResponse

type DeleteExchangeFilterResponse struct {
}

type DeleteExchangeRequest

type DeleteExchangeRequest struct {
	Id string `json:"-" url:"-"`
}

Delete an exchange

type DeleteExchangeResponse

type DeleteExchangeResponse struct {
}

type DeleteFileRequest

type DeleteFileRequest struct {
	FileId string `json:"-" url:"-"`
}

Delete a file

type DeleteFileResponse

type DeleteFileResponse struct {
}

type DeleteInstallationRequest

type DeleteInstallationRequest struct {
	InstallationId string `json:"-" url:"-"`

	ListingId string `json:"-" url:"-"`
}

Uninstall from a listing

type DeleteInstallationResponse

type DeleteInstallationResponse struct {
}

type DeleteListingRequest

type DeleteListingRequest struct {
	Id string `json:"-" url:"-"`
}

Delete a listing

type DeleteListingResponse

type DeleteListingResponse struct {
}

type DeleteProviderRequest

type DeleteProviderRequest struct {
	Id string `json:"-" url:"-"`
}

Delete provider

type DeleteProviderResponse

type DeleteProviderResponse struct {
}

type DeltaSharingRecipientType

type DeltaSharingRecipientType string
const DeltaSharingRecipientTypeDeltaSharingRecipientTypeDatabricks DeltaSharingRecipientType = `DELTA_SHARING_RECIPIENT_TYPE_DATABRICKS`
const DeltaSharingRecipientTypeDeltaSharingRecipientTypeOpen DeltaSharingRecipientType = `DELTA_SHARING_RECIPIENT_TYPE_OPEN`

func (*DeltaSharingRecipientType) Set

Set raw string value and validate it against allowed values

func (*DeltaSharingRecipientType) String

func (f *DeltaSharingRecipientType) String() string

String representation for fmt.Print

func (*DeltaSharingRecipientType) Type

Type always returns DeltaSharingRecipientType to satisfy [pflag.Value] interface

type Exchange

type Exchange struct {
	Comment string `json:"comment,omitempty"`

	CreatedAt int64 `json:"created_at,omitempty"`

	CreatedBy string `json:"created_by,omitempty"`

	Filters []ExchangeFilter `json:"filters,omitempty"`

	Id string `json:"id,omitempty"`

	LinkedListings []ExchangeListing `json:"linked_listings,omitempty"`

	Name string `json:"name"`

	UpdatedAt int64 `json:"updated_at,omitempty"`

	UpdatedBy string `json:"updated_by,omitempty"`

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

func (Exchange) MarshalJSON

func (s Exchange) MarshalJSON() ([]byte, error)

func (*Exchange) UnmarshalJSON

func (s *Exchange) UnmarshalJSON(b []byte) error

type ExchangeFilter

type ExchangeFilter struct {
	CreatedAt int64 `json:"created_at,omitempty"`

	CreatedBy string `json:"created_by,omitempty"`

	ExchangeId string `json:"exchange_id"`

	FilterType ExchangeFilterType `json:"filter_type"`

	FilterValue string `json:"filter_value"`

	Id string `json:"id,omitempty"`

	Name string `json:"name,omitempty"`

	UpdatedAt int64 `json:"updated_at,omitempty"`

	UpdatedBy string `json:"updated_by,omitempty"`

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

func (ExchangeFilter) MarshalJSON

func (s ExchangeFilter) MarshalJSON() ([]byte, error)

func (*ExchangeFilter) UnmarshalJSON

func (s *ExchangeFilter) UnmarshalJSON(b []byte) error

type ExchangeFilterType

type ExchangeFilterType string
const ExchangeFilterTypeGlobalMetastoreId ExchangeFilterType = `GLOBAL_METASTORE_ID`

func (*ExchangeFilterType) Set

func (f *ExchangeFilterType) Set(v string) error

Set raw string value and validate it against allowed values

func (*ExchangeFilterType) String

func (f *ExchangeFilterType) String() string

String representation for fmt.Print

func (*ExchangeFilterType) Type

func (f *ExchangeFilterType) Type() string

Type always returns ExchangeFilterType to satisfy [pflag.Value] interface

type ExchangeListing

type ExchangeListing struct {
	CreatedAt int64 `json:"created_at,omitempty"`

	CreatedBy string `json:"created_by,omitempty"`

	ExchangeId string `json:"exchange_id,omitempty"`

	ExchangeName string `json:"exchange_name,omitempty"`

	Id string `json:"id,omitempty"`

	ListingId string `json:"listing_id,omitempty"`

	ListingName string `json:"listing_name,omitempty"`

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

func (ExchangeListing) MarshalJSON

func (s ExchangeListing) MarshalJSON() ([]byte, error)

func (*ExchangeListing) UnmarshalJSON

func (s *ExchangeListing) UnmarshalJSON(b []byte) error

type FileInfo

type FileInfo struct {
	CreatedAt int64 `json:"created_at,omitempty"`
	// Name displayed to users for applicable files, e.g. embedded notebooks
	DisplayName string `json:"display_name,omitempty"`

	DownloadLink string `json:"download_link,omitempty"`

	FileParent *FileParent `json:"file_parent,omitempty"`

	Id string `json:"id,omitempty"`

	MarketplaceFileType MarketplaceFileType `json:"marketplace_file_type,omitempty"`

	MimeType string `json:"mime_type,omitempty"`

	Status FileStatus `json:"status,omitempty"`
	// Populated if status is in a failed state with more information on reason
	// for the failure.
	StatusMessage string `json:"status_message,omitempty"`

	UpdatedAt int64 `json:"updated_at,omitempty"`

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

func (FileInfo) MarshalJSON

func (s FileInfo) MarshalJSON() ([]byte, error)

func (*FileInfo) UnmarshalJSON

func (s *FileInfo) UnmarshalJSON(b []byte) error

type FileParent

type FileParent struct {
	FileParentType FileParentType `json:"file_parent_type,omitempty"`
	// TODO make the following fields required
	ParentId string `json:"parent_id,omitempty"`

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

func (FileParent) MarshalJSON

func (s FileParent) MarshalJSON() ([]byte, error)

func (*FileParent) UnmarshalJSON

func (s *FileParent) UnmarshalJSON(b []byte) error

type FileParentType

type FileParentType string
const FileParentTypeListing FileParentType = `LISTING`
const FileParentTypeProvider FileParentType = `PROVIDER`

func (*FileParentType) Set

func (f *FileParentType) Set(v string) error

Set raw string value and validate it against allowed values

func (*FileParentType) String

func (f *FileParentType) String() string

String representation for fmt.Print

func (*FileParentType) Type

func (f *FileParentType) Type() string

Type always returns FileParentType to satisfy [pflag.Value] interface

type FileStatus

type FileStatus string
const FileStatusFileStatusPublished FileStatus = `FILE_STATUS_PUBLISHED`
const FileStatusFileStatusSanitizationFailed FileStatus = `FILE_STATUS_SANITIZATION_FAILED`
const FileStatusFileStatusSanitizing FileStatus = `FILE_STATUS_SANITIZING`
const FileStatusFileStatusStaging FileStatus = `FILE_STATUS_STAGING`

func (*FileStatus) Set

func (f *FileStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*FileStatus) String

func (f *FileStatus) String() string

String representation for fmt.Print

func (*FileStatus) Type

func (f *FileStatus) Type() string

Type always returns FileStatus to satisfy [pflag.Value] interface

type FilterType

type FilterType string
const FilterTypeMetastore FilterType = `METASTORE`

func (*FilterType) Set

func (f *FilterType) Set(v string) error

Set raw string value and validate it against allowed values

func (*FilterType) String

func (f *FilterType) String() string

String representation for fmt.Print

func (*FilterType) Type

func (f *FilterType) Type() string

Type always returns FilterType to satisfy [pflag.Value] interface

type FulfillmentType

type FulfillmentType string
const FulfillmentTypeInstall FulfillmentType = `INSTALL`
const FulfillmentTypeRequestAccess FulfillmentType = `REQUEST_ACCESS`

func (*FulfillmentType) Set

func (f *FulfillmentType) Set(v string) error

Set raw string value and validate it against allowed values

func (*FulfillmentType) String

func (f *FulfillmentType) String() string

String representation for fmt.Print

func (*FulfillmentType) Type

func (f *FulfillmentType) Type() string

Type always returns FulfillmentType to satisfy [pflag.Value] interface

type GetExchangeRequest

type GetExchangeRequest struct {
	Id string `json:"-" url:"-"`
}

Get an exchange

type GetExchangeResponse

type GetExchangeResponse struct {
	Exchange *Exchange `json:"exchange,omitempty"`
}

type GetFileRequest

type GetFileRequest struct {
	FileId string `json:"-" url:"-"`
}

Get a file

type GetFileResponse

type GetFileResponse struct {
	FileInfo *FileInfo `json:"file_info,omitempty"`
}

type GetLatestVersionProviderAnalyticsDashboardResponse

type GetLatestVersionProviderAnalyticsDashboardResponse struct {
	// version here is latest logical version of the dashboard template
	Version int64 `json:"version,omitempty"`

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

func (GetLatestVersionProviderAnalyticsDashboardResponse) MarshalJSON

func (*GetLatestVersionProviderAnalyticsDashboardResponse) UnmarshalJSON

type GetListingContentMetadataRequest

type GetListingContentMetadataRequest struct {
	ListingId string `json:"-" url:"-"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

Get listing content metadata

func (GetListingContentMetadataRequest) MarshalJSON

func (s GetListingContentMetadataRequest) MarshalJSON() ([]byte, error)

func (*GetListingContentMetadataRequest) UnmarshalJSON

func (s *GetListingContentMetadataRequest) UnmarshalJSON(b []byte) error

type GetListingContentMetadataResponse

type GetListingContentMetadataResponse struct {
	NextPageToken string `json:"next_page_token,omitempty"`

	SharedDataObjects []SharedDataObject `json:"shared_data_objects,omitempty"`

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

func (GetListingContentMetadataResponse) MarshalJSON

func (s GetListingContentMetadataResponse) MarshalJSON() ([]byte, error)

func (*GetListingContentMetadataResponse) UnmarshalJSON

func (s *GetListingContentMetadataResponse) UnmarshalJSON(b []byte) error

type GetListingRequest

type GetListingRequest struct {
	Id string `json:"-" url:"-"`
}

Get listing

type GetListingResponse

type GetListingResponse struct {
	Listing *Listing `json:"listing,omitempty"`
}

type GetListingsRequest

type GetListingsRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List listings

func (GetListingsRequest) MarshalJSON

func (s GetListingsRequest) MarshalJSON() ([]byte, error)

func (*GetListingsRequest) UnmarshalJSON

func (s *GetListingsRequest) UnmarshalJSON(b []byte) error

type GetListingsResponse

type GetListingsResponse struct {
	Listings []Listing `json:"listings,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (GetListingsResponse) MarshalJSON

func (s GetListingsResponse) MarshalJSON() ([]byte, error)

func (*GetListingsResponse) UnmarshalJSON

func (s *GetListingsResponse) UnmarshalJSON(b []byte) error

type GetPersonalizationRequestRequest

type GetPersonalizationRequestRequest struct {
	ListingId string `json:"-" url:"-"`
}

Get the personalization request for a listing

type GetPersonalizationRequestResponse

type GetPersonalizationRequestResponse struct {
	PersonalizationRequests []PersonalizationRequest `json:"personalization_requests,omitempty"`
}

type GetProviderRequest

type GetProviderRequest struct {
	Id string `json:"-" url:"-"`
}

Get a provider

type GetProviderResponse

type GetProviderResponse struct {
	Provider *ProviderInfo `json:"provider,omitempty"`
}

type Installation

type Installation struct {
	Installation *InstallationDetail `json:"installation,omitempty"`
}

type InstallationDetail

type InstallationDetail struct {
	CatalogName string `json:"catalog_name,omitempty"`

	ErrorMessage string `json:"error_message,omitempty"`

	Id string `json:"id,omitempty"`

	InstalledOn int64 `json:"installed_on,omitempty"`

	ListingId string `json:"listing_id,omitempty"`

	ListingName string `json:"listing_name,omitempty"`

	RecipientType DeltaSharingRecipientType `json:"recipient_type,omitempty"`

	RepoName string `json:"repo_name,omitempty"`

	RepoPath string `json:"repo_path,omitempty"`

	ShareName string `json:"share_name,omitempty"`

	Status InstallationStatus `json:"status,omitempty"`

	TokenDetail *TokenDetail `json:"token_detail,omitempty"`

	Tokens []TokenInfo `json:"tokens,omitempty"`

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

func (InstallationDetail) MarshalJSON

func (s InstallationDetail) MarshalJSON() ([]byte, error)

func (*InstallationDetail) UnmarshalJSON

func (s *InstallationDetail) UnmarshalJSON(b []byte) error

type InstallationStatus

type InstallationStatus string
const InstallationStatusFailed InstallationStatus = `FAILED`
const InstallationStatusInstalled InstallationStatus = `INSTALLED`

func (*InstallationStatus) Set

func (f *InstallationStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*InstallationStatus) String

func (f *InstallationStatus) String() string

String representation for fmt.Print

func (*InstallationStatus) Type

func (f *InstallationStatus) Type() string

Type always returns InstallationStatus to satisfy [pflag.Value] interface

type ListAllInstallationsRequest

type ListAllInstallationsRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List all installations

func (ListAllInstallationsRequest) MarshalJSON

func (s ListAllInstallationsRequest) MarshalJSON() ([]byte, error)

func (*ListAllInstallationsRequest) UnmarshalJSON

func (s *ListAllInstallationsRequest) UnmarshalJSON(b []byte) error

type ListAllInstallationsResponse

type ListAllInstallationsResponse struct {
	Installations []InstallationDetail `json:"installations,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListAllInstallationsResponse) MarshalJSON

func (s ListAllInstallationsResponse) MarshalJSON() ([]byte, error)

func (*ListAllInstallationsResponse) UnmarshalJSON

func (s *ListAllInstallationsResponse) UnmarshalJSON(b []byte) error

type ListAllPersonalizationRequestsRequest

type ListAllPersonalizationRequestsRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List all personalization requests

func (ListAllPersonalizationRequestsRequest) MarshalJSON

func (s ListAllPersonalizationRequestsRequest) MarshalJSON() ([]byte, error)

func (*ListAllPersonalizationRequestsRequest) UnmarshalJSON

func (s *ListAllPersonalizationRequestsRequest) UnmarshalJSON(b []byte) error

type ListAllPersonalizationRequestsResponse

type ListAllPersonalizationRequestsResponse struct {
	NextPageToken string `json:"next_page_token,omitempty"`

	PersonalizationRequests []PersonalizationRequest `json:"personalization_requests,omitempty"`

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

func (ListAllPersonalizationRequestsResponse) MarshalJSON

func (s ListAllPersonalizationRequestsResponse) MarshalJSON() ([]byte, error)

func (*ListAllPersonalizationRequestsResponse) UnmarshalJSON

func (s *ListAllPersonalizationRequestsResponse) UnmarshalJSON(b []byte) error

type ListExchangeFiltersRequest

type ListExchangeFiltersRequest struct {
	ExchangeId string `json:"-" url:"exchange_id"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List exchange filters

func (ListExchangeFiltersRequest) MarshalJSON

func (s ListExchangeFiltersRequest) MarshalJSON() ([]byte, error)

func (*ListExchangeFiltersRequest) UnmarshalJSON

func (s *ListExchangeFiltersRequest) UnmarshalJSON(b []byte) error

type ListExchangeFiltersResponse

type ListExchangeFiltersResponse struct {
	Filters []ExchangeFilter `json:"filters,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListExchangeFiltersResponse) MarshalJSON

func (s ListExchangeFiltersResponse) MarshalJSON() ([]byte, error)

func (*ListExchangeFiltersResponse) UnmarshalJSON

func (s *ListExchangeFiltersResponse) UnmarshalJSON(b []byte) error

type ListExchangesForListingRequest

type ListExchangesForListingRequest struct {
	ListingId string `json:"-" url:"listing_id"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List exchanges for listing

func (ListExchangesForListingRequest) MarshalJSON

func (s ListExchangesForListingRequest) MarshalJSON() ([]byte, error)

func (*ListExchangesForListingRequest) UnmarshalJSON

func (s *ListExchangesForListingRequest) UnmarshalJSON(b []byte) error

type ListExchangesForListingResponse

type ListExchangesForListingResponse struct {
	ExchangeListing []ExchangeListing `json:"exchange_listing,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListExchangesForListingResponse) MarshalJSON

func (s ListExchangesForListingResponse) MarshalJSON() ([]byte, error)

func (*ListExchangesForListingResponse) UnmarshalJSON

func (s *ListExchangesForListingResponse) UnmarshalJSON(b []byte) error

type ListExchangesRequest

type ListExchangesRequest struct {
	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List exchanges

func (ListExchangesRequest) MarshalJSON

func (s ListExchangesRequest) MarshalJSON() ([]byte, error)

func (*ListExchangesRequest) UnmarshalJSON

func (s *ListExchangesRequest) UnmarshalJSON(b []byte) error

type ListExchangesResponse

type ListExchangesResponse struct {
	Exchanges []Exchange `json:"exchanges,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListExchangesResponse) MarshalJSON

func (s ListExchangesResponse) MarshalJSON() ([]byte, error)

func (*ListExchangesResponse) UnmarshalJSON

func (s *ListExchangesResponse) UnmarshalJSON(b []byte) error

type ListFilesRequest

type ListFilesRequest struct {
	FileParent FileParent `json:"-" url:"file_parent"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List files

func (ListFilesRequest) MarshalJSON

func (s ListFilesRequest) MarshalJSON() ([]byte, error)

func (*ListFilesRequest) UnmarshalJSON

func (s *ListFilesRequest) UnmarshalJSON(b []byte) error

type ListFilesResponse

type ListFilesResponse struct {
	FileInfos []FileInfo `json:"file_infos,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListFilesResponse) MarshalJSON

func (s ListFilesResponse) MarshalJSON() ([]byte, error)

func (*ListFilesResponse) UnmarshalJSON

func (s *ListFilesResponse) UnmarshalJSON(b []byte) error

type ListFulfillmentsRequest

type ListFulfillmentsRequest struct {
	ListingId string `json:"-" url:"-"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List all listing fulfillments

func (ListFulfillmentsRequest) MarshalJSON

func (s ListFulfillmentsRequest) MarshalJSON() ([]byte, error)

func (*ListFulfillmentsRequest) UnmarshalJSON

func (s *ListFulfillmentsRequest) UnmarshalJSON(b []byte) error

type ListFulfillmentsResponse

type ListFulfillmentsResponse struct {
	Fulfillments []ListingFulfillment `json:"fulfillments,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListFulfillmentsResponse) MarshalJSON

func (s ListFulfillmentsResponse) MarshalJSON() ([]byte, error)

func (*ListFulfillmentsResponse) UnmarshalJSON

func (s *ListFulfillmentsResponse) UnmarshalJSON(b []byte) error

type ListInstallationsRequest

type ListInstallationsRequest struct {
	ListingId string `json:"-" url:"-"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List installations for a listing

func (ListInstallationsRequest) MarshalJSON

func (s ListInstallationsRequest) MarshalJSON() ([]byte, error)

func (*ListInstallationsRequest) UnmarshalJSON

func (s *ListInstallationsRequest) UnmarshalJSON(b []byte) error

type ListInstallationsResponse

type ListInstallationsResponse struct {
	Installations []InstallationDetail `json:"installations,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListInstallationsResponse) MarshalJSON

func (s ListInstallationsResponse) MarshalJSON() ([]byte, error)

func (*ListInstallationsResponse) UnmarshalJSON

func (s *ListInstallationsResponse) UnmarshalJSON(b []byte) error

type ListListingsForExchangeRequest

type ListListingsForExchangeRequest struct {
	ExchangeId string `json:"-" url:"exchange_id"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List listings for exchange

func (ListListingsForExchangeRequest) MarshalJSON

func (s ListListingsForExchangeRequest) MarshalJSON() ([]byte, error)

func (*ListListingsForExchangeRequest) UnmarshalJSON

func (s *ListListingsForExchangeRequest) UnmarshalJSON(b []byte) error

type ListListingsForExchangeResponse

type ListListingsForExchangeResponse struct {
	ExchangeListings []ExchangeListing `json:"exchange_listings,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListListingsForExchangeResponse) MarshalJSON

func (s ListListingsForExchangeResponse) MarshalJSON() ([]byte, error)

func (*ListListingsForExchangeResponse) UnmarshalJSON

func (s *ListListingsForExchangeResponse) UnmarshalJSON(b []byte) error

type ListListingsRequest

type ListListingsRequest struct {
	// Matches any of the following asset types
	Assets []AssetType `json:"-" url:"assets,omitempty"`
	// Matches any of the following categories
	Categories []Category `json:"-" url:"categories,omitempty"`

	IsAscending bool `json:"-" url:"is_ascending,omitempty"`
	// Filters each listing based on if it is free.
	IsFree bool `json:"-" url:"is_free,omitempty"`
	// Filters each listing based on if it is a private exchange.
	IsPrivateExchange bool `json:"-" url:"is_private_exchange,omitempty"`
	// Filters each listing based on whether it is a staff pick.
	IsStaffPick bool `json:"-" url:"is_staff_pick,omitempty"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`
	// Matches any of the following provider ids
	ProviderIds []string `json:"-" url:"provider_ids,omitempty"`
	// Criteria for sorting the resulting set of listings.
	SortBy SortBy `json:"-" url:"sort_by,omitempty"`
	// Matches any of the following tags
	Tags []ListingTag `json:"-" url:"tags,omitempty"`

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

List listings

func (ListListingsRequest) MarshalJSON

func (s ListListingsRequest) MarshalJSON() ([]byte, error)

func (*ListListingsRequest) UnmarshalJSON

func (s *ListListingsRequest) UnmarshalJSON(b []byte) error

type ListListingsResponse

type ListListingsResponse struct {
	Listings []Listing `json:"listings,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (ListListingsResponse) MarshalJSON

func (s ListListingsResponse) MarshalJSON() ([]byte, error)

func (*ListListingsResponse) UnmarshalJSON

func (s *ListListingsResponse) UnmarshalJSON(b []byte) error

type ListProviderAnalyticsDashboardResponse

type ListProviderAnalyticsDashboardResponse struct {
	// dashboard_id will be used to open Lakeview dashboard.
	DashboardId string `json:"dashboard_id"`

	Id string `json:"id"`

	Version int64 `json:"version,omitempty"`

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

func (ListProviderAnalyticsDashboardResponse) MarshalJSON

func (s ListProviderAnalyticsDashboardResponse) MarshalJSON() ([]byte, error)

func (*ListProviderAnalyticsDashboardResponse) UnmarshalJSON

func (s *ListProviderAnalyticsDashboardResponse) UnmarshalJSON(b []byte) error

type ListProvidersRequest

type ListProvidersRequest struct {
	IsFeatured bool `json:"-" url:"is_featured,omitempty"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`

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

List providers

func (ListProvidersRequest) MarshalJSON

func (s ListProvidersRequest) MarshalJSON() ([]byte, error)

func (*ListProvidersRequest) UnmarshalJSON

func (s *ListProvidersRequest) UnmarshalJSON(b []byte) error

type ListProvidersResponse

type ListProvidersResponse struct {
	NextPageToken string `json:"next_page_token,omitempty"`

	Providers []ProviderInfo `json:"providers,omitempty"`

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

func (ListProvidersResponse) MarshalJSON

func (s ListProvidersResponse) MarshalJSON() ([]byte, error)

func (*ListProvidersResponse) UnmarshalJSON

func (s *ListProvidersResponse) UnmarshalJSON(b []byte) error

type Listing

type Listing struct {
	Detail *ListingDetail `json:"detail,omitempty"`

	Id string `json:"id,omitempty"`
	// Next Number: 26
	Summary ListingSummary `json:"summary"`

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

func (Listing) MarshalJSON

func (s Listing) MarshalJSON() ([]byte, error)

func (*Listing) UnmarshalJSON

func (s *Listing) UnmarshalJSON(b []byte) error

type ListingDetail

type ListingDetail struct {
	// Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL,
	// NOTEBOOK
	Assets []AssetType `json:"assets,omitempty"`
	// The ending date timestamp for when the data spans
	CollectionDateEnd int64 `json:"collection_date_end,omitempty"`
	// The starting date timestamp for when the data spans
	CollectionDateStart int64 `json:"collection_date_start,omitempty"`
	// Smallest unit of time in the dataset
	CollectionGranularity *DataRefreshInfo `json:"collection_granularity,omitempty"`
	// Whether the dataset is free or paid
	Cost Cost `json:"cost,omitempty"`
	// Where/how the data is sourced
	DataSource string `json:"data_source,omitempty"`

	Description string `json:"description,omitempty"`

	DocumentationLink string `json:"documentation_link,omitempty"`

	EmbeddedNotebookFileInfos []FileInfo `json:"embedded_notebook_file_infos,omitempty"`

	FileIds []string `json:"file_ids,omitempty"`
	// Which geo region the listing data is collected from
	GeographicalCoverage string `json:"geographical_coverage,omitempty"`
	// ID 20, 21 removed don't use License of the data asset - Required for
	// listings with model based assets
	License string `json:"license,omitempty"`
	// What the pricing model is (e.g. paid, subscription, paid upfront); should
	// only be present if cost is paid TODO: Not used yet, should deprecate if
	// we will never use it
	PricingModel string `json:"pricing_model,omitempty"`

	PrivacyPolicyLink string `json:"privacy_policy_link,omitempty"`
	// size of the dataset in GB
	Size float64 `json:"size,omitempty"`

	SupportLink string `json:"support_link,omitempty"`
	// Listing tags - Simple key value pair to annotate listings. When should I
	// use tags vs dedicated fields? Using tags avoids the need to add new
	// columns in the database for new annotations. However, this should be used
	// sparingly since tags are stored as key value pair. Use tags only: 1. If
	// the field is optional and won't need to have NOT NULL integrity check 2.
	// The value is fairly fixed, static and low cardinality (eg. enums). 3. The
	// value won't be used in filters or joins with other tables.
	Tags []ListingTag `json:"tags,omitempty"`

	TermsOfService string `json:"terms_of_service,omitempty"`
	// How often data is updated
	UpdateFrequency *DataRefreshInfo `json:"update_frequency,omitempty"`

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

func (ListingDetail) MarshalJSON

func (s ListingDetail) MarshalJSON() ([]byte, error)

func (*ListingDetail) UnmarshalJSON

func (s *ListingDetail) UnmarshalJSON(b []byte) error

type ListingFulfillment

type ListingFulfillment struct {
	FulfillmentType FulfillmentType `json:"fulfillment_type,omitempty"`

	ListingId string `json:"listing_id"`

	RecipientType DeltaSharingRecipientType `json:"recipient_type,omitempty"`

	RepoInfo *RepoInfo `json:"repo_info,omitempty"`

	ShareInfo *ShareInfo `json:"share_info,omitempty"`
}

type ListingSetting

type ListingSetting struct {
	// filters are joined with `or` conjunction.
	Filters []VisibilityFilter `json:"filters,omitempty"`

	Visibility Visibility `json:"visibility,omitempty"`
}

type ListingShareType

type ListingShareType string
const ListingShareTypeFull ListingShareType = `FULL`
const ListingShareTypeSample ListingShareType = `SAMPLE`

func (*ListingShareType) Set

func (f *ListingShareType) Set(v string) error

Set raw string value and validate it against allowed values

func (*ListingShareType) String

func (f *ListingShareType) String() string

String representation for fmt.Print

func (*ListingShareType) Type

func (f *ListingShareType) Type() string

Type always returns ListingShareType to satisfy [pflag.Value] interface

type ListingStatus

type ListingStatus string

Enums

const ListingStatusDraft ListingStatus = `DRAFT`
const ListingStatusPending ListingStatus = `PENDING`
const ListingStatusPublished ListingStatus = `PUBLISHED`
const ListingStatusSuspended ListingStatus = `SUSPENDED`

func (*ListingStatus) Set

func (f *ListingStatus) Set(v string) error

Set raw string value and validate it against allowed values

func (*ListingStatus) String

func (f *ListingStatus) String() string

String representation for fmt.Print

func (*ListingStatus) Type

func (f *ListingStatus) Type() string

Type always returns ListingStatus to satisfy [pflag.Value] interface

type ListingSummary

type ListingSummary struct {
	Categories []Category `json:"categories,omitempty"`

	CreatedAt int64 `json:"created_at,omitempty"`

	CreatedBy string `json:"created_by,omitempty"`

	CreatedById int64 `json:"created_by_id,omitempty"`

	ExchangeIds []string `json:"exchange_ids,omitempty"`
	// if a git repo is being created, a listing will be initialized with this
	// field as opposed to a share
	GitRepo *RepoInfo `json:"git_repo,omitempty"`

	ListingType ListingType `json:"listingType"`

	MetastoreId string `json:"metastore_id,omitempty"`

	Name string `json:"name"`

	ProviderId string `json:"provider_id,omitempty"`

	ProviderRegion *RegionInfo `json:"provider_region,omitempty"`

	PublishedAt int64 `json:"published_at,omitempty"`

	PublishedBy string `json:"published_by,omitempty"`

	Setting *ListingSetting `json:"setting,omitempty"`

	Share *ShareInfo `json:"share,omitempty"`
	// Enums
	Status ListingStatus `json:"status,omitempty"`

	Subtitle string `json:"subtitle,omitempty"`

	UpdatedAt int64 `json:"updated_at,omitempty"`

	UpdatedBy string `json:"updated_by,omitempty"`

	UpdatedById int64 `json:"updated_by_id,omitempty"`

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

Next Number: 26

func (ListingSummary) MarshalJSON

func (s ListingSummary) MarshalJSON() ([]byte, error)

func (*ListingSummary) UnmarshalJSON

func (s *ListingSummary) UnmarshalJSON(b []byte) error

type ListingTag

type ListingTag struct {
	// Tag name (enum)
	TagName ListingTagType `json:"tag_name,omitempty"`
	// String representation of the tag value. Values should be string literals
	// (no complex types)
	TagValues []string `json:"tag_values,omitempty"`
}

type ListingTagType

type ListingTagType string
const ListingTagTypeListingTagTypeLanguage ListingTagType = `LISTING_TAG_TYPE_LANGUAGE`
const ListingTagTypeListingTagTypeTask ListingTagType = `LISTING_TAG_TYPE_TASK`
const ListingTagTypeListingTagTypeUnspecified ListingTagType = `LISTING_TAG_TYPE_UNSPECIFIED`

func (*ListingTagType) Set

func (f *ListingTagType) Set(v string) error

Set raw string value and validate it against allowed values

func (*ListingTagType) String

func (f *ListingTagType) String() string

String representation for fmt.Print

func (*ListingTagType) Type

func (f *ListingTagType) Type() string

Type always returns ListingTagType to satisfy [pflag.Value] interface

type ListingType

type ListingType string
const ListingTypePersonalized ListingType = `PERSONALIZED`
const ListingTypeStandard ListingType = `STANDARD`

func (*ListingType) Set

func (f *ListingType) Set(v string) error

Set raw string value and validate it against allowed values

func (*ListingType) String

func (f *ListingType) String() string

String representation for fmt.Print

func (*ListingType) Type

func (f *ListingType) Type() string

Type always returns ListingType to satisfy [pflag.Value] interface

type MarketplaceFileType

type MarketplaceFileType string
const MarketplaceFileTypeEmbeddedNotebook MarketplaceFileType = `EMBEDDED_NOTEBOOK`
const MarketplaceFileTypeProviderIcon MarketplaceFileType = `PROVIDER_ICON`

func (*MarketplaceFileType) Set

func (f *MarketplaceFileType) Set(v string) error

Set raw string value and validate it against allowed values

func (*MarketplaceFileType) String

func (f *MarketplaceFileType) String() string

String representation for fmt.Print

func (*MarketplaceFileType) Type

func (f *MarketplaceFileType) Type() string

Type always returns MarketplaceFileType to satisfy [pflag.Value] interface

type PersonalizationRequest

type PersonalizationRequest struct {
	Comment string `json:"comment,omitempty"`

	ConsumerRegion RegionInfo `json:"consumer_region"`
	// contact info for the consumer requesting data or performing a listing
	// installation
	ContactInfo *ContactInfo `json:"contact_info,omitempty"`

	CreatedAt int64 `json:"created_at,omitempty"`

	Id string `json:"id,omitempty"`

	IntendedUse string `json:"intended_use,omitempty"`

	IsFromLighthouse bool `json:"is_from_lighthouse,omitempty"`

	ListingId string `json:"listing_id,omitempty"`

	ListingName string `json:"listing_name,omitempty"`

	MetastoreId string `json:"metastore_id,omitempty"`

	ProviderId string `json:"provider_id,omitempty"`

	RecipientType DeltaSharingRecipientType `json:"recipient_type,omitempty"`

	Share *ShareInfo `json:"share,omitempty"`

	Status PersonalizationRequestStatus `json:"status,omitempty"`

	StatusMessage string `json:"status_message,omitempty"`

	UpdatedAt int64 `json:"updated_at,omitempty"`

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

func (PersonalizationRequest) MarshalJSON

func (s PersonalizationRequest) MarshalJSON() ([]byte, error)

func (*PersonalizationRequest) UnmarshalJSON

func (s *PersonalizationRequest) UnmarshalJSON(b []byte) error

type PersonalizationRequestStatus

type PersonalizationRequestStatus string
const PersonalizationRequestStatusDenied PersonalizationRequestStatus = `DENIED`
const PersonalizationRequestStatusFulfilled PersonalizationRequestStatus = `FULFILLED`
const PersonalizationRequestStatusNew PersonalizationRequestStatus = `NEW`
const PersonalizationRequestStatusRequestPending PersonalizationRequestStatus = `REQUEST_PENDING`

func (*PersonalizationRequestStatus) Set

Set raw string value and validate it against allowed values

func (*PersonalizationRequestStatus) String

String representation for fmt.Print

func (*PersonalizationRequestStatus) Type

Type always returns PersonalizationRequestStatus to satisfy [pflag.Value] interface

type ProviderAnalyticsDashboard

type ProviderAnalyticsDashboard struct {
	Id string `json:"id"`
}

type ProviderExchangeFiltersAPI

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

Marketplace exchanges filters curate which groups can access an exchange.

func NewProviderExchangeFilters

func NewProviderExchangeFilters(client *client.DatabricksClient) *ProviderExchangeFiltersAPI

func (*ProviderExchangeFiltersAPI) Create

Create a new exchange filter.

Add an exchange filter.

func (*ProviderExchangeFiltersAPI) Delete

Delete an exchange filter.

Delete an exchange filter

func (*ProviderExchangeFiltersAPI) DeleteById

func (a *ProviderExchangeFiltersAPI) DeleteById(ctx context.Context, id string) error

Delete an exchange filter.

Delete an exchange filter

func (*ProviderExchangeFiltersAPI) ExchangeFilterNameToIdMap

func (a *ProviderExchangeFiltersAPI) ExchangeFilterNameToIdMap(ctx context.Context, request ListExchangeFiltersRequest) (map[string]string, error)

ExchangeFilterNameToIdMap calls ProviderExchangeFiltersAPI.ListAll and creates a map of results with ExchangeFilter.Name as key and ExchangeFilter.Id as value.

Returns an error if there's more than one ExchangeFilter with the same .Name.

Note: All ExchangeFilter instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangeFiltersAPI) GetByName

GetByName calls ProviderExchangeFiltersAPI.ExchangeFilterNameToIdMap and returns a single ExchangeFilter.

Returns an error if there's more than one ExchangeFilter with the same .Name.

Note: All ExchangeFilter instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangeFiltersAPI) Impl

Impl returns low-level ProviderExchangeFilters API implementation Deprecated: use MockProviderExchangeFiltersInterface instead.

func (*ProviderExchangeFiltersAPI) List

List exchange filters.

List exchange filter

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangeFiltersAPI) ListAll

List exchange filters.

List exchange filter

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangeFiltersAPI) Update

Update exchange filter.

Update an exchange filter.

func (*ProviderExchangeFiltersAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderExchangeFiltersInterface instead.

type ProviderExchangeFiltersInterface

type ProviderExchangeFiltersInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderExchangeFiltersInterface instead.
	WithImpl(impl ProviderExchangeFiltersService) ProviderExchangeFiltersInterface

	// Impl returns low-level ProviderExchangeFilters API implementation
	// Deprecated: use MockProviderExchangeFiltersInterface instead.
	Impl() ProviderExchangeFiltersService

	// Create a new exchange filter.
	//
	// Add an exchange filter.
	Create(ctx context.Context, request CreateExchangeFilterRequest) (*CreateExchangeFilterResponse, error)

	// Delete an exchange filter.
	//
	// Delete an exchange filter
	Delete(ctx context.Context, request DeleteExchangeFilterRequest) error

	// Delete an exchange filter.
	//
	// Delete an exchange filter
	DeleteById(ctx context.Context, id string) error

	// List exchange filters.
	//
	// List exchange filter
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListExchangeFiltersRequest) listing.Iterator[ExchangeFilter]

	// List exchange filters.
	//
	// List exchange filter
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListExchangeFiltersRequest) ([]ExchangeFilter, error)

	// ExchangeFilterNameToIdMap calls [ProviderExchangeFiltersAPI.ListAll] and creates a map of results with [ExchangeFilter].Name as key and [ExchangeFilter].Id as value.
	//
	// Returns an error if there's more than one [ExchangeFilter] with the same .Name.
	//
	// Note: All [ExchangeFilter] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ExchangeFilterNameToIdMap(ctx context.Context, request ListExchangeFiltersRequest) (map[string]string, error)

	// GetByName calls [ProviderExchangeFiltersAPI.ExchangeFilterNameToIdMap] and returns a single [ExchangeFilter].
	//
	// Returns an error if there's more than one [ExchangeFilter] with the same .Name.
	//
	// Note: All [ExchangeFilter] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByName(ctx context.Context, name string) (*ExchangeFilter, error)

	// Update exchange filter.
	//
	// Update an exchange filter.
	Update(ctx context.Context, request UpdateExchangeFilterRequest) (*UpdateExchangeFilterResponse, error)
}

type ProviderExchangeFiltersService

type ProviderExchangeFiltersService interface {

	// Create a new exchange filter.
	//
	// Add an exchange filter.
	Create(ctx context.Context, request CreateExchangeFilterRequest) (*CreateExchangeFilterResponse, error)

	// Delete an exchange filter.
	//
	// Delete an exchange filter
	Delete(ctx context.Context, request DeleteExchangeFilterRequest) error

	// List exchange filters.
	//
	// List exchange filter
	//
	// Use ListAll() to get all ExchangeFilter instances, which will iterate over every result page.
	List(ctx context.Context, request ListExchangeFiltersRequest) (*ListExchangeFiltersResponse, error)

	// Update exchange filter.
	//
	// Update an exchange filter.
	Update(ctx context.Context, request UpdateExchangeFilterRequest) (*UpdateExchangeFilterResponse, error)
}

Marketplace exchanges filters curate which groups can access an exchange.

type ProviderExchangesAPI

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

Marketplace exchanges allow providers to share their listings with a curated set of customers.

func NewProviderExchanges

func NewProviderExchanges(client *client.DatabricksClient) *ProviderExchangesAPI

func (*ProviderExchangesAPI) AddListingToExchange

Add an exchange for listing.

Associate an exchange with a listing

func (*ProviderExchangesAPI) Create

Create an exchange.

Create an exchange

func (*ProviderExchangesAPI) Delete

Delete an exchange.

This removes a listing from marketplace.

func (*ProviderExchangesAPI) DeleteById

func (a *ProviderExchangesAPI) DeleteById(ctx context.Context, id string) error

Delete an exchange.

This removes a listing from marketplace.

func (*ProviderExchangesAPI) DeleteListingFromExchange

func (a *ProviderExchangesAPI) DeleteListingFromExchange(ctx context.Context, request RemoveExchangeForListingRequest) error

Remove an exchange for listing.

Disassociate an exchange with a listing

func (*ProviderExchangesAPI) DeleteListingFromExchangeById

func (a *ProviderExchangesAPI) DeleteListingFromExchangeById(ctx context.Context, id string) error

Remove an exchange for listing.

Disassociate an exchange with a listing

func (*ProviderExchangesAPI) ExchangeListingExchangeNameToExchangeIdMap

func (a *ProviderExchangesAPI) ExchangeListingExchangeNameToExchangeIdMap(ctx context.Context, request ListExchangesForListingRequest) (map[string]string, error)

ExchangeListingExchangeNameToExchangeIdMap calls ProviderExchangesAPI.ListExchangesForListingAll and creates a map of results with ExchangeListing.ExchangeName as key and ExchangeListing.ExchangeId as value.

Returns an error if there's more than one ExchangeListing with the same .ExchangeName.

Note: All ExchangeListing instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ExchangeListingListingNameToListingIdMap

func (a *ProviderExchangesAPI) ExchangeListingListingNameToListingIdMap(ctx context.Context, request ListListingsForExchangeRequest) (map[string]string, error)

ExchangeListingListingNameToListingIdMap calls ProviderExchangesAPI.ListListingsForExchangeAll and creates a map of results with ExchangeListing.ListingName as key and ExchangeListing.ListingId as value.

Returns an error if there's more than one ExchangeListing with the same .ListingName.

Note: All ExchangeListing instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ExchangeNameToIdMap

func (a *ProviderExchangesAPI) ExchangeNameToIdMap(ctx context.Context, request ListExchangesRequest) (map[string]string, error)

ExchangeNameToIdMap calls ProviderExchangesAPI.ListAll and creates a map of results with Exchange.Name as key and Exchange.Id as value.

Returns an error if there's more than one Exchange with the same .Name.

Note: All Exchange instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) Get

Get an exchange.

Get an exchange.

func (*ProviderExchangesAPI) GetByExchangeName

func (a *ProviderExchangesAPI) GetByExchangeName(ctx context.Context, name string) (*ExchangeListing, error)

GetByExchangeName calls ProviderExchangesAPI.ExchangeListingExchangeNameToExchangeIdMap and returns a single ExchangeListing.

Returns an error if there's more than one ExchangeListing with the same .ExchangeName.

Note: All ExchangeListing instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) GetById

Get an exchange.

Get an exchange.

func (*ProviderExchangesAPI) GetByListingName

func (a *ProviderExchangesAPI) GetByListingName(ctx context.Context, name string) (*ExchangeListing, error)

GetByListingName calls ProviderExchangesAPI.ExchangeListingListingNameToListingIdMap and returns a single ExchangeListing.

Returns an error if there's more than one ExchangeListing with the same .ListingName.

Note: All ExchangeListing instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) GetByName

func (a *ProviderExchangesAPI) GetByName(ctx context.Context, name string) (*Exchange, error)

GetByName calls ProviderExchangesAPI.ExchangeNameToIdMap and returns a single Exchange.

Returns an error if there's more than one Exchange with the same .Name.

Note: All Exchange instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) Impl

Impl returns low-level ProviderExchanges API implementation Deprecated: use MockProviderExchangesInterface instead.

func (*ProviderExchangesAPI) List

List exchanges.

List exchanges visible to provider

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ListAll

List exchanges.

List exchanges visible to provider

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ListExchangesForListing

List exchanges for listing.

List exchanges associated with a listing

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ListExchangesForListingAll

func (a *ProviderExchangesAPI) ListExchangesForListingAll(ctx context.Context, request ListExchangesForListingRequest) ([]ExchangeListing, error)

List exchanges for listing.

List exchanges associated with a listing

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ListListingsForExchange

List listings for exchange.

List listings associated with an exchange

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) ListListingsForExchangeAll

func (a *ProviderExchangesAPI) ListListingsForExchangeAll(ctx context.Context, request ListListingsForExchangeRequest) ([]ExchangeListing, error)

List listings for exchange.

List listings associated with an exchange

This method is generated by Databricks SDK Code Generator.

func (*ProviderExchangesAPI) Update

Update exchange.

Update an exchange

func (*ProviderExchangesAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderExchangesInterface instead.

type ProviderExchangesInterface

type ProviderExchangesInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderExchangesInterface instead.
	WithImpl(impl ProviderExchangesService) ProviderExchangesInterface

	// Impl returns low-level ProviderExchanges API implementation
	// Deprecated: use MockProviderExchangesInterface instead.
	Impl() ProviderExchangesService

	// Add an exchange for listing.
	//
	// Associate an exchange with a listing
	AddListingToExchange(ctx context.Context, request AddExchangeForListingRequest) (*AddExchangeForListingResponse, error)

	// Create an exchange.
	//
	// Create an exchange
	Create(ctx context.Context, request CreateExchangeRequest) (*CreateExchangeResponse, error)

	// Delete an exchange.
	//
	// This removes a listing from marketplace.
	Delete(ctx context.Context, request DeleteExchangeRequest) error

	// Delete an exchange.
	//
	// This removes a listing from marketplace.
	DeleteById(ctx context.Context, id string) error

	// Remove an exchange for listing.
	//
	// Disassociate an exchange with a listing
	DeleteListingFromExchange(ctx context.Context, request RemoveExchangeForListingRequest) error

	// Remove an exchange for listing.
	//
	// Disassociate an exchange with a listing
	DeleteListingFromExchangeById(ctx context.Context, id string) error

	// Get an exchange.
	//
	// Get an exchange.
	Get(ctx context.Context, request GetExchangeRequest) (*GetExchangeResponse, error)

	// Get an exchange.
	//
	// Get an exchange.
	GetById(ctx context.Context, id string) (*GetExchangeResponse, error)

	// List exchanges.
	//
	// List exchanges visible to provider
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListExchangesRequest) listing.Iterator[Exchange]

	// List exchanges.
	//
	// List exchanges visible to provider
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListExchangesRequest) ([]Exchange, error)

	// ExchangeNameToIdMap calls [ProviderExchangesAPI.ListAll] and creates a map of results with [Exchange].Name as key and [Exchange].Id as value.
	//
	// Returns an error if there's more than one [Exchange] with the same .Name.
	//
	// Note: All [Exchange] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ExchangeNameToIdMap(ctx context.Context, request ListExchangesRequest) (map[string]string, error)

	// GetByName calls [ProviderExchangesAPI.ExchangeNameToIdMap] and returns a single [Exchange].
	//
	// Returns an error if there's more than one [Exchange] with the same .Name.
	//
	// Note: All [Exchange] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByName(ctx context.Context, name string) (*Exchange, error)

	// List exchanges for listing.
	//
	// List exchanges associated with a listing
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExchangesForListing(ctx context.Context, request ListExchangesForListingRequest) listing.Iterator[ExchangeListing]

	// List exchanges for listing.
	//
	// List exchanges associated with a listing
	//
	// This method is generated by Databricks SDK Code Generator.
	ListExchangesForListingAll(ctx context.Context, request ListExchangesForListingRequest) ([]ExchangeListing, error)

	// ExchangeListingExchangeNameToExchangeIdMap calls [ProviderExchangesAPI.ListExchangesForListingAll] and creates a map of results with [ExchangeListing].ExchangeName as key and [ExchangeListing].ExchangeId as value.
	//
	// Returns an error if there's more than one [ExchangeListing] with the same .ExchangeName.
	//
	// Note: All [ExchangeListing] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ExchangeListingExchangeNameToExchangeIdMap(ctx context.Context, request ListExchangesForListingRequest) (map[string]string, error)

	// GetByExchangeName calls [ProviderExchangesAPI.ExchangeListingExchangeNameToExchangeIdMap] and returns a single [ExchangeListing].
	//
	// Returns an error if there's more than one [ExchangeListing] with the same .ExchangeName.
	//
	// Note: All [ExchangeListing] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByExchangeName(ctx context.Context, name string) (*ExchangeListing, error)

	// List listings for exchange.
	//
	// List listings associated with an exchange
	//
	// This method is generated by Databricks SDK Code Generator.
	ListListingsForExchange(ctx context.Context, request ListListingsForExchangeRequest) listing.Iterator[ExchangeListing]

	// List listings for exchange.
	//
	// List listings associated with an exchange
	//
	// This method is generated by Databricks SDK Code Generator.
	ListListingsForExchangeAll(ctx context.Context, request ListListingsForExchangeRequest) ([]ExchangeListing, error)

	// ExchangeListingListingNameToListingIdMap calls [ProviderExchangesAPI.ListListingsForExchangeAll] and creates a map of results with [ExchangeListing].ListingName as key and [ExchangeListing].ListingId as value.
	//
	// Returns an error if there's more than one [ExchangeListing] with the same .ListingName.
	//
	// Note: All [ExchangeListing] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ExchangeListingListingNameToListingIdMap(ctx context.Context, request ListListingsForExchangeRequest) (map[string]string, error)

	// GetByListingName calls [ProviderExchangesAPI.ExchangeListingListingNameToListingIdMap] and returns a single [ExchangeListing].
	//
	// Returns an error if there's more than one [ExchangeListing] with the same .ListingName.
	//
	// Note: All [ExchangeListing] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByListingName(ctx context.Context, name string) (*ExchangeListing, error)

	// Update exchange.
	//
	// Update an exchange
	Update(ctx context.Context, request UpdateExchangeRequest) (*UpdateExchangeResponse, error)
}

type ProviderExchangesService

type ProviderExchangesService interface {

	// Add an exchange for listing.
	//
	// Associate an exchange with a listing
	AddListingToExchange(ctx context.Context, request AddExchangeForListingRequest) (*AddExchangeForListingResponse, error)

	// Create an exchange.
	//
	// Create an exchange
	Create(ctx context.Context, request CreateExchangeRequest) (*CreateExchangeResponse, error)

	// Delete an exchange.
	//
	// This removes a listing from marketplace.
	Delete(ctx context.Context, request DeleteExchangeRequest) error

	// Remove an exchange for listing.
	//
	// Disassociate an exchange with a listing
	DeleteListingFromExchange(ctx context.Context, request RemoveExchangeForListingRequest) error

	// Get an exchange.
	//
	// Get an exchange.
	Get(ctx context.Context, request GetExchangeRequest) (*GetExchangeResponse, error)

	// List exchanges.
	//
	// List exchanges visible to provider
	//
	// Use ListAll() to get all Exchange instances, which will iterate over every result page.
	List(ctx context.Context, request ListExchangesRequest) (*ListExchangesResponse, error)

	// List exchanges for listing.
	//
	// List exchanges associated with a listing
	//
	// Use ListExchangesForListingAll() to get all ExchangeListing instances, which will iterate over every result page.
	ListExchangesForListing(ctx context.Context, request ListExchangesForListingRequest) (*ListExchangesForListingResponse, error)

	// List listings for exchange.
	//
	// List listings associated with an exchange
	//
	// Use ListListingsForExchangeAll() to get all ExchangeListing instances, which will iterate over every result page.
	ListListingsForExchange(ctx context.Context, request ListListingsForExchangeRequest) (*ListListingsForExchangeResponse, error)

	// Update exchange.
	//
	// Update an exchange
	Update(ctx context.Context, request UpdateExchangeRequest) (*UpdateExchangeResponse, error)
}

Marketplace exchanges allow providers to share their listings with a curated set of customers.

type ProviderFilesAPI

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

Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider icons.

func NewProviderFiles

func NewProviderFiles(client *client.DatabricksClient) *ProviderFilesAPI

func (*ProviderFilesAPI) Create

Create a file.

Create a file. Currently, only provider icons and attached notebooks are supported.

func (*ProviderFilesAPI) Delete

func (a *ProviderFilesAPI) Delete(ctx context.Context, request DeleteFileRequest) error

Delete a file.

Delete a file

func (*ProviderFilesAPI) DeleteByFileId

func (a *ProviderFilesAPI) DeleteByFileId(ctx context.Context, fileId string) error

Delete a file.

Delete a file

func (*ProviderFilesAPI) FileInfoDisplayNameToIdMap

func (a *ProviderFilesAPI) FileInfoDisplayNameToIdMap(ctx context.Context, request ListFilesRequest) (map[string]string, error)

FileInfoDisplayNameToIdMap calls ProviderFilesAPI.ListAll and creates a map of results with FileInfo.DisplayName as key and FileInfo.Id as value.

Returns an error if there's more than one FileInfo with the same .DisplayName.

Note: All FileInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderFilesAPI) Get

Get a file.

Get a file

func (*ProviderFilesAPI) GetByDisplayName

func (a *ProviderFilesAPI) GetByDisplayName(ctx context.Context, name string) (*FileInfo, error)

GetByDisplayName calls ProviderFilesAPI.FileInfoDisplayNameToIdMap and returns a single FileInfo.

Returns an error if there's more than one FileInfo with the same .DisplayName.

Note: All FileInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderFilesAPI) GetByFileId

func (a *ProviderFilesAPI) GetByFileId(ctx context.Context, fileId string) (*GetFileResponse, error)

Get a file.

Get a file

func (*ProviderFilesAPI) Impl

Impl returns low-level ProviderFiles API implementation Deprecated: use MockProviderFilesInterface instead.

func (*ProviderFilesAPI) List

List files.

List files attached to a parent entity.

This method is generated by Databricks SDK Code Generator.

func (*ProviderFilesAPI) ListAll

func (a *ProviderFilesAPI) ListAll(ctx context.Context, request ListFilesRequest) ([]FileInfo, error)

List files.

List files attached to a parent entity.

This method is generated by Databricks SDK Code Generator.

func (*ProviderFilesAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderFilesInterface instead.

type ProviderFilesInterface

type ProviderFilesInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderFilesInterface instead.
	WithImpl(impl ProviderFilesService) ProviderFilesInterface

	// Impl returns low-level ProviderFiles API implementation
	// Deprecated: use MockProviderFilesInterface instead.
	Impl() ProviderFilesService

	// Create a file.
	//
	// Create a file. Currently, only provider icons and attached notebooks are
	// supported.
	Create(ctx context.Context, request CreateFileRequest) (*CreateFileResponse, error)

	// Delete a file.
	//
	// Delete a file
	Delete(ctx context.Context, request DeleteFileRequest) error

	// Delete a file.
	//
	// Delete a file
	DeleteByFileId(ctx context.Context, fileId string) error

	// Get a file.
	//
	// Get a file
	Get(ctx context.Context, request GetFileRequest) (*GetFileResponse, error)

	// Get a file.
	//
	// Get a file
	GetByFileId(ctx context.Context, fileId string) (*GetFileResponse, error)

	// List files.
	//
	// List files attached to a parent entity.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListFilesRequest) listing.Iterator[FileInfo]

	// List files.
	//
	// List files attached to a parent entity.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListFilesRequest) ([]FileInfo, error)

	// FileInfoDisplayNameToIdMap calls [ProviderFilesAPI.ListAll] and creates a map of results with [FileInfo].DisplayName as key and [FileInfo].Id as value.
	//
	// Returns an error if there's more than one [FileInfo] with the same .DisplayName.
	//
	// Note: All [FileInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	FileInfoDisplayNameToIdMap(ctx context.Context, request ListFilesRequest) (map[string]string, error)

	// GetByDisplayName calls [ProviderFilesAPI.FileInfoDisplayNameToIdMap] and returns a single [FileInfo].
	//
	// Returns an error if there's more than one [FileInfo] with the same .DisplayName.
	//
	// Note: All [FileInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByDisplayName(ctx context.Context, name string) (*FileInfo, error)
}

type ProviderFilesService

type ProviderFilesService interface {

	// Create a file.
	//
	// Create a file. Currently, only provider icons and attached notebooks are
	// supported.
	Create(ctx context.Context, request CreateFileRequest) (*CreateFileResponse, error)

	// Delete a file.
	//
	// Delete a file
	Delete(ctx context.Context, request DeleteFileRequest) error

	// Get a file.
	//
	// Get a file
	Get(ctx context.Context, request GetFileRequest) (*GetFileResponse, error)

	// List files.
	//
	// List files attached to a parent entity.
	//
	// Use ListAll() to get all FileInfo instances, which will iterate over every result page.
	List(ctx context.Context, request ListFilesRequest) (*ListFilesResponse, error)
}

Marketplace offers a set of file APIs for various purposes such as preview notebooks and provider icons.

type ProviderInfo

type ProviderInfo struct {
	BusinessContactEmail string `json:"business_contact_email"`

	CompanyWebsiteLink string `json:"company_website_link,omitempty"`

	DarkModeIconFileId string `json:"dark_mode_icon_file_id,omitempty"`

	DarkModeIconFilePath string `json:"dark_mode_icon_file_path,omitempty"`

	Description string `json:"description,omitempty"`

	IconFileId string `json:"icon_file_id,omitempty"`

	IconFilePath string `json:"icon_file_path,omitempty"`

	Id string `json:"id,omitempty"`
	// is_featured is accessible by consumers only
	IsFeatured bool `json:"is_featured,omitempty"`

	Name string `json:"name"`

	PrivacyPolicyLink string `json:"privacy_policy_link"`
	// published_by is only applicable to data aggregators (e.g. Crux)
	PublishedBy string `json:"published_by,omitempty"`

	SupportContactEmail string `json:"support_contact_email,omitempty"`

	TermOfServiceLink string `json:"term_of_service_link"`

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

func (ProviderInfo) MarshalJSON

func (s ProviderInfo) MarshalJSON() ([]byte, error)

func (*ProviderInfo) UnmarshalJSON

func (s *ProviderInfo) UnmarshalJSON(b []byte) error

type ProviderListingsAPI

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

Listings are the core entities in the Marketplace. They represent the products that are available for consumption.

func NewProviderListings

func NewProviderListings(client *client.DatabricksClient) *ProviderListingsAPI

func (*ProviderListingsAPI) Create

Create a listing.

Create a new listing

func (*ProviderListingsAPI) Delete

Delete a listing.

Delete a listing

func (*ProviderListingsAPI) DeleteById

func (a *ProviderListingsAPI) DeleteById(ctx context.Context, id string) error

Delete a listing.

Delete a listing

func (*ProviderListingsAPI) Get

Get a listing.

Get a listing

func (*ProviderListingsAPI) GetById

Get a listing.

Get a listing

func (*ProviderListingsAPI) GetBySummaryName

func (a *ProviderListingsAPI) GetBySummaryName(ctx context.Context, name string) (*Listing, error)

GetBySummaryName calls ProviderListingsAPI.ListingSummaryNameToIdMap and returns a single Listing.

Returns an error if there's more than one Listing with the same .Summary.Name.

Note: All Listing instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderListingsAPI) Impl

Impl returns low-level ProviderListings API implementation Deprecated: use MockProviderListingsInterface instead.

func (*ProviderListingsAPI) List

List listings.

List listings owned by this provider

This method is generated by Databricks SDK Code Generator.

func (*ProviderListingsAPI) ListAll

func (a *ProviderListingsAPI) ListAll(ctx context.Context, request GetListingsRequest) ([]Listing, error)

List listings.

List listings owned by this provider

This method is generated by Databricks SDK Code Generator.

func (*ProviderListingsAPI) ListingSummaryNameToIdMap

func (a *ProviderListingsAPI) ListingSummaryNameToIdMap(ctx context.Context, request GetListingsRequest) (map[string]string, error)

ListingSummaryNameToIdMap calls ProviderListingsAPI.ListAll and creates a map of results with Listing.Summary.Name as key and Listing.Id as value.

Returns an error if there's more than one Listing with the same .Summary.Name.

Note: All Listing instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderListingsAPI) Update

Update listing.

Update a listing

func (*ProviderListingsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderListingsInterface instead.

type ProviderListingsInterface

type ProviderListingsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderListingsInterface instead.
	WithImpl(impl ProviderListingsService) ProviderListingsInterface

	// Impl returns low-level ProviderListings API implementation
	// Deprecated: use MockProviderListingsInterface instead.
	Impl() ProviderListingsService

	// Create a listing.
	//
	// Create a new listing
	Create(ctx context.Context, request CreateListingRequest) (*CreateListingResponse, error)

	// Delete a listing.
	//
	// Delete a listing
	Delete(ctx context.Context, request DeleteListingRequest) error

	// Delete a listing.
	//
	// Delete a listing
	DeleteById(ctx context.Context, id string) error

	// Get a listing.
	//
	// Get a listing
	Get(ctx context.Context, request GetListingRequest) (*GetListingResponse, error)

	// Get a listing.
	//
	// Get a listing
	GetById(ctx context.Context, id string) (*GetListingResponse, error)

	// List listings.
	//
	// List listings owned by this provider
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request GetListingsRequest) listing.Iterator[Listing]

	// List listings.
	//
	// List listings owned by this provider
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request GetListingsRequest) ([]Listing, error)

	// ListingSummaryNameToIdMap calls [ProviderListingsAPI.ListAll] and creates a map of results with [Listing].Summary.Name as key and [Listing].Id as value.
	//
	// Returns an error if there's more than one [Listing] with the same .Summary.Name.
	//
	// Note: All [Listing] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListingSummaryNameToIdMap(ctx context.Context, request GetListingsRequest) (map[string]string, error)

	// GetBySummaryName calls [ProviderListingsAPI.ListingSummaryNameToIdMap] and returns a single [Listing].
	//
	// Returns an error if there's more than one [Listing] with the same .Summary.Name.
	//
	// Note: All [Listing] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetBySummaryName(ctx context.Context, name string) (*Listing, error)

	// Update listing.
	//
	// Update a listing
	Update(ctx context.Context, request UpdateListingRequest) (*UpdateListingResponse, error)
}

type ProviderListingsService

type ProviderListingsService interface {

	// Create a listing.
	//
	// Create a new listing
	Create(ctx context.Context, request CreateListingRequest) (*CreateListingResponse, error)

	// Delete a listing.
	//
	// Delete a listing
	Delete(ctx context.Context, request DeleteListingRequest) error

	// Get a listing.
	//
	// Get a listing
	Get(ctx context.Context, request GetListingRequest) (*GetListingResponse, error)

	// List listings.
	//
	// List listings owned by this provider
	//
	// Use ListAll() to get all Listing instances, which will iterate over every result page.
	List(ctx context.Context, request GetListingsRequest) (*GetListingsResponse, error)

	// Update listing.
	//
	// Update a listing
	Update(ctx context.Context, request UpdateListingRequest) (*UpdateListingResponse, error)
}

Listings are the core entities in the Marketplace. They represent the products that are available for consumption.

type ProviderPersonalizationRequestsAPI

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

Personalization requests are an alternate to instantly available listings. Control the lifecycle of personalized solutions.

func (*ProviderPersonalizationRequestsAPI) Impl

Impl returns low-level ProviderPersonalizationRequests API implementation Deprecated: use MockProviderPersonalizationRequestsInterface instead.

func (*ProviderPersonalizationRequestsAPI) List

All personalization requests across all listings.

List personalization requests to this provider. This will return all personalization requests, regardless of which listing they are for.

This method is generated by Databricks SDK Code Generator.

func (*ProviderPersonalizationRequestsAPI) ListAll

All personalization requests across all listings.

List personalization requests to this provider. This will return all personalization requests, regardless of which listing they are for.

This method is generated by Databricks SDK Code Generator.

func (*ProviderPersonalizationRequestsAPI) Update

Update personalization request status.

Update personalization request. This method only permits updating the status of the request.

func (*ProviderPersonalizationRequestsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderPersonalizationRequestsInterface instead.

type ProviderPersonalizationRequestsInterface

type ProviderPersonalizationRequestsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderPersonalizationRequestsInterface instead.
	WithImpl(impl ProviderPersonalizationRequestsService) ProviderPersonalizationRequestsInterface

	// Impl returns low-level ProviderPersonalizationRequests API implementation
	// Deprecated: use MockProviderPersonalizationRequestsInterface instead.
	Impl() ProviderPersonalizationRequestsService

	// All personalization requests across all listings.
	//
	// List personalization requests to this provider. This will return all
	// personalization requests, regardless of which listing they are for.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListAllPersonalizationRequestsRequest) listing.Iterator[PersonalizationRequest]

	// All personalization requests across all listings.
	//
	// List personalization requests to this provider. This will return all
	// personalization requests, regardless of which listing they are for.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListAllPersonalizationRequestsRequest) ([]PersonalizationRequest, error)

	// Update personalization request status.
	//
	// Update personalization request. This method only permits updating the status
	// of the request.
	Update(ctx context.Context, request UpdatePersonalizationRequestRequest) (*UpdatePersonalizationRequestResponse, error)
}

type ProviderPersonalizationRequestsService

type ProviderPersonalizationRequestsService interface {

	// All personalization requests across all listings.
	//
	// List personalization requests to this provider. This will return all
	// personalization requests, regardless of which listing they are for.
	//
	// Use ListAll() to get all PersonalizationRequest instances, which will iterate over every result page.
	List(ctx context.Context, request ListAllPersonalizationRequestsRequest) (*ListAllPersonalizationRequestsResponse, error)

	// Update personalization request status.
	//
	// Update personalization request. This method only permits updating the
	// status of the request.
	Update(ctx context.Context, request UpdatePersonalizationRequestRequest) (*UpdatePersonalizationRequestResponse, error)
}

Personalization requests are an alternate to instantly available listings. Control the lifecycle of personalized solutions.

type ProviderProviderAnalyticsDashboardsAPI

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

Manage templated analytics solution for providers.

func (*ProviderProviderAnalyticsDashboardsAPI) Create

Create provider analytics dashboard.

Create provider analytics dashboard. Returns Marketplace specific `id`. Not to be confused with the Lakeview dashboard id.

func (*ProviderProviderAnalyticsDashboardsAPI) Get

Get provider analytics dashboard.

Get provider analytics dashboard.

func (*ProviderProviderAnalyticsDashboardsAPI) GetLatestVersion

Get latest version of provider analytics dashboard.

Get latest version of provider analytics dashboard.

func (*ProviderProviderAnalyticsDashboardsAPI) Impl

Impl returns low-level ProviderProviderAnalyticsDashboards API implementation Deprecated: use MockProviderProviderAnalyticsDashboardsInterface instead.

func (*ProviderProviderAnalyticsDashboardsAPI) Update

Update provider analytics dashboard.

Update provider analytics dashboard.

func (*ProviderProviderAnalyticsDashboardsAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderProviderAnalyticsDashboardsInterface instead.

type ProviderProviderAnalyticsDashboardsInterface

type ProviderProviderAnalyticsDashboardsInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderProviderAnalyticsDashboardsInterface instead.
	WithImpl(impl ProviderProviderAnalyticsDashboardsService) ProviderProviderAnalyticsDashboardsInterface

	// Impl returns low-level ProviderProviderAnalyticsDashboards API implementation
	// Deprecated: use MockProviderProviderAnalyticsDashboardsInterface instead.
	Impl() ProviderProviderAnalyticsDashboardsService

	// Create provider analytics dashboard.
	//
	// Create provider analytics dashboard. Returns Marketplace specific `id`. Not
	// to be confused with the Lakeview dashboard id.
	Create(ctx context.Context) (*ProviderAnalyticsDashboard, error)

	// Get provider analytics dashboard.
	//
	// Get provider analytics dashboard.
	Get(ctx context.Context) (*ListProviderAnalyticsDashboardResponse, error)

	// Get latest version of provider analytics dashboard.
	//
	// Get latest version of provider analytics dashboard.
	GetLatestVersion(ctx context.Context) (*GetLatestVersionProviderAnalyticsDashboardResponse, error)

	// Update provider analytics dashboard.
	//
	// Update provider analytics dashboard.
	Update(ctx context.Context, request UpdateProviderAnalyticsDashboardRequest) (*UpdateProviderAnalyticsDashboardResponse, error)
}

type ProviderProviderAnalyticsDashboardsService

type ProviderProviderAnalyticsDashboardsService interface {

	// Create provider analytics dashboard.
	//
	// Create provider analytics dashboard. Returns Marketplace specific `id`.
	// Not to be confused with the Lakeview dashboard id.
	Create(ctx context.Context) (*ProviderAnalyticsDashboard, error)

	// Get provider analytics dashboard.
	//
	// Get provider analytics dashboard.
	Get(ctx context.Context) (*ListProviderAnalyticsDashboardResponse, error)

	// Get latest version of provider analytics dashboard.
	//
	// Get latest version of provider analytics dashboard.
	GetLatestVersion(ctx context.Context) (*GetLatestVersionProviderAnalyticsDashboardResponse, error)

	// Update provider analytics dashboard.
	//
	// Update provider analytics dashboard.
	Update(ctx context.Context, request UpdateProviderAnalyticsDashboardRequest) (*UpdateProviderAnalyticsDashboardResponse, error)
}

Manage templated analytics solution for providers.

type ProviderProvidersAPI

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

Providers are entities that manage assets in Marketplace.

func NewProviderProviders

func NewProviderProviders(client *client.DatabricksClient) *ProviderProvidersAPI

func (*ProviderProvidersAPI) Create

Create a provider.

Create a provider

func (*ProviderProvidersAPI) Delete

Delete provider.

Delete provider

func (*ProviderProvidersAPI) DeleteById

func (a *ProviderProvidersAPI) DeleteById(ctx context.Context, id string) error

Delete provider.

Delete provider

func (*ProviderProvidersAPI) Get

Get provider.

Get provider profile

func (*ProviderProvidersAPI) GetById

Get provider.

Get provider profile

func (*ProviderProvidersAPI) GetByName

func (a *ProviderProvidersAPI) GetByName(ctx context.Context, name string) (*ProviderInfo, error)

GetByName calls ProviderProvidersAPI.ProviderInfoNameToIdMap and returns a single ProviderInfo.

Returns an error if there's more than one ProviderInfo with the same .Name.

Note: All ProviderInfo instances are loaded into memory before returning matching by name.

This method is generated by Databricks SDK Code Generator.

func (*ProviderProvidersAPI) Impl

Impl returns low-level ProviderProviders API implementation Deprecated: use MockProviderProvidersInterface instead.

func (*ProviderProvidersAPI) List

List providers.

List provider profiles for account.

This method is generated by Databricks SDK Code Generator.

func (*ProviderProvidersAPI) ListAll

List providers.

List provider profiles for account.

This method is generated by Databricks SDK Code Generator.

func (*ProviderProvidersAPI) ProviderInfoNameToIdMap

func (a *ProviderProvidersAPI) ProviderInfoNameToIdMap(ctx context.Context, request ListProvidersRequest) (map[string]string, error)

ProviderInfoNameToIdMap calls ProviderProvidersAPI.ListAll and creates a map of results with ProviderInfo.Name as key and ProviderInfo.Id as value.

Returns an error if there's more than one ProviderInfo with the same .Name.

Note: All ProviderInfo instances are loaded into memory before creating a map.

This method is generated by Databricks SDK Code Generator.

func (*ProviderProvidersAPI) Update

Update provider.

Update provider profile

func (*ProviderProvidersAPI) WithImpl

WithImpl could be used to override low-level API implementations for unit testing purposes with github.com/golang/mock or other mocking frameworks. Deprecated: use MockProviderProvidersInterface instead.

type ProviderProvidersInterface

type ProviderProvidersInterface interface {
	// WithImpl could be used to override low-level API implementations for unit
	// testing purposes with [github.com/golang/mock] or other mocking frameworks.
	// Deprecated: use MockProviderProvidersInterface instead.
	WithImpl(impl ProviderProvidersService) ProviderProvidersInterface

	// Impl returns low-level ProviderProviders API implementation
	// Deprecated: use MockProviderProvidersInterface instead.
	Impl() ProviderProvidersService

	// Create a provider.
	//
	// Create a provider
	Create(ctx context.Context, request CreateProviderRequest) (*CreateProviderResponse, error)

	// Delete provider.
	//
	// Delete provider
	Delete(ctx context.Context, request DeleteProviderRequest) error

	// Delete provider.
	//
	// Delete provider
	DeleteById(ctx context.Context, id string) error

	// Get provider.
	//
	// Get provider profile
	Get(ctx context.Context, request GetProviderRequest) (*GetProviderResponse, error)

	// Get provider.
	//
	// Get provider profile
	GetById(ctx context.Context, id string) (*GetProviderResponse, error)

	// List providers.
	//
	// List provider profiles for account.
	//
	// This method is generated by Databricks SDK Code Generator.
	List(ctx context.Context, request ListProvidersRequest) listing.Iterator[ProviderInfo]

	// List providers.
	//
	// List provider profiles for account.
	//
	// This method is generated by Databricks SDK Code Generator.
	ListAll(ctx context.Context, request ListProvidersRequest) ([]ProviderInfo, error)

	// ProviderInfoNameToIdMap calls [ProviderProvidersAPI.ListAll] and creates a map of results with [ProviderInfo].Name as key and [ProviderInfo].Id as value.
	//
	// Returns an error if there's more than one [ProviderInfo] with the same .Name.
	//
	// Note: All [ProviderInfo] instances are loaded into memory before creating a map.
	//
	// This method is generated by Databricks SDK Code Generator.
	ProviderInfoNameToIdMap(ctx context.Context, request ListProvidersRequest) (map[string]string, error)

	// GetByName calls [ProviderProvidersAPI.ProviderInfoNameToIdMap] and returns a single [ProviderInfo].
	//
	// Returns an error if there's more than one [ProviderInfo] with the same .Name.
	//
	// Note: All [ProviderInfo] instances are loaded into memory before returning matching by name.
	//
	// This method is generated by Databricks SDK Code Generator.
	GetByName(ctx context.Context, name string) (*ProviderInfo, error)

	// Update provider.
	//
	// Update provider profile
	Update(ctx context.Context, request UpdateProviderRequest) (*UpdateProviderResponse, error)
}

type ProviderProvidersService

type ProviderProvidersService interface {

	// Create a provider.
	//
	// Create a provider
	Create(ctx context.Context, request CreateProviderRequest) (*CreateProviderResponse, error)

	// Delete provider.
	//
	// Delete provider
	Delete(ctx context.Context, request DeleteProviderRequest) error

	// Get provider.
	//
	// Get provider profile
	Get(ctx context.Context, request GetProviderRequest) (*GetProviderResponse, error)

	// List providers.
	//
	// List provider profiles for account.
	//
	// Use ListAll() to get all ProviderInfo instances, which will iterate over every result page.
	List(ctx context.Context, request ListProvidersRequest) (*ListProvidersResponse, error)

	// Update provider.
	//
	// Update provider profile
	Update(ctx context.Context, request UpdateProviderRequest) (*UpdateProviderResponse, error)
}

Providers are entities that manage assets in Marketplace.

type RegionInfo

type RegionInfo struct {
	Cloud string `json:"cloud,omitempty"`

	Region string `json:"region,omitempty"`

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

func (RegionInfo) MarshalJSON

func (s RegionInfo) MarshalJSON() ([]byte, error)

func (*RegionInfo) UnmarshalJSON

func (s *RegionInfo) UnmarshalJSON(b []byte) error

type RemoveExchangeForListingRequest

type RemoveExchangeForListingRequest struct {
	Id string `json:"-" url:"-"`
}

Remove an exchange for listing

type RemoveExchangeForListingResponse

type RemoveExchangeForListingResponse struct {
}

type RepoInfo

type RepoInfo struct {
	// the git repo url e.g. https://github.com/databrickslabs/dolly.git
	GitRepoUrl string `json:"git_repo_url"`
}

type RepoInstallation

type RepoInstallation struct {
	// the user-specified repo name for their installed git repo listing
	RepoName string `json:"repo_name"`
	// refers to the full url file path that navigates the user to the repo's
	// entrypoint (e.g. a README.md file, or the repo file view in the unified
	// UI) should just be a relative path
	RepoPath string `json:"repo_path"`
}

type SearchListingsRequest

type SearchListingsRequest struct {
	// Matches any of the following asset types
	Assets []AssetType `json:"-" url:"assets,omitempty"`
	// Matches any of the following categories
	Categories []Category `json:"-" url:"categories,omitempty"`

	IsAscending bool `json:"-" url:"is_ascending,omitempty"`

	IsFree bool `json:"-" url:"is_free,omitempty"`

	IsPrivateExchange bool `json:"-" url:"is_private_exchange,omitempty"`

	PageSize int `json:"-" url:"page_size,omitempty"`

	PageToken string `json:"-" url:"page_token,omitempty"`
	// Matches any of the following provider ids
	ProviderIds []string `json:"-" url:"provider_ids,omitempty"`
	// Fuzzy matches query
	Query string `json:"-" url:"query"`

	SortBy SortBy `json:"-" url:"sort_by,omitempty"`

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

Search listings

func (SearchListingsRequest) MarshalJSON

func (s SearchListingsRequest) MarshalJSON() ([]byte, error)

func (*SearchListingsRequest) UnmarshalJSON

func (s *SearchListingsRequest) UnmarshalJSON(b []byte) error

type SearchListingsResponse

type SearchListingsResponse struct {
	Listings []Listing `json:"listings,omitempty"`

	NextPageToken string `json:"next_page_token,omitempty"`

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

func (SearchListingsResponse) MarshalJSON

func (s SearchListingsResponse) MarshalJSON() ([]byte, error)

func (*SearchListingsResponse) UnmarshalJSON

func (s *SearchListingsResponse) UnmarshalJSON(b []byte) error

type ShareInfo

type ShareInfo struct {
	Name string `json:"name"`

	Type ListingShareType `json:"type"`
}

type SharedDataObject

type SharedDataObject struct {
	// The type of the data object. Could be one of: TABLE, SCHEMA,
	// NOTEBOOK_FILE, MODEL, VOLUME
	DataObjectType string `json:"data_object_type,omitempty"`
	// Name of the shared object
	Name string `json:"name,omitempty"`

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

func (SharedDataObject) MarshalJSON

func (s SharedDataObject) MarshalJSON() ([]byte, error)

func (*SharedDataObject) UnmarshalJSON

func (s *SharedDataObject) UnmarshalJSON(b []byte) error

type SortBy

type SortBy string
const SortBySortByDate SortBy = `SORT_BY_DATE`
const SortBySortByRelevance SortBy = `SORT_BY_RELEVANCE`
const SortBySortByTitle SortBy = `SORT_BY_TITLE`
const SortBySortByUnspecified SortBy = `SORT_BY_UNSPECIFIED`

func (*SortBy) Set

func (f *SortBy) Set(v string) error

Set raw string value and validate it against allowed values

func (*SortBy) String

func (f *SortBy) String() string

String representation for fmt.Print

func (*SortBy) Type

func (f *SortBy) Type() string

Type always returns SortBy to satisfy [pflag.Value] interface

type TokenDetail

type TokenDetail struct {
	BearerToken string `json:"bearerToken,omitempty"`

	Endpoint string `json:"endpoint,omitempty"`

	ExpirationTime string `json:"expirationTime,omitempty"`
	// These field names must follow the delta sharing protocol. Original
	// message: RetrieveToken.Response in
	// managed-catalog/api/messages/recipient.proto
	ShareCredentialsVersion int `json:"shareCredentialsVersion,omitempty"`

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

func (TokenDetail) MarshalJSON

func (s TokenDetail) MarshalJSON() ([]byte, error)

func (*TokenDetail) UnmarshalJSON

func (s *TokenDetail) UnmarshalJSON(b []byte) error

type TokenInfo

type TokenInfo struct {
	// Full activation url to retrieve the access token. It will be empty if the
	// token is already retrieved.
	ActivationUrl string `json:"activation_url,omitempty"`
	// Time at which this Recipient Token was created, in epoch milliseconds.
	CreatedAt int64 `json:"created_at,omitempty"`
	// Username of Recipient Token creator.
	CreatedBy string `json:"created_by,omitempty"`
	// Expiration timestamp of the token in epoch milliseconds.
	ExpirationTime int64 `json:"expiration_time,omitempty"`
	// Unique id of the Recipient Token.
	Id string `json:"id,omitempty"`
	// Time at which this Recipient Token was updated, in epoch milliseconds.
	UpdatedAt int64 `json:"updated_at,omitempty"`
	// Username of Recipient Token updater.
	UpdatedBy string `json:"updated_by,omitempty"`

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

func (TokenInfo) MarshalJSON

func (s TokenInfo) MarshalJSON() ([]byte, error)

func (*TokenInfo) UnmarshalJSON

func (s *TokenInfo) UnmarshalJSON(b []byte) error

type UpdateExchangeFilterRequest

type UpdateExchangeFilterRequest struct {
	Filter ExchangeFilter `json:"filter"`

	Id string `json:"-" url:"-"`
}

type UpdateExchangeFilterResponse

type UpdateExchangeFilterResponse struct {
	Filter *ExchangeFilter `json:"filter,omitempty"`
}

type UpdateExchangeRequest

type UpdateExchangeRequest struct {
	Exchange Exchange `json:"exchange"`

	Id string `json:"-" url:"-"`
}

type UpdateExchangeResponse

type UpdateExchangeResponse struct {
	Exchange *Exchange `json:"exchange,omitempty"`
}

type UpdateInstallationRequest

type UpdateInstallationRequest struct {
	Installation InstallationDetail `json:"installation"`

	InstallationId string `json:"-" url:"-"`

	ListingId string `json:"-" url:"-"`

	RotateToken bool `json:"rotate_token,omitempty"`

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

func (UpdateInstallationRequest) MarshalJSON

func (s UpdateInstallationRequest) MarshalJSON() ([]byte, error)

func (*UpdateInstallationRequest) UnmarshalJSON

func (s *UpdateInstallationRequest) UnmarshalJSON(b []byte) error

type UpdateInstallationResponse

type UpdateInstallationResponse struct {
	Installation *InstallationDetail `json:"installation,omitempty"`
}

type UpdateListingRequest

type UpdateListingRequest struct {
	Id string `json:"-" url:"-"`

	Listing Listing `json:"listing"`
}

type UpdateListingResponse

type UpdateListingResponse struct {
	Listing *Listing `json:"listing,omitempty"`
}

type UpdatePersonalizationRequestRequest

type UpdatePersonalizationRequestRequest struct {
	ListingId string `json:"-" url:"-"`

	Reason string `json:"reason,omitempty"`

	RequestId string `json:"-" url:"-"`

	Share *ShareInfo `json:"share,omitempty"`

	Status PersonalizationRequestStatus `json:"status"`

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

func (UpdatePersonalizationRequestRequest) MarshalJSON

func (s UpdatePersonalizationRequestRequest) MarshalJSON() ([]byte, error)

func (*UpdatePersonalizationRequestRequest) UnmarshalJSON

func (s *UpdatePersonalizationRequestRequest) UnmarshalJSON(b []byte) error

type UpdatePersonalizationRequestResponse

type UpdatePersonalizationRequestResponse struct {
	Request *PersonalizationRequest `json:"request,omitempty"`
}

type UpdateProviderAnalyticsDashboardRequest

type UpdateProviderAnalyticsDashboardRequest struct {
	// id is immutable property and can't be updated.
	Id string `json:"-" url:"-"`
	// this is the version of the dashboard template we want to update our user
	// to current expectation is that it should be equal to latest version of
	// the dashboard template
	Version int64 `json:"version,omitempty"`

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

func (UpdateProviderAnalyticsDashboardRequest) MarshalJSON

func (s UpdateProviderAnalyticsDashboardRequest) MarshalJSON() ([]byte, error)

func (*UpdateProviderAnalyticsDashboardRequest) UnmarshalJSON

func (s *UpdateProviderAnalyticsDashboardRequest) UnmarshalJSON(b []byte) error

type UpdateProviderAnalyticsDashboardResponse

type UpdateProviderAnalyticsDashboardResponse struct {
	// this is newly created Lakeview dashboard for the user
	DashboardId string `json:"dashboard_id"`
	// id & version should be the same as the request
	Id string `json:"id"`

	Version int64 `json:"version,omitempty"`

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

func (UpdateProviderAnalyticsDashboardResponse) MarshalJSON

func (*UpdateProviderAnalyticsDashboardResponse) UnmarshalJSON

func (s *UpdateProviderAnalyticsDashboardResponse) UnmarshalJSON(b []byte) error

type UpdateProviderRequest

type UpdateProviderRequest struct {
	Id string `json:"-" url:"-"`

	Provider ProviderInfo `json:"provider"`
}

type UpdateProviderResponse

type UpdateProviderResponse struct {
	Provider *ProviderInfo `json:"provider,omitempty"`
}

type Visibility

type Visibility string
const VisibilityPrivate Visibility = `PRIVATE`
const VisibilityPublic Visibility = `PUBLIC`

func (*Visibility) Set

func (f *Visibility) Set(v string) error

Set raw string value and validate it against allowed values

func (*Visibility) String

func (f *Visibility) String() string

String representation for fmt.Print

func (*Visibility) Type

func (f *Visibility) Type() string

Type always returns Visibility to satisfy [pflag.Value] interface

type VisibilityFilter

type VisibilityFilter struct {
	FilterType FilterType `json:"filterType,omitempty"`

	FilterValue string `json:"filterValue,omitempty"`

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

func (VisibilityFilter) MarshalJSON

func (s VisibilityFilter) MarshalJSON() ([]byte, error)

func (*VisibilityFilter) UnmarshalJSON

func (s *VisibilityFilter) UnmarshalJSON(b []byte) error

Jump to

Keyboard shortcuts

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