Package com.databricks.sdk.service.sharing

Class ProvidersAPI

java.lang.Object

com.databricks.sdk.service.sharing.ProvidersAPI

@Generated
public class ProvidersAPI
extends Object

Databricks Providers REST API

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ProviderInfo	create(CreateProvider request)	Create an auth provider.
ProviderInfo	create(String name, AuthenticationType authenticationType)
void	delete(DeleteProviderRequest request)	Delete a provider.
void	delete(String name)
ProviderInfo	get(GetProviderRequest request)	Get a provider.
ProviderInfo	get(String name)
ProvidersService	impl()
Iterable<ProviderInfo>	list(ListProvidersRequest request)	List providers.
Iterable<ProviderShare>	listShares(ListSharesRequest request)	List shares by Provider.
Iterable<ProviderShare>	listShares(String name)
ProviderInfo	update(UpdateProvider request)	Update a provider.
ProviderInfo	update(String name)

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(String name,
                           AuthenticationType authenticationType)

create

public ProviderInfo create(CreateProvider request)

Create an auth provider.

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)

Delete a provider.

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)

Get a provider.

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)

List providers.

Gets an array of available authentication providers. The caller must either be a metastore admin or the owner of the providers. Providers not owned by the caller are not included in the response. There is no guarantee of a specific ordering of the elements in the array.

listShares

public Iterable<ProviderShare> listShares(String name)

listShares

public Iterable<ProviderShare> listShares(ListSharesRequest request)

List shares by Provider.

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(String name)

update

public ProviderInfo update(UpdateProvider request)

Update a provider.

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()