Documentation ¶
Index ¶
- type CentralCleanRoomInfo
- type CleanRoomAssetInfo
- type CleanRoomCatalog
- type CleanRoomCatalogUpdate
- type CleanRoomCollaboratorInfo
- type CleanRoomInfo
- type CleanRoomNotebookInfo
- type CleanRoomTableInfo
- type ColumnInfo
- type ColumnMask
- type CreateCleanRoom
- type CreateProvider
- type CreateRecipient
- type CreateShare
- type DeleteCleanRoomRequest
- type DeleteProviderRequest
- type DeleteRecipientRequest
- type DeleteResponse
- type DeleteShareRequest
- type GetActivationUrlInfoRequest
- type GetActivationUrlInfoResponse
- type GetCleanRoomRequest
- type GetProviderRequest
- type GetRecipientRequest
- type GetRecipientSharePermissionsResponse
- type GetShareRequest
- type IpAccessList
- type ListCleanRoomsRequest
- type ListCleanRoomsResponse
- type ListProviderSharesResponse
- type ListProvidersRequest
- type ListProvidersResponse
- type ListRecipientsRequest
- type ListRecipientsResponse
- type ListSharesRequest
- type ListSharesResponse
- type Partition
- type PartitionValue
- type PrivilegeAssignment
- type ProviderInfo
- type ProviderShare
- type RecipientInfo
- type RecipientProfile
- type RecipientTokenInfo
- type RetrieveTokenRequest
- type RetrieveTokenResponse
- type RotateRecipientToken
- type SecurablePropertiesKvPairs
- type ShareInfo
- type SharePermissionsRequest
- type ShareToPrivilegeAssignment
- type SharedDataObject
- type SharedDataObjectUpdate
- type UpdateCleanRoom
- type UpdatePermissionsResponse
- type UpdateProvider
- type UpdateRecipient
- type UpdateResponse
- type UpdateShare
- type UpdateSharePermissions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CentralCleanRoomInfo ¶
type CentralCleanRoomInfo struct { // All assets from all collaborators that are available in the clean room. // Only one of table_info or notebook_info will be filled in. CleanRoomAssets []CleanRoomAssetInfo `tfsdk:"clean_room_assets" tf:"optional"` // All collaborators who are in the clean room. Collaborators []CleanRoomCollaboratorInfo `tfsdk:"collaborators" tf:"optional"` // The collaborator who created the clean room. Creator []CleanRoomCollaboratorInfo `tfsdk:"creator" tf:"optional,object"` // The cloud where clean room tasks will be run. StationCloud types.String `tfsdk:"station_cloud" tf:"optional"` // The region where clean room tasks will be run. StationRegion types.String `tfsdk:"station_region" tf:"optional"` }
func (*CentralCleanRoomInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CentralCleanRoomInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan CentralCleanRoomInfo)
func (*CentralCleanRoomInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CentralCleanRoomInfo) SyncEffectiveFieldsDuringRead(existingState CentralCleanRoomInfo)
type CleanRoomAssetInfo ¶
type CleanRoomAssetInfo struct { // Time at which this asset was added, in epoch milliseconds. AddedAt types.Int64 `tfsdk:"added_at" tf:"optional"` // Details about the notebook asset. NotebookInfo []CleanRoomNotebookInfo `tfsdk:"notebook_info" tf:"optional,object"` // The collaborator who owns the asset. Owner []CleanRoomCollaboratorInfo `tfsdk:"owner" tf:"optional,object"` // Details about the table asset. TableInfo []CleanRoomTableInfo `tfsdk:"table_info" tf:"optional,object"` // Time at which this asset was updated, in epoch milliseconds. UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"optional"` }
func (*CleanRoomAssetInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomAssetInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomAssetInfo)
func (*CleanRoomAssetInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomAssetInfo) SyncEffectiveFieldsDuringRead(existingState CleanRoomAssetInfo)
type CleanRoomCatalog ¶
type CleanRoomCatalog struct { // Name of the catalog in the clean room station. Empty for notebooks. CatalogName types.String `tfsdk:"catalog_name" tf:"optional"` // The details of the shared notebook files. NotebookFiles []SharedDataObject `tfsdk:"notebook_files" tf:"optional"` // The details of the shared tables. Tables []SharedDataObject `tfsdk:"tables" tf:"optional"` }
func (*CleanRoomCatalog) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomCatalog) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomCatalog)
func (*CleanRoomCatalog) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomCatalog) SyncEffectiveFieldsDuringRead(existingState CleanRoomCatalog)
type CleanRoomCatalogUpdate ¶
type CleanRoomCatalogUpdate struct { // The name of the catalog to update assets. CatalogName types.String `tfsdk:"catalog_name" tf:"optional"` // The updates to the assets in the catalog. Updates []SharedDataObjectUpdate `tfsdk:"updates" tf:"optional,object"` }
func (*CleanRoomCatalogUpdate) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomCatalogUpdate) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomCatalogUpdate)
func (*CleanRoomCatalogUpdate) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomCatalogUpdate) SyncEffectiveFieldsDuringRead(existingState CleanRoomCatalogUpdate)
type CleanRoomCollaboratorInfo ¶
type CleanRoomCollaboratorInfo struct { // The global Unity Catalog metastore id of the collaborator. Also known as // the sharing identifier. The identifier is of format // __cloud__:__region__:__metastore-uuid__. GlobalMetastoreId types.String `tfsdk:"global_metastore_id" tf:"optional"` // The organization name of the collaborator. This is configured in the // metastore for Delta Sharing and is used to identify the organization to // other collaborators. OrganizationName types.String `tfsdk:"organization_name" tf:"optional"` }
func (*CleanRoomCollaboratorInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomCollaboratorInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomCollaboratorInfo)
func (*CleanRoomCollaboratorInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomCollaboratorInfo) SyncEffectiveFieldsDuringRead(existingState CleanRoomCollaboratorInfo)
type CleanRoomInfo ¶
type CleanRoomInfo struct { // User-provided free-form text description. Comment types.String `tfsdk:"comment" tf:"optional"` // Time at which this clean room was created, in epoch milliseconds. CreatedAt types.Int64 `tfsdk:"created_at" tf:"optional"` // Username of clean room creator. CreatedBy types.String `tfsdk:"created_by" tf:"optional"` // Catalog aliases shared by the current collaborator with asset details. LocalCatalogs []CleanRoomCatalog `tfsdk:"local_catalogs" tf:"optional"` // Name of the clean room. Name types.String `tfsdk:"name" tf:"optional"` // Username of current owner of clean room. Owner types.String `tfsdk:"owner" tf:"optional"` // Central clean room details. RemoteDetailedInfo []CentralCleanRoomInfo `tfsdk:"remote_detailed_info" tf:"optional,object"` // Time at which this clean room was updated, in epoch milliseconds. UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"optional"` // Username of clean room updater. UpdatedBy types.String `tfsdk:"updated_by" tf:"optional"` }
func (*CleanRoomInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomInfo)
func (*CleanRoomInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomInfo) SyncEffectiveFieldsDuringRead(existingState CleanRoomInfo)
type CleanRoomNotebookInfo ¶
type CleanRoomNotebookInfo struct { // The base64 representation of the notebook content in HTML. NotebookContent types.String `tfsdk:"notebook_content" tf:"optional"` // The name of the notebook. NotebookName types.String `tfsdk:"notebook_name" tf:"optional"` }
func (*CleanRoomNotebookInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomNotebookInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomNotebookInfo)
func (*CleanRoomNotebookInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomNotebookInfo) SyncEffectiveFieldsDuringRead(existingState CleanRoomNotebookInfo)
type CleanRoomTableInfo ¶
type CleanRoomTableInfo struct { // Name of parent catalog. CatalogName types.String `tfsdk:"catalog_name" tf:"optional"` // The array of __ColumnInfo__ definitions of the table's columns. Columns []ColumnInfo `tfsdk:"columns" tf:"optional"` // Full name of table, in form of // __catalog_name__.__schema_name__.__table_name__ FullName types.String `tfsdk:"full_name" tf:"optional"` // Name of table, relative to parent schema. Name types.String `tfsdk:"name" tf:"optional"` // Name of parent schema relative to its parent catalog. SchemaName types.String `tfsdk:"schema_name" tf:"optional"` }
func (*CleanRoomTableInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CleanRoomTableInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan CleanRoomTableInfo)
func (*CleanRoomTableInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CleanRoomTableInfo) SyncEffectiveFieldsDuringRead(existingState CleanRoomTableInfo)
type ColumnInfo ¶
type ColumnInfo struct { // User-provided free-form text description. Comment types.String `tfsdk:"comment" tf:"optional"` Mask []ColumnMask `tfsdk:"mask" tf:"optional,object"` // Name of Column. Name types.String `tfsdk:"name" tf:"optional"` // Whether field may be Null (default: true). Nullable types.Bool `tfsdk:"nullable" tf:"optional"` // Partition index for column. PartitionIndex types.Int64 `tfsdk:"partition_index" tf:"optional"` // Ordinal position of column (starting at position 0). Position types.Int64 `tfsdk:"position" tf:"optional"` // Format of IntervalType. TypeIntervalType types.String `tfsdk:"type_interval_type" tf:"optional"` // Full data type specification, JSON-serialized. TypeJson types.String `tfsdk:"type_json" tf:"optional"` // Name of type (INT, STRUCT, MAP, etc.). TypeName types.String `tfsdk:"type_name" tf:"optional"` // Digits of precision; required for DecimalTypes. TypePrecision types.Int64 `tfsdk:"type_precision" tf:"optional"` // Digits to right of decimal; Required for DecimalTypes. TypeScale types.Int64 `tfsdk:"type_scale" tf:"optional"` // Full data type specification as SQL/catalogString text. TypeText types.String `tfsdk:"type_text" tf:"optional"` }
func (*ColumnInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *ColumnInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan ColumnInfo)
func (*ColumnInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *ColumnInfo) SyncEffectiveFieldsDuringRead(existingState ColumnInfo)
type ColumnMask ¶
type ColumnMask struct { // The full name of the column mask SQL UDF. FunctionName types.String `tfsdk:"function_name" tf:"optional"` // The list of additional table columns to be passed as input to the column // mask function. The first arg of the mask function should be of the type // of the column being masked and the types of the rest of the args should // match the types of columns in 'using_column_names'. UsingColumnNames []types.String `tfsdk:"using_column_names" tf:"optional"` }
func (*ColumnMask) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *ColumnMask) SyncEffectiveFieldsDuringCreateOrUpdate(plan ColumnMask)
func (*ColumnMask) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *ColumnMask) SyncEffectiveFieldsDuringRead(existingState ColumnMask)
type CreateCleanRoom ¶
type CreateCleanRoom struct { // User-provided free-form text description. Comment types.String `tfsdk:"comment" tf:"optional"` // Name of the clean room. Name types.String `tfsdk:"name" tf:""` // Central clean room details. RemoteDetailedInfo []CentralCleanRoomInfo `tfsdk:"remote_detailed_info" tf:"object"` }
func (*CreateCleanRoom) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *CreateCleanRoom) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateCleanRoom)
func (*CreateCleanRoom) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *CreateCleanRoom) SyncEffectiveFieldsDuringRead(existingState CreateCleanRoom)
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 { types.String `tfsdk:"comment" tf:"optional"` Name types.String `tfsdk:"name" tf:""` StorageRoot types.String `tfsdk:"storage_root" tf:"optional"` }Comment
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 DeleteCleanRoomRequest ¶
Delete a clean room
func (*DeleteCleanRoomRequest) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *DeleteCleanRoomRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteCleanRoomRequest)
func (*DeleteCleanRoomRequest) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *DeleteCleanRoomRequest) SyncEffectiveFieldsDuringRead(existingState DeleteCleanRoomRequest)
type DeleteProviderRequest ¶
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 ¶
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 ¶
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 GetCleanRoomRequest ¶
type GetCleanRoomRequest struct { // Whether to include remote details (central) on the clean room. IncludeRemoteDetails types.Bool `tfsdk:"-"` // The name of the clean room. Name types.String `tfsdk:"-"` }
Get a clean room
func (*GetCleanRoomRequest) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *GetCleanRoomRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetCleanRoomRequest)
func (*GetCleanRoomRequest) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *GetCleanRoomRequest) SyncEffectiveFieldsDuringRead(existingState GetCleanRoomRequest)
type GetProviderRequest ¶
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 ¶
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 { // 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"` 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 { types.Bool `tfsdk:"-"` Name types.String `tfsdk:"-"` }IncludeSharedData
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 ListCleanRoomsRequest ¶
type ListCleanRoomsRequest struct { // Maximum number of clean rooms to return. If not set, all the clean rooms // are returned (not 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 0, the page length is set to a server configured value // (recommended); - when set to a value less than 0, an invalid parameter // error is returned; MaxResults types.Int64 `tfsdk:"-"` // Opaque pagination token to go to next page based on previous query. PageToken types.String `tfsdk:"-"` }
List clean rooms
func (*ListCleanRoomsRequest) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *ListCleanRoomsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListCleanRoomsRequest)
func (*ListCleanRoomsRequest) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *ListCleanRoomsRequest) SyncEffectiveFieldsDuringRead(existingState ListCleanRoomsRequest)
type ListCleanRoomsResponse ¶
type ListCleanRoomsResponse struct { // An array of clean rooms. Remote details (central) are not included. CleanRooms []CleanRoomInfo `tfsdk:"clean_rooms" tf:"optional"` // 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"` }
func (*ListCleanRoomsResponse) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *ListCleanRoomsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListCleanRoomsResponse)
func (*ListCleanRoomsResponse) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *ListCleanRoomsResponse) SyncEffectiveFieldsDuringRead(existingState ListCleanRoomsResponse)
type ListProviderSharesResponse ¶
type ListProviderSharesResponse struct { // 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"` 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 { // 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 types.String `tfsdk:"-"` 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 { // 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"` 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 (*Partition) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
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 ¶
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"` 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"` 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 { types.String `tfsdk:"comment" tf:"optional"` CreatedAt types.Int64 `tfsdk:"created_at" tf:"computed,optional"` CreatedBy types.String `tfsdk:"created_by" tf:"computed,optional"` Name types.String `tfsdk:"name" tf:"optional"` Objects []SharedDataObject `tfsdk:"object" tf:"optional"` // Username of current owner of share. StorageLocation types.String `tfsdk:"storage_location" tf:"optional"` StorageRoot types.String `tfsdk:"storage_root" tf:"optional"` UpdatedAt types.Int64 `tfsdk:"updated_at" tf:"computed,optional"` UpdatedBy types.String `tfsdk:"updated_by" tf:"computed,optional"` }Comment
func (*ShareInfo) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (*ShareInfo) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
type SharePermissionsRequest ¶
type SharePermissionsRequest struct { // 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:"-"` Name types.String `tfsdk:"-"` 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 { PrivilegeAssignment `tfsdk:"privilege_assignments" tf:"optional"` ShareName types.String `tfsdk:"share_name" tf:"optional"` }PrivilegeAssignments []
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 { // milliseconds. AddedAt types.Int64 `tfsdk:"added_at" tf:"computed,optional"` AddedBy types.String `tfsdk:"added_by" tf:"computed,optional"` // Whether to enable cdf or indicate if cdf is enabled on the shared object. // [Update:OPT] Comment types.String `tfsdk:"comment" tf:"optional"` // 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"` 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**. // // For example, a table's fully qualified name is in the format of // `<catalog>.<schema>.<table>`. Name types.String `tfsdk:"name" tf:""` 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>`. // 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. Status types.String `tfsdk:"status" tf:"computed,optional"` // 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 { types.String `tfsdk:"action" tf:"optional"` DataObject []SharedDataObject `tfsdk:"data_object" tf:"optional,object"` }Action
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 UpdateCleanRoom ¶
type UpdateCleanRoom struct { // Array of shared data object updates. CatalogUpdates []CleanRoomCatalogUpdate `tfsdk:"catalog_updates" tf:"optional"` // User-provided free-form text description. Comment types.String `tfsdk:"comment" tf:"optional"` // The name of the clean room. Name types.String `tfsdk:"-"` // Username of current owner of clean room. Owner types.String `tfsdk:"owner" tf:"optional"` }
func (*UpdateCleanRoom) SyncEffectiveFieldsDuringCreateOrUpdate ¶ added in v1.54.0
func (newState *UpdateCleanRoom) SyncEffectiveFieldsDuringCreateOrUpdate(plan UpdateCleanRoom)
func (*UpdateCleanRoom) SyncEffectiveFieldsDuringRead ¶ added in v1.54.0
func (newState *UpdateCleanRoom) SyncEffectiveFieldsDuringRead(existingState UpdateCleanRoom)
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 { types.String `tfsdk:"comment" tf:"optional"` Name types.String `tfsdk:"-"` NewName types.String `tfsdk:"new_name" tf:"optional"` // Username of current owner of share. StorageRoot types.String `tfsdk:"storage_root" tf:"optional"` Updates []SharedDataObjectUpdate `tfsdk:"updates" tf:"optional"` }Comment
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 { catalog.PermissionsChange `tfsdk:"changes" tf:"optional"` // 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:"-"` Name types.String `tfsdk:"-"` PageToken types.String `tfsdk:"-"` }Changes
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)
Click to show internal directories.
Click to hide internal directories.