com.databricks.sdk.service.sharing

Class ProvidersAPI

java.lang.Object

com.databricks.sdk.service.sharing.ProvidersAPI

@Generated
public class ProvidersAPI
extends Object

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.

Constructor Summary

Constructors

Constructor and Description
ProvidersAPI(ApiClient apiClient) Regular-use constructor
ProvidersAPI(ProvidersService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
ProviderInfo	create(CreateProvider request) Creates a new authentication provider minimally based on a name and authentication type.
void	delete(DeleteProviderRequest request) Deletes an authentication provider, if the caller is a metastore admin or is the owner of the provider.
void	delete(String name)
ProviderInfo	get(GetProviderRequest request) Gets a specific authentication provider.
ProviderInfo	get(String name)
ProvidersService	impl()
Iterable<ProviderInfo>	list(ListProvidersRequest request) Gets an array of available authentication providers.
ListProviderShareAssetsResponse	listProviderShareAssets(ListProviderShareAssetsRequest request) Get arrays of assets associated with a specified provider's share.
ListProviderShareAssetsResponse	listProviderShareAssets(String providerName, String shareName)
Iterable<ProviderShare>	listShares(ListSharesRequest request) Gets an array of a specified provider's shares within the metastore where:
Iterable<ProviderShare>	listShares(String name)
ProviderInfo	update(UpdateProvider request) Updates the information for an authentication provider, if the caller is a metastore admin or is the owner of the provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProvidersAPI

public ProvidersAPI(ApiClient apiClient)

Regular-use constructor

ProvidersAPI

public ProvidersAPI(ProvidersService mock)

Constructor for mocks

Method Detail

create

public ProviderInfo create(CreateProvider request)

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

delete

public void delete(String name)

delete

public void delete(DeleteProviderRequest request)

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

get

public ProviderInfo get(String name)

get

public ProviderInfo get(GetProviderRequest request)

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

public Iterable<ProviderInfo> list(ListProvidersRequest request)

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

public ListProviderShareAssetsResponse listProviderShareAssets(String providerName,
                                                               String shareName)

listProviderShareAssets

public ListProviderShareAssetsResponse listProviderShareAssets(ListProviderShareAssetsRequest request)

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

listShares

public Iterable<ProviderShare> listShares(String name)

listShares

public Iterable<ProviderShare> listShares(ListSharesRequest request)

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

public ProviderInfo update(UpdateProvider request)

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.

impl

public ProvidersService impl()