sharing_tf

package
v1.58.0 Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateProvider 

type CreateProvider struct {
	// The delta sharing authentication type.
	AuthenticationType types.String `tfsdk:"authentication_type" tf:""`
	// Description about the provider.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// The name of the Provider.
	Name types.String `tfsdk:"name" tf:""`
	// This field is required when the __authentication_type__ is **TOKEN** or
	// not provided.
	RecipientProfileStr types.String `tfsdk:"recipient_profile_str" tf:"optional"`
}

func (*CreateProvider) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateProvider) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateProvider)

func (*CreateProvider) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateProvider) SyncEffectiveFieldsDuringRead(existingState CreateProvider)

type CreateRecipient 

type CreateRecipient struct {
	// The delta sharing authentication type.
	AuthenticationType types.String `tfsdk:"authentication_type" tf:""`
	// Description about the recipient.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// The global Unity Catalog metastore id provided by the data recipient.
	// This field is required when the __authentication_type__ is
	// **DATABRICKS**. The identifier is of format
	// __cloud__:__region__:__metastore-uuid__.
	DataRecipientGlobalMetastoreId types.String `tfsdk:"data_recipient_global_metastore_id" tf:"optional"`
	// Expiration timestamp of the token, in epoch milliseconds.
	ExpirationTime types.Int64 `tfsdk:"expiration_time" tf:"optional"`
	// IP Access List
	IpAccessList []IpAccessList `tfsdk:"ip_access_list" tf:"optional,object"`
	// Name of Recipient.
	Name types.String `tfsdk:"name" tf:""`
	// Username of the recipient owner.
	Owner types.String `tfsdk:"owner" tf:"optional"`
	// Recipient properties as map of string key-value pairs.
	PropertiesKvpairs []SecurablePropertiesKvPairs `tfsdk:"properties_kvpairs" tf:"optional,object"`
	// The one-time sharing code provided by the data recipient. This field is
	// required when the __authentication_type__ is **DATABRICKS**.
	SharingCode types.String `tfsdk:"sharing_code" tf:"optional"`
}

func (*CreateRecipient) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateRecipient) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateRecipient)

func (*CreateRecipient) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateRecipient) SyncEffectiveFieldsDuringRead(existingState CreateRecipient)

type CreateShare 

type CreateShare struct {
	// User-provided free-form text description.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// Name of the share.
	Name types.String `tfsdk:"name" tf:""`
	// Storage root URL for the share.
	StorageRoot types.String `tfsdk:"storage_root" tf:"optional"`
}

func (*CreateShare) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateShare) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateShare)

func (*CreateShare) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateShare) SyncEffectiveFieldsDuringRead(existingState CreateShare)

type DeleteProviderRequest 

type DeleteProviderRequest struct {
	// Name of the provider.
	Name types.String `tfsdk:"-"`
}

Delete a provider

func (*DeleteProviderRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteProviderRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteProviderRequest)

func (*DeleteProviderRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteProviderRequest) SyncEffectiveFieldsDuringRead(existingState DeleteProviderRequest)

type DeleteRecipientRequest 

type DeleteRecipientRequest struct {
	// Name of the recipient.
	Name types.String `tfsdk:"-"`
}

Delete a share recipient

func (*DeleteRecipientRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteRecipientRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteRecipientRequest)

func (*DeleteRecipientRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteRecipientRequest) SyncEffectiveFieldsDuringRead(existingState DeleteRecipientRequest)

type DeleteResponse 

type DeleteResponse struct {
}

func (*DeleteResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteResponse)

func (*DeleteResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteResponse) SyncEffectiveFieldsDuringRead(existingState DeleteResponse)

type DeleteShareRequest 

type DeleteShareRequest struct {
	// The name of the share.
	Name types.String `tfsdk:"-"`
}

Delete a share

func (*DeleteShareRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteShareRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteShareRequest)

func (*DeleteShareRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteShareRequest) SyncEffectiveFieldsDuringRead(existingState DeleteShareRequest)

type GetActivationUrlInfoRequest 

type GetActivationUrlInfoRequest struct {
	// The one time activation url. It also accepts activation token.
	ActivationUrl types.String `tfsdk:"-"`
}

Get a share activation URL

func (*GetActivationUrlInfoRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetActivationUrlInfoRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetActivationUrlInfoRequest)

func (*GetActivationUrlInfoRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetActivationUrlInfoRequest) SyncEffectiveFieldsDuringRead(existingState GetActivationUrlInfoRequest)

type GetActivationUrlInfoResponse 

type GetActivationUrlInfoResponse struct {
}

func (*GetActivationUrlInfoResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetActivationUrlInfoResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetActivationUrlInfoResponse)

func (*GetActivationUrlInfoResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetActivationUrlInfoResponse) SyncEffectiveFieldsDuringRead(existingState GetActivationUrlInfoResponse)

type GetProviderRequest 

type GetProviderRequest struct {
	// Name of the provider.
	Name types.String `tfsdk:"-"`
}

Get a provider

func (*GetProviderRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetProviderRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetProviderRequest)

func (*GetProviderRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetProviderRequest) SyncEffectiveFieldsDuringRead(existingState GetProviderRequest)

type GetRecipientRequest 

type GetRecipientRequest struct {
	// Name of the recipient.
	Name types.String `tfsdk:"-"`
}

Get a share recipient

func (*GetRecipientRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetRecipientRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetRecipientRequest)

func (*GetRecipientRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetRecipientRequest) SyncEffectiveFieldsDuringRead(existingState GetRecipientRequest)

type GetRecipientSharePermissionsResponse 

type GetRecipientSharePermissionsResponse struct {
	// Opaque token to retrieve the next page of results. Absent if there are no
	// more pages. __page_token__ should be set to this value for the next
	// request (for the next page of results).
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
	// An array of data share permissions for a recipient.
	PermissionsOut []ShareToPrivilegeAssignment `tfsdk:"permissions_out" tf:"optional"`
}

func (*GetRecipientSharePermissionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetRecipientSharePermissionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetRecipientSharePermissionsResponse)

func (*GetRecipientSharePermissionsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetRecipientSharePermissionsResponse) SyncEffectiveFieldsDuringRead(existingState GetRecipientSharePermissionsResponse)

type GetShareRequest 

type GetShareRequest struct {
	// Query for data to include in the share.
	IncludeSharedData types.Bool `tfsdk:"-"`
	// The name of the share.
	Name types.String `tfsdk:"-"`
}

Get a share

func (*GetShareRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetShareRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetShareRequest)

func (*GetShareRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetShareRequest) SyncEffectiveFieldsDuringRead(existingState GetShareRequest)

type IpAccessList 

type IpAccessList struct {
	// Allowed IP Addresses in CIDR notation. Limit of 100.
	AllowedIpAddresses []types.String `tfsdk:"allowed_ip_addresses" tf:"optional"`
}

func (*IpAccessList) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *IpAccessList) SyncEffectiveFieldsDuringCreateOrUpdate(plan IpAccessList)

func (*IpAccessList) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *IpAccessList) SyncEffectiveFieldsDuringRead(existingState IpAccessList)

type ListProviderSharesResponse 

type ListProviderSharesResponse struct {
	// Opaque token to retrieve the next page of results. Absent if there are no
	// more pages. __page_token__ should be set to this value for the next
	// request (for the next page of results).
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
	// An array of provider shares.
	Shares []ProviderShare `tfsdk:"shares" tf:"optional"`
}

func (*ListProviderSharesResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListProviderSharesResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListProviderSharesResponse)

func (*ListProviderSharesResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListProviderSharesResponse) SyncEffectiveFieldsDuringRead(existingState ListProviderSharesResponse)

type ListProvidersRequest 

type ListProvidersRequest struct {
	// If not provided, all providers will be returned. If no providers exist
	// with this ID, no results will be returned.
	DataProviderGlobalMetastoreId types.String `tfsdk:"-"`
	// Maximum number of providers to return. - when set to 0, the page length
	// is set to a server configured value (recommended); - when set to a value
	// greater than 0, the page length is the minimum of this value and a server
	// configured value; - when set to a value less than 0, an invalid parameter
	// error is returned; - If not set, all valid providers are returned (not
	// recommended). - Note: The number of returned providers might be less than
	// the specified max_results size, even zero. The only definitive indication
	// that no further providers can be fetched is when the next_page_token is
	// unset from the response.
	MaxResults types.Int64 `tfsdk:"-"`
	// Opaque pagination token to go to next page based on previous query.
	PageToken types.String `tfsdk:"-"`
}

List providers

func (*ListProvidersRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListProvidersRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListProvidersRequest)

func (*ListProvidersRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListProvidersRequest) SyncEffectiveFieldsDuringRead(existingState ListProvidersRequest)

type ListProvidersResponse 

type ListProvidersResponse struct {
	// Opaque token to retrieve the next page of results. Absent if there are no
	// more pages. __page_token__ should be set to this value for the next
	// request (for the next page of results).
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
	// An array of provider information objects.
	Providers []ProviderInfo `tfsdk:"providers" tf:"optional"`
}

func (*ListProvidersResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListProvidersResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListProvidersResponse)

func (*ListProvidersResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListProvidersResponse) SyncEffectiveFieldsDuringRead(existingState ListProvidersResponse)

type ListRecipientsRequest 

type ListRecipientsRequest struct {
	// If not provided, all recipients will be returned. If no recipients exist
	// with this ID, no results will be returned.
	DataRecipientGlobalMetastoreId types.String `tfsdk:"-"`
	// Maximum number of recipients to return. - when set to 0, the page length
	// is set to a server configured value (recommended); - when set to a value
	// greater than 0, the page length is the minimum of this value and a server
	// configured value; - when set to a value less than 0, an invalid parameter
	// error is returned; - If not set, all valid recipients are returned (not
	// recommended). - Note: The number of returned recipients might be less
	// than the specified max_results size, even zero. The only definitive
	// indication that no further recipients can be fetched is when the
	// next_page_token is unset from the response.
	MaxResults types.Int64 `tfsdk:"-"`
	// Opaque pagination token to go to next page based on previous query.
	PageToken types.String `tfsdk:"-"`
}

List share recipients

func (*ListRecipientsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListRecipientsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListRecipientsRequest)

func (*ListRecipientsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListRecipientsRequest) SyncEffectiveFieldsDuringRead(existingState ListRecipientsRequest)

type ListRecipientsResponse 

type ListRecipientsResponse struct {
	// Opaque token to retrieve the next page of results. Absent if there are no
	// more pages. __page_token__ should be set to this value for the next
	// request (for the next page of results).
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
	// An array of recipient information objects.
	Recipients []RecipientInfo `tfsdk:"recipients" tf:"optional"`
}

func (*ListRecipientsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListRecipientsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListRecipientsResponse)

func (*ListRecipientsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListRecipientsResponse) SyncEffectiveFieldsDuringRead(existingState ListRecipientsResponse)

type ListSharesRequest 

type ListSharesRequest struct {
	// Maximum number of shares to return. - when set to 0, the page length is
	// set to a server configured value (recommended); - when set to a value
	// greater than 0, the page length is the minimum of this value and a server
	// configured value; - when set to a value less than 0, an invalid parameter
	// error is returned; - If not set, all valid shares are returned (not
	// recommended). - Note: The number of returned shares might be less than
	// the specified max_results size, even zero. The only definitive indication
	// that no further shares can be fetched is when the next_page_token is
	// unset from the response.
	MaxResults types.Int64 `tfsdk:"-"`
	// Name of the provider in which to list shares.
	Name types.String `tfsdk:"-"`
	// Opaque pagination token to go to next page based on previous query.
	PageToken types.String `tfsdk:"-"`
}

List shares by Provider

func (*ListSharesRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListSharesRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListSharesRequest)

func (*ListSharesRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListSharesRequest) SyncEffectiveFieldsDuringRead(existingState ListSharesRequest)

type ListSharesResponse 

type ListSharesResponse struct {
	// Opaque token to retrieve the next page of results. Absent if there are no
	// more pages. __page_token__ should be set to this value for the next
	// request (for the next page of results).
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
	// An array of data share information objects.
	Shares []ShareInfo `tfsdk:"shares" tf:"optional"`
}

func (*ListSharesResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListSharesResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListSharesResponse)

func (*ListSharesResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListSharesResponse) SyncEffectiveFieldsDuringRead(existingState ListSharesResponse)

type Partition 

type Partition struct {
	// An array of partition values.
	Values []PartitionValue `tfsdk:"value" tf:"optional"`
}

func (*Partition) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Partition) SyncEffectiveFieldsDuringCreateOrUpdate(plan Partition)

func (*Partition) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Partition) SyncEffectiveFieldsDuringRead(existingState Partition)

type PartitionValue 

type PartitionValue struct {
	// The name of the partition column.
	Name types.String `tfsdk:"name" tf:"optional"`
	// The operator to apply for the value.
	Op types.String `tfsdk:"op" tf:"optional"`
	// The key of a Delta Sharing recipient's property. For example
	// `databricks-account-id`. When this field is set, field `value` can not be
	// set.
	RecipientPropertyKey types.String `tfsdk:"recipient_property_key" tf:"optional"`
	// The value of the partition column. When this value is not set, it means
	// `null` value. When this field is set, field `recipient_property_key` can
	// not be set.
	Value types.String `tfsdk:"value" tf:"optional"`
}

func (*PartitionValue) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PartitionValue) SyncEffectiveFieldsDuringCreateOrUpdate(plan PartitionValue)

func (*PartitionValue) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PartitionValue) SyncEffectiveFieldsDuringRead(existingState PartitionValue)

type PrivilegeAssignment 

type PrivilegeAssignment struct {
	// The principal (user email address or group name).
	Principal types.String `tfsdk:"principal" tf:"optional"`
	// The privileges assigned to the principal.
	Privileges []types.String `tfsdk:"privileges" tf:"optional"`
}

func (*PrivilegeAssignment) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PrivilegeAssignment) SyncEffectiveFieldsDuringCreateOrUpdate(plan PrivilegeAssignment)

func (*PrivilegeAssignment) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PrivilegeAssignment) SyncEffectiveFieldsDuringRead(existingState PrivilegeAssignment)

type ProviderInfo 

type ProviderInfo struct {
	// The delta sharing authentication type.
	AuthenticationType types.String `tfsdk:"authentication_type" tf:"optional"`
	// Cloud vendor of the provider's UC metastore. This field is only present
	// when the __authentication_type__ is **DATABRICKS**.
	Cloud types.String `tfsdk:"cloud" tf:"optional"`
	// Description about the provider.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// Time at which this Provider was created, in epoch milliseconds.
	CreatedAt types.Int64 `tfsdk:"created_at" tf:"optional"`
	// Username of Provider creator.
	CreatedBy types.String `tfsdk:"created_by" tf:"optional"`
	// The global UC metastore id of the data provider. This field is only
	// present when the __authentication_type__ is **DATABRICKS**. The
	// identifier is of format <cloud>:<region>:<metastore-uuid>.
	DataProviderGlobalMetastoreId types.String `tfsdk:"data_provider_global_metastore_id" tf:"optional"`
	// UUID of the provider's UC metastore. This field is only present when the
	// __authentication_type__ is **DATABRICKS**.
	MetastoreId types.String `tfsdk:"metastore_id" tf:"optional"`
	// The name of the Provider.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Username of Provider owner.
	Owner types.String `tfsdk:"owner" tf:"optional"`
	// The recipient profile. This field is only present when the
	// authentication_type is `TOKEN`.
	RecipientProfile []RecipientProfile `tfsdk:"recipient_profile" tf:"optional,object"`
	// This field is only present when the authentication_type is `TOKEN` or not
	// provided.
	RecipientProfileStr types.String `tfsdk:"recipient_profile_str" tf:"optional"`
	// Cloud region of the provider's UC metastore. This field is only present
	// when the __authentication_type__ is **DATABRICKS**.
	Region types.String `tfsdk:"region" tf:"optional"`
	// Time at which this Provider was created, in epoch milliseconds.
	UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"optional"`
	// Username of user who last modified Share.
	UpdatedBy types.String `tfsdk:"updated_by" tf:"optional"`
}

func (*ProviderInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ProviderInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan ProviderInfo)

func (*ProviderInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ProviderInfo) SyncEffectiveFieldsDuringRead(existingState ProviderInfo)

type ProviderShare 

type ProviderShare struct {
	// The name of the Provider Share.
	Name types.String `tfsdk:"name" tf:"optional"`
}

func (*ProviderShare) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ProviderShare) SyncEffectiveFieldsDuringCreateOrUpdate(plan ProviderShare)

func (*ProviderShare) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ProviderShare) SyncEffectiveFieldsDuringRead(existingState ProviderShare)

type RecipientInfo 

type RecipientInfo struct {
	// A boolean status field showing whether the Recipient's activation URL has
	// been exercised or not.
	Activated types.Bool `tfsdk:"activated" tf:"optional"`
	// Full activation url to retrieve the access token. It will be empty if the
	// token is already retrieved.
	ActivationUrl types.String `tfsdk:"activation_url" tf:"optional"`
	// The delta sharing authentication type.
	AuthenticationType types.String `tfsdk:"authentication_type" tf:"optional"`
	// Cloud vendor of the recipient's Unity Catalog Metstore. This field is
	// only present when the __authentication_type__ is **DATABRICKS**`.
	Cloud types.String `tfsdk:"cloud" tf:"optional"`
	// Description about the recipient.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// Time at which this recipient was created, in epoch milliseconds.
	CreatedAt types.Int64 `tfsdk:"created_at" tf:"optional"`
	// Username of recipient creator.
	CreatedBy types.String `tfsdk:"created_by" tf:"optional"`
	// The global Unity Catalog metastore id provided by the data recipient.
	// This field is only present when the __authentication_type__ is
	// **DATABRICKS**. The identifier is of format
	// __cloud__:__region__:__metastore-uuid__.
	DataRecipientGlobalMetastoreId types.String `tfsdk:"data_recipient_global_metastore_id" tf:"optional"`
	// IP Access List
	IpAccessList []IpAccessList `tfsdk:"ip_access_list" tf:"optional,object"`
	// Unique identifier of recipient's Unity Catalog metastore. This field is
	// only present when the __authentication_type__ is **DATABRICKS**
	MetastoreId types.String `tfsdk:"metastore_id" tf:"optional"`
	// Name of Recipient.
	Name types.String `tfsdk:"name" tf:"optional"`
	// Username of the recipient owner.
	Owner types.String `tfsdk:"owner" tf:"optional"`
	// Recipient properties as map of string key-value pairs.
	PropertiesKvpairs []SecurablePropertiesKvPairs `tfsdk:"properties_kvpairs" tf:"optional,object"`
	// Cloud region of the recipient's Unity Catalog Metstore. This field is
	// only present when the __authentication_type__ is **DATABRICKS**.
	Region types.String `tfsdk:"region" tf:"optional"`
	// The one-time sharing code provided by the data recipient. This field is
	// only present when the __authentication_type__ is **DATABRICKS**.
	SharingCode types.String `tfsdk:"sharing_code" tf:"optional"`
	// This field is only present when the __authentication_type__ is **TOKEN**.
	Tokens []RecipientTokenInfo `tfsdk:"tokens" tf:"optional"`
	// Time at which the recipient was updated, in epoch milliseconds.
	UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"optional"`
	// Username of recipient updater.
	UpdatedBy types.String `tfsdk:"updated_by" tf:"optional"`
}

func (*RecipientInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RecipientInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan RecipientInfo)

func (*RecipientInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RecipientInfo) SyncEffectiveFieldsDuringRead(existingState RecipientInfo)

type RecipientProfile 

type RecipientProfile struct {
	// The token used to authorize the recipient.
	BearerToken types.String `tfsdk:"bearer_token" tf:"optional"`
	// The endpoint for the share to be used by the recipient.
	Endpoint types.String `tfsdk:"endpoint" tf:"optional"`
	// The version number of the recipient's credentials on a share.
	ShareCredentialsVersion types.Int64 `tfsdk:"share_credentials_version" tf:"optional"`
}

func (*RecipientProfile) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RecipientProfile) SyncEffectiveFieldsDuringCreateOrUpdate(plan RecipientProfile)

func (*RecipientProfile) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RecipientProfile) SyncEffectiveFieldsDuringRead(existingState RecipientProfile)

type RecipientTokenInfo 

type RecipientTokenInfo struct {
	// Full activation URL to retrieve the access token. It will be empty if the
	// token is already retrieved.
	ActivationUrl types.String `tfsdk:"activation_url" tf:"optional"`
	// Time at which this recipient Token was created, in epoch milliseconds.
	CreatedAt types.Int64 `tfsdk:"created_at" tf:"optional"`
	// Username of recipient token creator.
	CreatedBy types.String `tfsdk:"created_by" tf:"optional"`
	// Expiration timestamp of the token in epoch milliseconds.
	ExpirationTime types.Int64 `tfsdk:"expiration_time" tf:"optional"`
	// Unique ID of the recipient token.
	Id types.String `tfsdk:"id" tf:"optional"`
	// Time at which this recipient Token was updated, in epoch milliseconds.
	UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"optional"`
	// Username of recipient Token updater.
	UpdatedBy types.String `tfsdk:"updated_by" tf:"optional"`
}

func (*RecipientTokenInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RecipientTokenInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan RecipientTokenInfo)

func (*RecipientTokenInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RecipientTokenInfo) SyncEffectiveFieldsDuringRead(existingState RecipientTokenInfo)

type RetrieveTokenRequest 

type RetrieveTokenRequest struct {
	// The one time activation url. It also accepts activation token.
	ActivationUrl types.String `tfsdk:"-"`
}

Get an access token

func (*RetrieveTokenRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RetrieveTokenRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan RetrieveTokenRequest)

func (*RetrieveTokenRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RetrieveTokenRequest) SyncEffectiveFieldsDuringRead(existingState RetrieveTokenRequest)

type RetrieveTokenResponse 

type RetrieveTokenResponse struct {
	// The token used to authorize the recipient.
	BearerToken types.String `tfsdk:"bearerToken" tf:"optional"`
	// The endpoint for the share to be used by the recipient.
	Endpoint types.String `tfsdk:"endpoint" tf:"optional"`
	// Expiration timestamp of the token in epoch milliseconds.
	ExpirationTime types.String `tfsdk:"expirationTime" tf:"optional"`
	// These field names must follow the delta sharing protocol.
	ShareCredentialsVersion types.Int64 `tfsdk:"shareCredentialsVersion" tf:"optional"`
}

func (*RetrieveTokenResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RetrieveTokenResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan RetrieveTokenResponse)

func (*RetrieveTokenResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RetrieveTokenResponse) SyncEffectiveFieldsDuringRead(existingState RetrieveTokenResponse)

type RotateRecipientToken 

type RotateRecipientToken struct {
	// The expiration time of the bearer token in ISO 8601 format. This will set
	// the expiration_time of existing token only to a smaller timestamp, it
	// cannot extend the expiration_time. Use 0 to expire the existing token
	// immediately, negative number will return an error.
	ExistingTokenExpireInSeconds types.Int64 `tfsdk:"existing_token_expire_in_seconds" tf:""`
	// The name of the recipient.
	Name types.String `tfsdk:"-"`
}

func (*RotateRecipientToken) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *RotateRecipientToken) SyncEffectiveFieldsDuringCreateOrUpdate(plan RotateRecipientToken)

func (*RotateRecipientToken) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *RotateRecipientToken) SyncEffectiveFieldsDuringRead(existingState RotateRecipientToken)

type SecurablePropertiesKvPairs 

type SecurablePropertiesKvPairs struct {
	// A map of key-value properties attached to the securable.
	Properties map[string]types.String `tfsdk:"properties" tf:""`
}

An object with __properties__ containing map of key-value properties attached to the securable.

func (*SecurablePropertiesKvPairs) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SecurablePropertiesKvPairs) SyncEffectiveFieldsDuringCreateOrUpdate(plan SecurablePropertiesKvPairs)

func (*SecurablePropertiesKvPairs) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SecurablePropertiesKvPairs) SyncEffectiveFieldsDuringRead(existingState SecurablePropertiesKvPairs)

type ShareInfo 

type ShareInfo struct {
	// User-provided free-form text description.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// Time at which this share was created, in epoch milliseconds.
	CreatedAt types.Int64 `tfsdk:"created_at" tf:"computed,optional"`
	// Username of share creator.
	CreatedBy types.String `tfsdk:"created_by" tf:"computed,optional"`
	// Name of the share.
	Name types.String `tfsdk:"name" tf:"optional"`
	// A list of shared data objects within the share.
	Objects []SharedDataObject `tfsdk:"object" tf:"optional"`
	// Username of current owner of share.
	Owner          types.String `tfsdk:"owner" tf:"optional"`
	EffectiveOwner types.String `tfsdk:"effective_owner" tf:"computed,optional"`
	// Storage Location URL (full path) for the share.
	StorageLocation types.String `tfsdk:"storage_location" tf:"optional"`
	// Storage root URL for the share.
	StorageRoot types.String `tfsdk:"storage_root" tf:"optional"`
	// Time at which this share was updated, in epoch milliseconds.
	UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"computed,optional"`
	// Username of share updater.
	UpdatedBy types.String `tfsdk:"updated_by" tf:"computed,optional"`
}

func (*ShareInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ShareInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan ShareInfo)

func (*ShareInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ShareInfo) SyncEffectiveFieldsDuringRead(existingState ShareInfo)

type SharePermissionsRequest 

type SharePermissionsRequest struct {
	// Maximum number of permissions to return. - when set to 0, the page length
	// is set to a server configured value (recommended); - when set to a value
	// greater than 0, the page length is the minimum of this value and a server
	// configured value; - when set to a value less than 0, an invalid parameter
	// error is returned; - If not set, all valid permissions are returned (not
	// recommended). - Note: The number of returned permissions might be less
	// than the specified max_results size, even zero. The only definitive
	// indication that no further permissions can be fetched is when the
	// next_page_token is unset from the response.
	MaxResults types.Int64 `tfsdk:"-"`
	// The name of the Recipient.
	Name types.String `tfsdk:"-"`
	// Opaque pagination token to go to next page based on previous query.
	PageToken types.String `tfsdk:"-"`
}

Get recipient share permissions

func (*SharePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SharePermissionsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan SharePermissionsRequest)

func (*SharePermissionsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SharePermissionsRequest) SyncEffectiveFieldsDuringRead(existingState SharePermissionsRequest)

type ShareToPrivilegeAssignment 

type ShareToPrivilegeAssignment struct {
	// The privileges assigned to the principal.
	PrivilegeAssignments []PrivilegeAssignment `tfsdk:"privilege_assignments" tf:"optional"`
	// The share name.
	ShareName types.String `tfsdk:"share_name" tf:"optional"`
}

func (*ShareToPrivilegeAssignment) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ShareToPrivilegeAssignment) SyncEffectiveFieldsDuringCreateOrUpdate(plan ShareToPrivilegeAssignment)

func (*ShareToPrivilegeAssignment) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ShareToPrivilegeAssignment) SyncEffectiveFieldsDuringRead(existingState ShareToPrivilegeAssignment)

type SharedDataObject 

type SharedDataObject struct {
	// The time when this data object is added to the share, in epoch
	// milliseconds.
	AddedAt types.Int64 `tfsdk:"added_at" tf:"computed,optional"`
	// Username of the sharer.
	AddedBy types.String `tfsdk:"added_by" tf:"computed,optional"`
	// Whether to enable cdf or indicate if cdf is enabled on the shared object.
	CdfEnabled          types.Bool `tfsdk:"cdf_enabled" tf:"optional"`
	EffectiveCdfEnabled types.Bool `tfsdk:"effective_cdf_enabled" tf:"computed,optional"`
	// A user-provided comment when adding the data object to the share.
	// [Update:OPT]
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// The content of the notebook file when the data object type is
	// NOTEBOOK_FILE. This should be base64 encoded. Required for adding a
	// NOTEBOOK_FILE, optional for updating, ignored for other types.
	Content types.String `tfsdk:"content" tf:"optional"`
	// The type of the data object.
	DataObjectType types.String `tfsdk:"data_object_type" tf:"optional"`
	// Whether to enable or disable sharing of data history. If not specified,
	// the default is **DISABLED**.
	HistoryDataSharingStatus          types.String `tfsdk:"history_data_sharing_status" tf:"optional"`
	EffectiveHistoryDataSharingStatus types.String `tfsdk:"effective_history_data_sharing_status" tf:"computed,optional"`
	// A fully qualified name that uniquely identifies a data object.
	//
	// For example, a table's fully qualified name is in the format of
	// `<catalog>.<schema>.<table>`.
	Name types.String `tfsdk:"name" tf:""`
	// Array of partitions for the shared data.
	Partitions []Partition `tfsdk:"partition" tf:"optional"`
	// A user-provided new name for the data object within the share. If this
	// new name is not provided, the object's original name will be used as the
	// `shared_as` name. The `shared_as` name must be unique within a share. For
	// tables, the new name must follow the format of `<schema>.<table>`.
	SharedAs          types.String `tfsdk:"shared_as" tf:"optional"`
	EffectiveSharedAs types.String `tfsdk:"effective_shared_as" tf:"computed,optional"`
	// The start version associated with the object. This allows data providers
	// to control the lowest object version that is accessible by clients. If
	// specified, clients can query snapshots or changes for versions >=
	// start_version. If not specified, clients can only query starting from the
	// version of the object at the time it was added to the share.
	//
	// NOTE: The start_version should be <= the `current` version of the object.
	StartVersion          types.Int64 `tfsdk:"start_version" tf:"optional"`
	EffectiveStartVersion types.Int64 `tfsdk:"effective_start_version" tf:"computed,optional"`
	// One of: **ACTIVE**, **PERMISSION_DENIED**.
	Status types.String `tfsdk:"status" tf:"computed,optional"`
	// A user-provided new name for the data object within the share. If this
	// new name is not provided, the object's original name will be used as the
	// `string_shared_as` name. The `string_shared_as` name must be unique
	// within a share. For notebooks, the new name should be the new notebook
	// file name.
	StringSharedAs types.String `tfsdk:"string_shared_as" tf:"optional"`
}

func (*SharedDataObject) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SharedDataObject) SyncEffectiveFieldsDuringCreateOrUpdate(plan SharedDataObject)

func (*SharedDataObject) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SharedDataObject) SyncEffectiveFieldsDuringRead(existingState SharedDataObject)

type SharedDataObjectUpdate 

type SharedDataObjectUpdate struct {
	// One of: **ADD**, **REMOVE**, **UPDATE**.
	Action types.String `tfsdk:"action" tf:"optional"`
	// The data object that is being added, removed, or updated.
	DataObject []SharedDataObject `tfsdk:"data_object" tf:"optional,object"`
}

func (*SharedDataObjectUpdate) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *SharedDataObjectUpdate) SyncEffectiveFieldsDuringCreateOrUpdate(plan SharedDataObjectUpdate)

func (*SharedDataObjectUpdate) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *SharedDataObjectUpdate) SyncEffectiveFieldsDuringRead(existingState SharedDataObjectUpdate)

type UpdatePermissionsResponse 

type UpdatePermissionsResponse struct {
}

func (*UpdatePermissionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdatePermissionsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdatePermissionsResponse)

func (*UpdatePermissionsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdatePermissionsResponse) SyncEffectiveFieldsDuringRead(existingState UpdatePermissionsResponse)

type UpdateProvider 

type UpdateProvider struct {
	// Description about the provider.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// Name of the provider.
	Name types.String `tfsdk:"-"`
	// New name for the provider.
	NewName types.String `tfsdk:"new_name" tf:"optional"`
	// Username of Provider owner.
	Owner types.String `tfsdk:"owner" tf:"optional"`
	// This field is required when the __authentication_type__ is **TOKEN** or
	// not provided.
	RecipientProfileStr types.String `tfsdk:"recipient_profile_str" tf:"optional"`
}

func (*UpdateProvider) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateProvider) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateProvider)

func (*UpdateProvider) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateProvider) SyncEffectiveFieldsDuringRead(existingState UpdateProvider)

type UpdateRecipient 

type UpdateRecipient struct {
	// Description about the recipient.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// Expiration timestamp of the token, in epoch milliseconds.
	ExpirationTime types.Int64 `tfsdk:"expiration_time" tf:"optional"`
	// IP Access List
	IpAccessList []IpAccessList `tfsdk:"ip_access_list" tf:"optional,object"`
	// Name of the recipient.
	Name types.String `tfsdk:"-"`
	// New name for the recipient.
	NewName types.String `tfsdk:"new_name" tf:"optional"`
	// Username of the recipient owner.
	Owner types.String `tfsdk:"owner" tf:"optional"`
	// Recipient properties as map of string key-value pairs. When provided in
	// update request, the specified properties will override the existing
	// properties. To add and remove properties, one would need to perform a
	// read-modify-write.
	PropertiesKvpairs []SecurablePropertiesKvPairs `tfsdk:"properties_kvpairs" tf:"optional,object"`
}

func (*UpdateRecipient) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateRecipient) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateRecipient)

func (*UpdateRecipient) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateRecipient) SyncEffectiveFieldsDuringRead(existingState UpdateRecipient)

type UpdateResponse 

type UpdateResponse struct {
}

func (*UpdateResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateResponse)

func (*UpdateResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateResponse) SyncEffectiveFieldsDuringRead(existingState UpdateResponse)

type UpdateShare 

type UpdateShare struct {
	// User-provided free-form text description.
	Comment types.String `tfsdk:"comment" tf:"optional"`
	// The name of the share.
	Name types.String `tfsdk:"-"`
	// New name for the share.
	NewName types.String `tfsdk:"new_name" tf:"optional"`
	// Username of current owner of share.
	Owner          types.String `tfsdk:"owner" tf:"optional"`
	EffectiveOwner types.String `tfsdk:"effective_owner" tf:"computed,optional"`
	// Storage root URL for the share.
	StorageRoot types.String `tfsdk:"storage_root" tf:"optional"`
	// Array of shared data object updates.
	Updates []SharedDataObjectUpdate `tfsdk:"updates" tf:"optional"`
}

func (*UpdateShare) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateShare) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateShare)

func (*UpdateShare) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateShare) SyncEffectiveFieldsDuringRead(existingState UpdateShare)

type UpdateSharePermissions 

type UpdateSharePermissions struct {
	// Array of permission changes.
	Changes catalog.PermissionsChange `tfsdk:"changes" tf:"optional"`
	// Maximum number of permissions to return. - when set to 0, the page length
	// is set to a server configured value (recommended); - when set to a value
	// greater than 0, the page length is the minimum of this value and a server
	// configured value; - when set to a value less than 0, an invalid parameter
	// error is returned; - If not set, all valid permissions are returned (not
	// recommended). - Note: The number of returned permissions might be less
	// than the specified max_results size, even zero. The only definitive
	// indication that no further permissions can be fetched is when the
	// next_page_token is unset from the response.
	MaxResults types.Int64 `tfsdk:"-"`
	// The name of the share.
	Name types.String `tfsdk:"-"`
	// Opaque pagination token to go to next page based on previous query.
	PageToken types.String `tfsdk:"-"`
}

func (*UpdateSharePermissions) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UpdateSharePermissions) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateSharePermissions)

func (*UpdateSharePermissions) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UpdateSharePermissions) SyncEffectiveFieldsDuringRead(existingState UpdateSharePermissions)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.