com.databricks.sdk.service.sharing

Interface ProvidersService

@Generated
public interface ProvidersService

A data provider is an object representing the organization in the real world who shares the data. A provider contains shares which further contain the shared data.

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
ProviderInfo	create(CreateProvider createProvider) Creates a new authentication provider minimally based on a name and authentication type.
void	delete(DeleteProviderRequest deleteProviderRequest) Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider.
ProviderInfo	get(GetProviderRequest getProviderRequest) Gets a specific authentication provider.
ListProvidersResponse	list(ListProvidersRequest listProvidersRequest) Gets an array of available authentication providers.
ListProviderShareAssetsResponse	listProviderShareAssets(ListProviderShareAssetsRequest listProviderShareAssetsRequest) Get arrays of assets associated with a specified provider's share.
ListProviderSharesResponse	listShares(ListSharesRequest listSharesRequest) Gets an array of a specified provider's shares within the metastore where:
ProviderInfo	update(UpdateProvider updateProvider) Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider.

Method Detail

create

ProviderInfo create(CreateProvider createProvider)

Creates a new authentication provider minimally based on a name and authentication type. The caller must be an admin on the metastore.

delete

void delete(DeleteProviderRequest deleteProviderRequest)

Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider.

get

ProviderInfo get(GetProviderRequest getProviderRequest)

Gets a specific authentication provider. The caller must supply the name of the provider, and must either be a metastore admin or the owner of the provider.

list

ListProvidersResponse list(ListProvidersRequest listProvidersRequest)

Gets an array of available authentication providers. The caller must either be a metastore admin, have the **USE_PROVIDER** privilege on the providers, or be the owner of the providers. Providers not owned by the caller and for which the caller does not have the **USE_PROVIDER** privilege are not included in the response. There is no guarantee of a specific ordering of the elements in the array.

listProviderShareAssets

ListProviderShareAssetsResponse listProviderShareAssets(ListProviderShareAssetsRequest listProviderShareAssetsRequest)

Get arrays of assets associated with a specified provider's share. The caller is the recipient of the share.

listShares

ListProviderSharesResponse listShares(ListSharesRequest listSharesRequest)

Gets an array of a specified provider's shares within the metastore where:

* the caller is a metastore admin, or * the caller is the owner.

update

ProviderInfo update(UpdateProvider updateProvider)

Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider. If the update changes the provider name, the caller must be both a metastore admin and the owner of the provider.