files_tf

package
v1.57.0 Latest Latest
Warning

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

 Go to latest Published: Nov 6, 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 AddBlock 

type AddBlock struct {
	// The base64-encoded data to append to the stream. This has a limit of 1
	// MB.
	Data types.String `tfsdk:"data" tf:""`
	// The handle on an open stream.
	Handle types.Int64 `tfsdk:"handle" tf:""`
}

func (*AddBlock) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AddBlock) SyncEffectiveFieldsDuringCreateOrUpdate(plan AddBlock)

func (*AddBlock) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AddBlock) SyncEffectiveFieldsDuringRead(existingState AddBlock)

type AddBlockResponse 

type AddBlockResponse struct {
}

func (*AddBlockResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *AddBlockResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan AddBlockResponse)

func (*AddBlockResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *AddBlockResponse) SyncEffectiveFieldsDuringRead(existingState AddBlockResponse)

type Close 

type Close struct {
	// The handle on an open stream.
	Handle types.Int64 `tfsdk:"handle" tf:""`
}

func (*Close) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Close) SyncEffectiveFieldsDuringCreateOrUpdate(plan Close)

func (*Close) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Close) SyncEffectiveFieldsDuringRead(existingState Close)

type CloseResponse 

type CloseResponse struct {
}

func (*CloseResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CloseResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan CloseResponse)

func (*CloseResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CloseResponse) SyncEffectiveFieldsDuringRead(existingState CloseResponse)

type Create 

type Create struct {
	// The flag that specifies whether to overwrite existing file/files.
	Overwrite types.Bool `tfsdk:"overwrite" tf:"optional"`
	// The path of the new file. The path should be the absolute DBFS path.
	Path types.String `tfsdk:"path" tf:""`
}

func (*Create) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Create) SyncEffectiveFieldsDuringCreateOrUpdate(plan Create)

func (*Create) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Create) SyncEffectiveFieldsDuringRead(existingState Create)

type CreateDirectoryRequest 

type CreateDirectoryRequest struct {
	// The absolute path of a directory.
	DirectoryPath types.String `tfsdk:"-"`
}

Create a directory

func (*CreateDirectoryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateDirectoryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateDirectoryRequest)

func (*CreateDirectoryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateDirectoryRequest) SyncEffectiveFieldsDuringRead(existingState CreateDirectoryRequest)

type CreateDirectoryResponse 

type CreateDirectoryResponse struct {
}

func (*CreateDirectoryResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateDirectoryResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateDirectoryResponse)

func (*CreateDirectoryResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateDirectoryResponse) SyncEffectiveFieldsDuringRead(existingState CreateDirectoryResponse)

type CreateResponse 

type CreateResponse struct {
	// Handle which should subsequently be passed into the AddBlock and Close
	// calls when writing to a file through a stream.
	Handle types.Int64 `tfsdk:"handle" tf:"optional"`
}

func (*CreateResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *CreateResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan CreateResponse)

func (*CreateResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *CreateResponse) SyncEffectiveFieldsDuringRead(existingState CreateResponse)

type Delete 

type Delete struct {
	// The path of the file or directory to delete. The path should be the
	// absolute DBFS path.
	Path types.String `tfsdk:"path" tf:""`
	// Whether or not to recursively delete the directory's contents. Deleting
	// empty directories can be done without providing the recursive flag.
	Recursive types.Bool `tfsdk:"recursive" tf:"optional"`
}

func (*Delete) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Delete) SyncEffectiveFieldsDuringCreateOrUpdate(plan Delete)

func (*Delete) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Delete) SyncEffectiveFieldsDuringRead(existingState Delete)

type DeleteDirectoryRequest 

type DeleteDirectoryRequest struct {
	// The absolute path of a directory.
	DirectoryPath types.String `tfsdk:"-"`
}

Delete a directory

func (*DeleteDirectoryRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteDirectoryRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDirectoryRequest)

func (*DeleteDirectoryRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteDirectoryRequest) SyncEffectiveFieldsDuringRead(existingState DeleteDirectoryRequest)

type DeleteDirectoryResponse 

type DeleteDirectoryResponse struct {
}

func (*DeleteDirectoryResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteDirectoryResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteDirectoryResponse)

func (*DeleteDirectoryResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteDirectoryResponse) SyncEffectiveFieldsDuringRead(existingState DeleteDirectoryResponse)

type DeleteFileRequest 

type DeleteFileRequest struct {
	// The absolute path of the file.
	FilePath types.String `tfsdk:"-"`
}

Delete a file

func (*DeleteFileRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DeleteFileRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DeleteFileRequest)

func (*DeleteFileRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DeleteFileRequest) SyncEffectiveFieldsDuringRead(existingState DeleteFileRequest)

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 DirectoryEntry 

type DirectoryEntry struct {
	// The length of the file in bytes. This field is omitted for directories.
	FileSize types.Int64 `tfsdk:"file_size" tf:"optional"`
	// True if the path is a directory.
	IsDirectory types.Bool `tfsdk:"is_directory" tf:"optional"`
	// Last modification time of given file in milliseconds since unix epoch.
	LastModified types.Int64 `tfsdk:"last_modified" tf:"optional"`
	// The name of the file or directory. This is the last component of the
	// path.
	Name types.String `tfsdk:"name" tf:"optional"`
	// The absolute path of the file or directory.
	Path types.String `tfsdk:"path" tf:"optional"`
}

func (*DirectoryEntry) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DirectoryEntry) SyncEffectiveFieldsDuringCreateOrUpdate(plan DirectoryEntry)

func (*DirectoryEntry) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DirectoryEntry) SyncEffectiveFieldsDuringRead(existingState DirectoryEntry)

type DownloadRequest 

type DownloadRequest struct {
	// The absolute path of the file.
	FilePath types.String `tfsdk:"-"`
}

Download a file

func (*DownloadRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DownloadRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan DownloadRequest)

func (*DownloadRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DownloadRequest) SyncEffectiveFieldsDuringRead(existingState DownloadRequest)

type DownloadResponse 

type DownloadResponse struct {
	ContentLength types.Int64 `tfsdk:"-"`

	ContentType types.String `tfsdk:"-"`

	Contents io.ReadCloser `tfsdk:"-"`

	LastModified types.String `tfsdk:"-"`
}

func (*DownloadResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *DownloadResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan DownloadResponse)

func (*DownloadResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *DownloadResponse) SyncEffectiveFieldsDuringRead(existingState DownloadResponse)

type FileInfo 

type FileInfo struct {
	// The length of the file in bytes. This field is omitted for directories.
	FileSize types.Int64 `tfsdk:"file_size" tf:"optional"`
	// True if the path is a directory.
	IsDir types.Bool `tfsdk:"is_dir" tf:"optional"`
	// Last modification time of given file in milliseconds since epoch.
	ModificationTime types.Int64 `tfsdk:"modification_time" tf:"optional"`
	// The absolute path of the file or directory.
	Path types.String `tfsdk:"path" tf:"optional"`
}

func (*FileInfo) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *FileInfo) SyncEffectiveFieldsDuringCreateOrUpdate(plan FileInfo)

func (*FileInfo) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *FileInfo) SyncEffectiveFieldsDuringRead(existingState FileInfo)

type GetDirectoryMetadataRequest 

type GetDirectoryMetadataRequest struct {
	// The absolute path of a directory.
	DirectoryPath types.String `tfsdk:"-"`
}

Get directory metadata

func (*GetDirectoryMetadataRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetDirectoryMetadataRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetDirectoryMetadataRequest)

func (*GetDirectoryMetadataRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetDirectoryMetadataRequest) SyncEffectiveFieldsDuringRead(existingState GetDirectoryMetadataRequest)

type GetDirectoryMetadataResponse 

type GetDirectoryMetadataResponse struct {
}

func (*GetDirectoryMetadataResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetDirectoryMetadataResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetDirectoryMetadataResponse)

func (*GetDirectoryMetadataResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetDirectoryMetadataResponse) SyncEffectiveFieldsDuringRead(existingState GetDirectoryMetadataResponse)

type GetMetadataRequest 

type GetMetadataRequest struct {
	// The absolute path of the file.
	FilePath types.String `tfsdk:"-"`
}

Get file metadata

func (*GetMetadataRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetMetadataRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetMetadataRequest)

func (*GetMetadataRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetMetadataRequest) SyncEffectiveFieldsDuringRead(existingState GetMetadataRequest)

type GetMetadataResponse 

type GetMetadataResponse struct {
	ContentLength types.Int64 `tfsdk:"-"`

	ContentType types.String `tfsdk:"-"`

	LastModified types.String `tfsdk:"-"`
}

func (*GetMetadataResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetMetadataResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetMetadataResponse)

func (*GetMetadataResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetMetadataResponse) SyncEffectiveFieldsDuringRead(existingState GetMetadataResponse)

type GetStatusRequest 

type GetStatusRequest struct {
	// The path of the file or directory. The path should be the absolute DBFS
	// path.
	Path types.String `tfsdk:"-"`
}

Get the information of a file or directory

func (*GetStatusRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *GetStatusRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan GetStatusRequest)

func (*GetStatusRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *GetStatusRequest) SyncEffectiveFieldsDuringRead(existingState GetStatusRequest)

type ListDbfsRequest 

type ListDbfsRequest struct {
	// The path of the file or directory. The path should be the absolute DBFS
	// path.
	Path types.String `tfsdk:"-"`
}

List directory contents or file details

func (*ListDbfsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListDbfsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListDbfsRequest)

func (*ListDbfsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListDbfsRequest) SyncEffectiveFieldsDuringRead(existingState ListDbfsRequest)

type ListDirectoryContentsRequest 

type ListDirectoryContentsRequest struct {
	// The absolute path of a directory.
	DirectoryPath types.String `tfsdk:"-"`
	// The maximum number of directory entries to return. The response may
	// contain fewer entries. If the response contains a `next_page_token`,
	// there may be more entries, even if fewer than `page_size` entries are in
	// the response.
	//
	// We recommend not to set this value unless you are intentionally listing
	// less than the complete directory contents.
	//
	// If unspecified, at most 1000 directory entries will be returned. The
	// maximum value is 1000. Values above 1000 will be coerced to 1000.
	PageSize types.Int64 `tfsdk:"-"`
	// An opaque page token which was the `next_page_token` in the response of
	// the previous request to list the contents of this directory. Provide this
	// token to retrieve the next page of directory entries. When providing a
	// `page_token`, all other parameters provided to the request must match the
	// previous request. To list all of the entries in a directory, it is
	// necessary to continue requesting pages of entries until the response
	// contains no `next_page_token`. Note that the number of entries returned
	// must not be used to determine when the listing is complete.
	PageToken types.String `tfsdk:"-"`
}

List directory contents

func (*ListDirectoryContentsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListDirectoryContentsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListDirectoryContentsRequest)

func (*ListDirectoryContentsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListDirectoryContentsRequest) SyncEffectiveFieldsDuringRead(existingState ListDirectoryContentsRequest)

type ListDirectoryResponse 

type ListDirectoryResponse struct {
	// Array of DirectoryEntry.
	Contents []DirectoryEntry `tfsdk:"contents" tf:"optional"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	NextPageToken types.String `tfsdk:"next_page_token" tf:"optional"`
}

func (*ListDirectoryResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListDirectoryResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListDirectoryResponse)

func (*ListDirectoryResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListDirectoryResponse) SyncEffectiveFieldsDuringRead(existingState ListDirectoryResponse)

type ListStatusResponse 

type ListStatusResponse struct {
	// A list of FileInfo's that describe contents of directory or file. See
	// example above.
	Files []FileInfo `tfsdk:"files" tf:"optional"`
}

func (*ListStatusResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ListStatusResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ListStatusResponse)

func (*ListStatusResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ListStatusResponse) SyncEffectiveFieldsDuringRead(existingState ListStatusResponse)

type MkDirs 

type MkDirs struct {
	// The path of the new directory. The path should be the absolute DBFS path.
	Path types.String `tfsdk:"path" tf:""`
}

func (*MkDirs) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MkDirs) SyncEffectiveFieldsDuringCreateOrUpdate(plan MkDirs)

func (*MkDirs) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MkDirs) SyncEffectiveFieldsDuringRead(existingState MkDirs)

type MkDirsResponse 

type MkDirsResponse struct {
}

func (*MkDirsResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MkDirsResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan MkDirsResponse)

func (*MkDirsResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MkDirsResponse) SyncEffectiveFieldsDuringRead(existingState MkDirsResponse)

type Move 

type Move struct {
	// The destination path of the file or directory. The path should be the
	// absolute DBFS path.
	DestinationPath types.String `tfsdk:"destination_path" tf:""`
	// The source path of the file or directory. The path should be the absolute
	// DBFS path.
	SourcePath types.String `tfsdk:"source_path" tf:""`
}

func (*Move) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Move) SyncEffectiveFieldsDuringCreateOrUpdate(plan Move)

func (*Move) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Move) SyncEffectiveFieldsDuringRead(existingState Move)

type MoveResponse 

type MoveResponse struct {
}

func (*MoveResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *MoveResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan MoveResponse)

func (*MoveResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *MoveResponse) SyncEffectiveFieldsDuringRead(existingState MoveResponse)

type Put 

type Put struct {
	// This parameter might be absent, and instead a posted file will be used.
	Contents types.String `tfsdk:"contents" tf:"optional"`
	// The flag that specifies whether to overwrite existing file/files.
	Overwrite types.Bool `tfsdk:"overwrite" tf:"optional"`
	// The path of the new file. The path should be the absolute DBFS path.
	Path types.String `tfsdk:"path" tf:""`
}

func (*Put) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *Put) SyncEffectiveFieldsDuringCreateOrUpdate(plan Put)

func (*Put) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *Put) SyncEffectiveFieldsDuringRead(existingState Put)

type PutResponse 

type PutResponse struct {
}

func (*PutResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *PutResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan PutResponse)

func (*PutResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *PutResponse) SyncEffectiveFieldsDuringRead(existingState PutResponse)

type ReadDbfsRequest 

type ReadDbfsRequest struct {
	// The number of bytes to read starting from the offset. This has a limit of
	// 1 MB, and a default value of 0.5 MB.
	Length types.Int64 `tfsdk:"-"`
	// The offset to read from in bytes.
	Offset types.Int64 `tfsdk:"-"`
	// The path of the file to read. The path should be the absolute DBFS path.
	Path types.String `tfsdk:"-"`
}

Get the contents of a file

func (*ReadDbfsRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ReadDbfsRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan ReadDbfsRequest)

func (*ReadDbfsRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ReadDbfsRequest) SyncEffectiveFieldsDuringRead(existingState ReadDbfsRequest)

type ReadResponse 

type ReadResponse struct {
	// The number of bytes read (could be less than “length“ if we hit end of
	// file). This refers to number of bytes read in unencoded version (response
	// data is base64-encoded).
	BytesRead types.Int64 `tfsdk:"bytes_read" tf:"optional"`
	// The base64-encoded contents of the file read.
	Data types.String `tfsdk:"data" tf:"optional"`
}

func (*ReadResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *ReadResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan ReadResponse)

func (*ReadResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *ReadResponse) SyncEffectiveFieldsDuringRead(existingState ReadResponse)

type UploadRequest 

type UploadRequest struct {
	Contents io.ReadCloser `tfsdk:"-"`
	// The absolute path of the file.
	FilePath types.String `tfsdk:"-"`
	// If true, an existing file will be overwritten.
	Overwrite types.Bool `tfsdk:"-"`
}

Upload a file

func (*UploadRequest) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UploadRequest) SyncEffectiveFieldsDuringCreateOrUpdate(plan UploadRequest)

func (*UploadRequest) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UploadRequest) SyncEffectiveFieldsDuringRead(existingState UploadRequest)

type UploadResponse 

type UploadResponse struct {
}

func (*UploadResponse) SyncEffectiveFieldsDuringCreateOrUpdate added in v1.54.0 

func (newState *UploadResponse) SyncEffectiveFieldsDuringCreateOrUpdate(plan UploadResponse)

func (*UploadResponse) SyncEffectiveFieldsDuringRead added in v1.54.0 

func (newState *UploadResponse) SyncEffectiveFieldsDuringRead(existingState UploadResponse)

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.