filesystem

package
v10.1.1-beta.0...-b04438a Latest Latest
Warning

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

 Go to latest Published: Sep 9, 2019 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package filesystem implements the Azure ARM Filesystem service API version 2016-11-01.

Creates an Azure Data Lake Store filesystem client.

Index

Constants

View Source 
const (
	// DefaultAdlsFileSystemDNSSuffix is the default value for adls file system dns suffix
	DefaultAdlsFileSystemDNSSuffix = "azuredatalakestore.net"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

UserAgent returns the UserAgent string to use when sending http.Requests.

func Version 

func Version() string

Version returns the semantic version (see http://semver.org) of the client.

Types

type ACLStatus 

type ACLStatus struct {
	Entries    *[]string `json:"entries,omitempty"`
	Group      *string   `json:"group,omitempty"`
	Owner      *string   `json:"owner,omitempty"`
	Permission *int32    `json:"permission,omitempty"`
	StickyBit  *bool     `json:"stickyBit,omitempty"`
}

ACLStatus is data Lake Store file or directory Access Control List information.

type ACLStatusResult 

type ACLStatusResult struct {
	autorest.Response `json:"-"`
	ACLStatus         *ACLStatus `json:"AclStatus,omitempty"`
}

ACLStatusResult is data Lake Store file or directory Access Control List information.

type AdlsAccessControlException 

type AdlsAccessControlException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsAccessControlException is a WebHDFS exception thrown indicating that access is denied due to insufficient permissions. Thrown when a 403 error response code is returned (forbidden).

type AdlsBadOffsetException 

type AdlsBadOffsetException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsBadOffsetException is a WebHDFS exception thrown indicating the append or read is from a bad offset. Thrown when a 400 error response code is returned for append and open operations (Bad request).

type AdlsError 

type AdlsError struct {
	RemoteException *AdlsRemoteException `json:"RemoteException,omitempty"`
}

AdlsError is data Lake Store filesystem error containing a specific WebHDFS exception.

type AdlsFileAlreadyExistsException 

type AdlsFileAlreadyExistsException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsFileAlreadyExistsException is a WebHDFS exception thrown indicating the file or folder already exists. Thrown when a 403 error response code is returned (forbidden).

type AdlsFileNotFoundException 

type AdlsFileNotFoundException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsFileNotFoundException is a WebHDFS exception thrown indicating the file or folder could not be found. Thrown when a 404 error response code is returned (not found).

type AdlsIOException 

type AdlsIOException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsIOException is a WebHDFS exception thrown indicating there was an IO (read or write) error. Thrown when a 403 error response code is returned (forbidden).

type AdlsIllegalArgumentException 

type AdlsIllegalArgumentException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsIllegalArgumentException is a WebHDFS exception thrown indicating that one more arguments is incorrect. Thrown when a 400 error response code is returned (bad request).

type AdlsRemoteException 

type AdlsRemoteException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsRemoteException is data Lake Store filesystem exception based on the WebHDFS definition for RemoteExceptions. This is a WebHDFS 'catch all' exception

type AdlsRuntimeException 

type AdlsRuntimeException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsRuntimeException is a WebHDFS exception thrown when an unexpected error occurs during an operation. Thrown when a 500 error response code is returned (Internal server error).

type AdlsSecurityException 

type AdlsSecurityException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsSecurityException is a WebHDFS exception thrown indicating that access is denied. Thrown when a 401 error response code is returned (Unauthorized).

type AdlsThrottledException 

type AdlsThrottledException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsThrottledException is a WebHDFS exception thrown indicating that the request is being throttled. Reducing the number of requests or request size helps to mitigate this error.

type AdlsUnsupportedOperationException 

type AdlsUnsupportedOperationException struct {
	JavaClassName *string `json:"javaClassName,omitempty"`
	Message       *string `json:"message,omitempty"`
}

AdlsUnsupportedOperationException is a WebHDFS exception thrown indicating that the requested operation is not supported. Thrown when a 400 error response code is returned (bad request).

type AppendModeType 

type AppendModeType string

AppendModeType enumerates the values for append mode type. 

const (
	// Autocreate specifies the autocreate state for append mode type.
	Autocreate AppendModeType = "autocreate"
)

type ContentSummary 

type ContentSummary struct {
	DirectoryCount *int64 `json:"directoryCount,omitempty"`
	FileCount      *int64 `json:"fileCount,omitempty"`
	Length         *int64 `json:"length,omitempty"`
	SpaceConsumed  *int64 `json:"spaceConsumed,omitempty"`
}

ContentSummary is data Lake Store content summary information

type ContentSummaryResult 

type ContentSummaryResult struct {
	autorest.Response `json:"-"`
	ContentSummary    *ContentSummary `json:"ContentSummary,omitempty"`
}

ContentSummaryResult is data Lake Store filesystem content summary information response.

type ExpiryOptionType 

type ExpiryOptionType string

ExpiryOptionType enumerates the values for expiry option type. 

const (
	// Absolute specifies the absolute state for expiry option type.
	Absolute ExpiryOptionType = "Absolute"
	// NeverExpire specifies the never expire state for expiry option type.
	NeverExpire ExpiryOptionType = "NeverExpire"
	// RelativeToCreationDate specifies the relative to creation date state for
	// expiry option type.
	RelativeToCreationDate ExpiryOptionType = "RelativeToCreationDate"
	// RelativeToNow specifies the relative to now state for expiry option
	// type.
	RelativeToNow ExpiryOptionType = "RelativeToNow"
)

type FileOperationResult 

type FileOperationResult struct {
	autorest.Response `json:"-"`
	OperationResult   *bool `json:"boolean,omitempty"`
}

FileOperationResult is the result of the request or operation.

type FileStatusProperties 

type FileStatusProperties struct {
	AccessTime       *int64   `json:"accessTime,omitempty"`
	BlockSize        *int64   `json:"blockSize,omitempty"`
	ChildrenNum      *int64   `json:"childrenNum,omitempty"`
	ExpirationTime   *int64   `json:"msExpirationTime,omitempty"`
	Group            *string  `json:"group,omitempty"`
	Length           *int64   `json:"length,omitempty"`
	ModificationTime *int64   `json:"modificationTime,omitempty"`
	Owner            *string  `json:"owner,omitempty"`
	PathSuffix       *string  `json:"pathSuffix,omitempty"`
	Permission       *string  `json:"permission,omitempty"`
	Type             FileType `json:"type,omitempty"`
	ACLBit           *bool    `json:"aclBit,omitempty"`
}

FileStatusProperties is data Lake Store file or directory information.

type FileStatusResult 

type FileStatusResult struct {
	autorest.Response `json:"-"`
	FileStatus        *FileStatusProperties `json:"FileStatus,omitempty"`
}

FileStatusResult is data Lake Store filesystem file status information response.

type FileStatuses 

type FileStatuses struct {
	FileStatus *[]FileStatusProperties `json:"FileStatus,omitempty"`
}

FileStatuses is data Lake Store file status list information.

type FileStatusesResult 

type FileStatusesResult struct {
	autorest.Response `json:"-"`
	FileStatuses      *FileStatuses `json:"FileStatuses,omitempty"`
}

FileStatusesResult is data Lake Store filesystem file status list information response.

type FileType 

type FileType string

FileType enumerates the values for file type. 

const (
	// DIRECTORY specifies the directory state for file type.
	DIRECTORY FileType = "DIRECTORY"
	// FILE specifies the file state for file type.
	FILE FileType = "FILE"
)

type GroupClient 

type GroupClient struct {
	ManagementClient
}

GroupClient is the creates an Azure Data Lake Store filesystem client.

func NewGroupClient 

func NewGroupClient() GroupClient

NewGroupClient creates an instance of the GroupClient client.

func (GroupClient) Append 

func (client GroupClient) Append(accountName string, directFilePath string, streamContents io.ReadCloser, op string, appendParameter string, offset *int64, syncFlag SyncFlag, leaseID *uuid.UUID, fileSessionID *uuid.UUID) (result autorest.Response, err error)

Append used for serial appends to the specified file. NOTE: The target must not contain data added by ConcurrentAppend. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file.

accountName is the Azure Data Lake Store account to execute filesystem operations on. directFilePath is the Data Lake Store path (starting with '/') of the file to which to append. streamContents is the file contents to include when appending to the file. streamContents will be closed upon successful return. Callers should ensure closure when receiving an error.op is the constant value for the operation. appendParameter is flag to skip redirection. When append=false or not specified, the request is redirected. Submit another HTTP PUT request using the URL in the Location header with the file data to be written. When append=true, this redirection is skipped. offset is the optional offset in the stream to begin the append operation. Default is to append at the end of the stream. syncFlag is optionally indicates what to do after completion of the append. DATA indicates more data is coming so no sync takes place, METADATA indicates a sync should be done to refresh metadata of the file only. CLOSE indicates that both the stream and metadata should be refreshed upon append completion. leaseID is optional unique GUID per file to ensure single writer semantics, meaning that only clients that append to the file with the same leaseId will be allowed to do so. fileSessionID is optional unique GUID per file indicating all the appends with the same fileSessionId are from the same client and same session. This will give a performance benefit when syncFlag is DATA or METADATA.

func (GroupClient) AppendPreparer 

func (client GroupClient) AppendPreparer(accountName string, directFilePath string, streamContents io.ReadCloser, op string, appendParameter string, offset *int64, syncFlag SyncFlag, leaseID *uuid.UUID, fileSessionID *uuid.UUID) (*http.Request, error)

AppendPreparer prepares the Append request.

func (GroupClient) AppendResponder 

func (client GroupClient) AppendResponder(resp *http.Response) (result autorest.Response, err error)

AppendResponder handles the response to the Append request. The method always closes the http.Response Body.

func (GroupClient) AppendSender 

func (client GroupClient) AppendSender(req *http.Request) (*http.Response, error)

AppendSender sends the Append request. The method will close the http.Response Body if it receives an error.

func (GroupClient) CheckAccess 

func (client GroupClient) CheckAccess(accountName string, pathParameter string, fsaction string, op string) (result autorest.Response, err error)

CheckAccess checks if the specified access is available at the given path.

accountName is the Azure Data Lake Store account to execute filesystem operations on. pathParameter is the Data Lake Store path (starting with '/') of the file or directory for which to check access. fsaction is file system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}' op is the constant value for the operation.

func (GroupClient) CheckAccessPreparer 

func (client GroupClient) CheckAccessPreparer(accountName string, pathParameter string, fsaction string, op string) (*http.Request, error)

CheckAccessPreparer prepares the CheckAccess request.

func (GroupClient) CheckAccessResponder 

func (client GroupClient) CheckAccessResponder(resp *http.Response) (result autorest.Response, err error)

CheckAccessResponder handles the response to the CheckAccess request. The method always closes the http.Response Body.

func (GroupClient) CheckAccessSender 

func (client GroupClient) CheckAccessSender(req *http.Request) (*http.Response, error)

CheckAccessSender sends the CheckAccess request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Concat 

func (client GroupClient) Concat(accountName string, destinationPath string, sources []string, op string) (result autorest.Response, err error)

Concat concatenates the list of source files into the destination file, removing all source files upon success.

accountName is the Azure Data Lake Store account to execute filesystem operations on. destinationPath is the Data Lake Store path (starting with '/') of the destination file resulting from the concatenation. sources is a list of comma separated Data Lake Store paths (starting with '/') of the files to concatenate, in the order in which they should be concatenated. op is the constant value for the operation.

func (GroupClient) ConcatPreparer 

func (client GroupClient) ConcatPreparer(accountName string, destinationPath string, sources []string, op string) (*http.Request, error)

ConcatPreparer prepares the Concat request.

func (GroupClient) ConcatResponder 

func (client GroupClient) ConcatResponder(resp *http.Response) (result autorest.Response, err error)

ConcatResponder handles the response to the Concat request. The method always closes the http.Response Body.

func (GroupClient) ConcatSender 

func (client GroupClient) ConcatSender(req *http.Request) (*http.Response, error)

ConcatSender sends the Concat request. The method will close the http.Response Body if it receives an error.

func (GroupClient) ConcurrentAppend 

func (client GroupClient) ConcurrentAppend(accountName string, filePath string, streamContents io.ReadCloser, op string, transferEncoding string, appendMode AppendModeType, syncFlag SyncFlag) (result autorest.Response, err error)

ConcurrentAppend appends to the specified file, optionally first creating the file if it does not yet exist. This method supports multiple concurrent appends to the file. NOTE: The target must not contain data added by Create or normal (serial) Append. ConcurrentAppend and Append cannot be used interchangeably; once a target file has been modified using either of these append options, the other append option cannot be used on the target file. ConcurrentAppend does not guarantee order and can result in duplicated data landing in the target file.

accountName is the Azure Data Lake Store account to execute filesystem operations on. filePath is the Data Lake Store path (starting with '/') of the file to which to append using concurrent append. streamContents is the file contents to include when appending to the file. streamContents will be closed upon successful return. Callers should ensure closure when receiving an error.op is the constant value for the operation. transferEncoding is indicates the data being sent to the server is being streamed in chunks. appendMode is indicates the concurrent append call should create the file if it doesn't exist or just open the existing file for append syncFlag is optionally indicates what to do after completion of the concurrent append. DATA indicates more data is coming so no sync takes place, METADATA indicates a sync should be done to refresh metadata of the file only. CLOSE indicates that both the stream and metadata should be refreshed upon append completion.

func (GroupClient) ConcurrentAppendPreparer 

func (client GroupClient) ConcurrentAppendPreparer(accountName string, filePath string, streamContents io.ReadCloser, op string, transferEncoding string, appendMode AppendModeType, syncFlag SyncFlag) (*http.Request, error)

ConcurrentAppendPreparer prepares the ConcurrentAppend request.

func (GroupClient) ConcurrentAppendResponder 

func (client GroupClient) ConcurrentAppendResponder(resp *http.Response) (result autorest.Response, err error)

ConcurrentAppendResponder handles the response to the ConcurrentAppend request. The method always closes the http.Response Body.

func (GroupClient) ConcurrentAppendSender 

func (client GroupClient) ConcurrentAppendSender(req *http.Request) (*http.Response, error)

ConcurrentAppendSender sends the ConcurrentAppend request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Create 

func (client GroupClient) Create(accountName string, directFilePath string, op string, write string, streamContents io.ReadCloser, overwrite *bool, syncFlag SyncFlag, leaseID *uuid.UUID, permission *int32) (result autorest.Response, err error)

Create creates a file with optionally specified content. NOTE: If content is provided, the resulting file cannot be modified using ConcurrentAppend.

accountName is the Azure Data Lake Store account to execute filesystem operations on. directFilePath is the Data Lake Store path (starting with '/') of the file to create. op is the constant value for the operation. write is flag to skip redirection. When write=false or not specified, the request is redirected. Submit another HTTP PUT request using the URL in the Location header with the file data to be written. When write=true, this redirection is skipped. streamContents is the file contents to include when creating the file. This parameter is optional, resulting in an empty file if not specified. streamContents will be closed upon successful return. Callers should ensure closure when receiving an error.overwrite is the indication of if the file should be overwritten. syncFlag is optionally indicates what to do after completion of the append. DATA indicates more data is coming so no sync takes place, METADATA indicates a sync should be done to refresh metadata of the file only. CLOSE indicates that both the stream and metadata should be refreshed upon create completion. leaseID is optional unique GUID per file to ensure single writer semantics, meaning that only clients that append to the file with the same leaseId will be allowed to do so. permission is the octal representation of the unnamed user, mask and other permissions that should be set for the file when created. If not specified, it inherits these from the container.

func (GroupClient) CreatePreparer 

func (client GroupClient) CreatePreparer(accountName string, directFilePath string, op string, write string, streamContents io.ReadCloser, overwrite *bool, syncFlag SyncFlag, leaseID *uuid.UUID, permission *int32) (*http.Request, error)

CreatePreparer prepares the Create request.

func (GroupClient) CreateResponder 

func (client GroupClient) CreateResponder(resp *http.Response) (result autorest.Response, err error)

CreateResponder handles the response to the Create request. The method always closes the http.Response Body.

func (GroupClient) CreateSender 

func (client GroupClient) CreateSender(req *http.Request) (*http.Response, error)

CreateSender sends the Create request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Delete 

func (client GroupClient) Delete(accountName string, filePath string, op string, recursive *bool) (result FileOperationResult, err error)

Delete deletes the requested file or directory, optionally recursively.

accountName is the Azure Data Lake Store account to execute filesystem operations on. filePath is the Data Lake Store path (starting with '/') of the file or directory to delete. op is the constant value for the operation. recursive is the optional switch indicating if the delete should be recursive

func (GroupClient) DeletePreparer 

func (client GroupClient) DeletePreparer(accountName string, filePath string, op string, recursive *bool) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (GroupClient) DeleteResponder 

func (client GroupClient) DeleteResponder(resp *http.Response) (result FileOperationResult, err error)

DeleteResponder handles the response to the Delete request. The method always closes the http.Response Body.

func (GroupClient) DeleteSender 

func (client GroupClient) DeleteSender(req *http.Request) (*http.Response, error)

DeleteSender sends the Delete request. The method will close the http.Response Body if it receives an error.

func (GroupClient) GetACLStatus 

func (client GroupClient) GetACLStatus(accountName string, ACLFilePath string, op string, tooID *bool) (result ACLStatusResult, err error)

GetACLStatus gets Access Control List (ACL) entries for the specified file or directory.

accountName is the Azure Data Lake Store account to execute filesystem operations on. ACLFilePath is the Data Lake Store path (starting with '/') of the file or directory for which to get the ACL. op is the constant value for the operation. tooID is an optional switch to return friendly names in place of object ID for ACL entries. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs.

func (GroupClient) GetACLStatusPreparer 

func (client GroupClient) GetACLStatusPreparer(accountName string, ACLFilePath string, op string, tooID *bool) (*http.Request, error)

GetACLStatusPreparer prepares the GetACLStatus request.

func (GroupClient) GetACLStatusResponder 

func (client GroupClient) GetACLStatusResponder(resp *http.Response) (result ACLStatusResult, err error)

GetACLStatusResponder handles the response to the GetACLStatus request. The method always closes the http.Response Body.

func (GroupClient) GetACLStatusSender 

func (client GroupClient) GetACLStatusSender(req *http.Request) (*http.Response, error)

GetACLStatusSender sends the GetACLStatus request. The method will close the http.Response Body if it receives an error.

func (GroupClient) GetContentSummary 

func (client GroupClient) GetContentSummary(accountName string, getContentSummaryFilePath string, op string) (result ContentSummaryResult, err error)

GetContentSummary gets the file content summary object specified by the file path.

accountName is the Azure Data Lake Store account to execute filesystem operations on. getContentSummaryFilePath is the Data Lake Store path (starting with '/') of the file for which to retrieve the summary. op is the constant value for the operation.

func (GroupClient) GetContentSummaryPreparer 

func (client GroupClient) GetContentSummaryPreparer(accountName string, getContentSummaryFilePath string, op string) (*http.Request, error)

GetContentSummaryPreparer prepares the GetContentSummary request.

func (GroupClient) GetContentSummaryResponder 

func (client GroupClient) GetContentSummaryResponder(resp *http.Response) (result ContentSummaryResult, err error)

GetContentSummaryResponder handles the response to the GetContentSummary request. The method always closes the http.Response Body.

func (GroupClient) GetContentSummarySender 

func (client GroupClient) GetContentSummarySender(req *http.Request) (*http.Response, error)

GetContentSummarySender sends the GetContentSummary request. The method will close the http.Response Body if it receives an error.

func (GroupClient) GetFileStatus 

func (client GroupClient) GetFileStatus(accountName string, getFilePath string, op string, tooID *bool) (result FileStatusResult, err error)

GetFileStatus get the file status object specified by the file path.

accountName is the Azure Data Lake Store account to execute filesystem operations on. getFilePath is the Data Lake Store path (starting with '/') of the file or directory for which to retrieve the status. op is the constant value for the operation. tooID is an optional switch to return friendly names in place of owner and group. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs.

func (GroupClient) GetFileStatusPreparer 

func (client GroupClient) GetFileStatusPreparer(accountName string, getFilePath string, op string, tooID *bool) (*http.Request, error)

GetFileStatusPreparer prepares the GetFileStatus request.

func (GroupClient) GetFileStatusResponder 

func (client GroupClient) GetFileStatusResponder(resp *http.Response) (result FileStatusResult, err error)

GetFileStatusResponder handles the response to the GetFileStatus request. The method always closes the http.Response Body.

func (GroupClient) GetFileStatusSender 

func (client GroupClient) GetFileStatusSender(req *http.Request) (*http.Response, error)

GetFileStatusSender sends the GetFileStatus request. The method will close the http.Response Body if it receives an error.

func (GroupClient) ListFileStatus 

func (client GroupClient) ListFileStatus(accountName string, listFilePath string, op string, listSize *int32, listAfter string, listBefore string, tooID *bool) (result FileStatusesResult, err error)

ListFileStatus get the list of file status objects specified by the file path, with optional pagination parameters

accountName is the Azure Data Lake Store account to execute filesystem operations on. listFilePath is the Data Lake Store path (starting with '/') of the directory to list. op is the constant value for the operation. listSize is gets or sets the number of items to return. Optional. listAfter is gets or sets the item or lexographical index after which to begin returning results. For example, a file list of 'a','b','d' and listAfter='b' will return 'd', and a listAfter='c' will also return 'd'. Optional. listBefore is gets or sets the item or lexographical index before which to begin returning results. For example, a file list of 'a','b','d' and listBefore='d' will return 'a','b', and a listBefore='c' will also return 'a','b'. Optional. tooID is an optional switch to return friendly names in place of owner and group. tooid=false returns friendly names instead of the AAD Object ID. Default value is true, returning AAD object IDs.

func (GroupClient) ListFileStatusPreparer 

func (client GroupClient) ListFileStatusPreparer(accountName string, listFilePath string, op string, listSize *int32, listAfter string, listBefore string, tooID *bool) (*http.Request, error)

ListFileStatusPreparer prepares the ListFileStatus request.

func (GroupClient) ListFileStatusResponder 

func (client GroupClient) ListFileStatusResponder(resp *http.Response) (result FileStatusesResult, err error)

ListFileStatusResponder handles the response to the ListFileStatus request. The method always closes the http.Response Body.

func (GroupClient) ListFileStatusSender 

func (client GroupClient) ListFileStatusSender(req *http.Request) (*http.Response, error)

ListFileStatusSender sends the ListFileStatus request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Mkdirs 

func (client GroupClient) Mkdirs(accountName string, pathParameter string, op string, permission *int32) (result FileOperationResult, err error)

Mkdirs creates a directory.

accountName is the Azure Data Lake Store account to execute filesystem operations on. pathParameter is the Data Lake Store path (starting with '/') of the directory to create. op is the constant value for the operation. permission is optional octal permission with which the directory should be created.

func (GroupClient) MkdirsPreparer 

func (client GroupClient) MkdirsPreparer(accountName string, pathParameter string, op string, permission *int32) (*http.Request, error)

MkdirsPreparer prepares the Mkdirs request.

func (GroupClient) MkdirsResponder 

func (client GroupClient) MkdirsResponder(resp *http.Response) (result FileOperationResult, err error)

MkdirsResponder handles the response to the Mkdirs request. The method always closes the http.Response Body.

func (GroupClient) MkdirsSender 

func (client GroupClient) MkdirsSender(req *http.Request) (*http.Response, error)

MkdirsSender sends the Mkdirs request. The method will close the http.Response Body if it receives an error.

func (GroupClient) ModifyACLEntries 

func (client GroupClient) ModifyACLEntries(accountName string, modifyACLFilePath string, aclspec string, op string) (result autorest.Response, err error)

ModifyACLEntries modifies existing Access Control List (ACL) entries on a file or folder.

accountName is the Azure Data Lake Store account to execute filesystem operations on. modifyACLFilePath is the Data Lake Store path (starting with '/') of the file or directory with the ACL being modified. aclspec is the ACL specification included in ACL modification operations in the format '[default:]user|group|other::r|-w|-x|-' op is the constant value for the operation.

func (GroupClient) ModifyACLEntriesPreparer 

func (client GroupClient) ModifyACLEntriesPreparer(accountName string, modifyACLFilePath string, aclspec string, op string) (*http.Request, error)

ModifyACLEntriesPreparer prepares the ModifyACLEntries request.

func (GroupClient) ModifyACLEntriesResponder 

func (client GroupClient) ModifyACLEntriesResponder(resp *http.Response) (result autorest.Response, err error)

ModifyACLEntriesResponder handles the response to the ModifyACLEntries request. The method always closes the http.Response Body.

func (GroupClient) ModifyACLEntriesSender 

func (client GroupClient) ModifyACLEntriesSender(req *http.Request) (*http.Response, error)

ModifyACLEntriesSender sends the ModifyACLEntries request. The method will close the http.Response Body if it receives an error.

func (GroupClient) MsConcat 

func (client GroupClient) MsConcat(accountName string, msConcatDestinationPath string, streamContents io.ReadCloser, op string, deleteSourceDirectory *bool) (result autorest.Response, err error)

MsConcat concatenates the list of source files into the destination file, deleting all source files upon success. This method accepts more source file paths than the Concat method. This method and the parameters it accepts are subject to change for usability in an upcoming version.

accountName is the Azure Data Lake Store account to execute filesystem operations on. msConcatDestinationPath is the Data Lake Store path (starting with '/') of the destination file resulting from the concatenation. streamContents is a list of Data Lake Store paths (starting with '/') of the source files. Must be a comma-separated path list in the format: sources=/file/path/1.txt,/file/path/2.txt,/file/path/lastfile.csv streamContents will be closed upon successful return. Callers should ensure closure when receiving an error.op is the constant value for the operation. deleteSourceDirectory is indicates that as an optimization instead of deleting each individual source stream, delete the source stream folder if all streams are in the same folder instead. This results in a substantial performance improvement when the only streams in the folder are part of the concatenation operation. WARNING: This includes the deletion of any other files that are not source files. Only set this to true when source files are the only files in the source directory.

func (GroupClient) MsConcatPreparer 

func (client GroupClient) MsConcatPreparer(accountName string, msConcatDestinationPath string, streamContents io.ReadCloser, op string, deleteSourceDirectory *bool) (*http.Request, error)

MsConcatPreparer prepares the MsConcat request.

func (GroupClient) MsConcatResponder 

func (client GroupClient) MsConcatResponder(resp *http.Response) (result autorest.Response, err error)

MsConcatResponder handles the response to the MsConcat request. The method always closes the http.Response Body.

func (GroupClient) MsConcatSender 

func (client GroupClient) MsConcatSender(req *http.Request) (*http.Response, error)

MsConcatSender sends the MsConcat request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Open 

func (client GroupClient) Open(accountName string, directFilePath string, op string, read string, length *int64, offset *int64, fileSessionID *uuid.UUID) (result ReadCloser, err error)

Open opens and reads from the specified file.

accountName is the Azure Data Lake Store account to execute filesystem operations on. directFilePath is the Data Lake Store path (starting with '/') of the file to open. op is the constant value for the operation. read is flag to skip redirection. When read=false or not specified, the request is redirected. Submit another HTTP PUT request using the URL in the Location header with the file data to be read. When read=true, this redirection is skipped. length is the number of bytes that the server will attempt to retrieve. It will retrieve <= length bytes. offset is the byte offset to start reading data from. fileSessionID is optional unique GUID per file indicating all the reads with the same fileSessionId are from the same client and same session. This will give a performance benefit.

func (GroupClient) OpenPreparer 

func (client GroupClient) OpenPreparer(accountName string, directFilePath string, op string, read string, length *int64, offset *int64, fileSessionID *uuid.UUID) (*http.Request, error)

OpenPreparer prepares the Open request.

func (GroupClient) OpenResponder 

func (client GroupClient) OpenResponder(resp *http.Response) (result ReadCloser, err error)

OpenResponder handles the response to the Open request. The method always closes the http.Response Body.

func (GroupClient) OpenSender 

func (client GroupClient) OpenSender(req *http.Request) (*http.Response, error)

OpenSender sends the Open request. The method will close the http.Response Body if it receives an error.

func (GroupClient) RemoveACL 

func (client GroupClient) RemoveACL(accountName string, ACLFilePath string, op string) (result autorest.Response, err error)

RemoveACL removes the existing Access Control List (ACL) of the specified file or directory.

accountName is the Azure Data Lake Store account to execute filesystem operations on. ACLFilePath is the Data Lake Store path (starting with '/') of the file or directory with the ACL being removed. op is the constant value for the operation.

func (GroupClient) RemoveACLEntries 

func (client GroupClient) RemoveACLEntries(accountName string, removeACLFilePath string, aclspec string, op string) (result autorest.Response, err error)

RemoveACLEntries removes existing Access Control List (ACL) entries for a file or folder.

accountName is the Azure Data Lake Store account to execute filesystem operations on. removeACLFilePath is the Data Lake Store path (starting with '/') of the file or directory with the ACL being removed. aclspec is the ACL spec included in ACL removal operations in the format '[default:]user|group|other' op is the constant value for the operation.

func (GroupClient) RemoveACLEntriesPreparer 

func (client GroupClient) RemoveACLEntriesPreparer(accountName string, removeACLFilePath string, aclspec string, op string) (*http.Request, error)

RemoveACLEntriesPreparer prepares the RemoveACLEntries request.

func (GroupClient) RemoveACLEntriesResponder 

func (client GroupClient) RemoveACLEntriesResponder(resp *http.Response) (result autorest.Response, err error)

RemoveACLEntriesResponder handles the response to the RemoveACLEntries request. The method always closes the http.Response Body.

func (GroupClient) RemoveACLEntriesSender 

func (client GroupClient) RemoveACLEntriesSender(req *http.Request) (*http.Response, error)

RemoveACLEntriesSender sends the RemoveACLEntries request. The method will close the http.Response Body if it receives an error.

func (GroupClient) RemoveACLPreparer 

func (client GroupClient) RemoveACLPreparer(accountName string, ACLFilePath string, op string) (*http.Request, error)

RemoveACLPreparer prepares the RemoveACL request.

func (GroupClient) RemoveACLResponder 

func (client GroupClient) RemoveACLResponder(resp *http.Response) (result autorest.Response, err error)

RemoveACLResponder handles the response to the RemoveACL request. The method always closes the http.Response Body.

func (GroupClient) RemoveACLSender 

func (client GroupClient) RemoveACLSender(req *http.Request) (*http.Response, error)

RemoveACLSender sends the RemoveACL request. The method will close the http.Response Body if it receives an error.

func (GroupClient) RemoveDefaultACL 

func (client GroupClient) RemoveDefaultACL(accountName string, defaultACLFilePath string, op string) (result autorest.Response, err error)

RemoveDefaultACL removes the existing Default Access Control List (ACL) of the specified directory.

accountName is the Azure Data Lake Store account to execute filesystem operations on. defaultACLFilePath is the Data Lake Store path (starting with '/') of the directory with the default ACL being removed. op is the constant value for the operation.

func (GroupClient) RemoveDefaultACLPreparer 

func (client GroupClient) RemoveDefaultACLPreparer(accountName string, defaultACLFilePath string, op string) (*http.Request, error)

RemoveDefaultACLPreparer prepares the RemoveDefaultACL request.

func (GroupClient) RemoveDefaultACLResponder 

func (client GroupClient) RemoveDefaultACLResponder(resp *http.Response) (result autorest.Response, err error)

RemoveDefaultACLResponder handles the response to the RemoveDefaultACL request. The method always closes the http.Response Body.

func (GroupClient) RemoveDefaultACLSender 

func (client GroupClient) RemoveDefaultACLSender(req *http.Request) (*http.Response, error)

RemoveDefaultACLSender sends the RemoveDefaultACL request. The method will close the http.Response Body if it receives an error.

func (GroupClient) Rename 

func (client GroupClient) Rename(accountName string, renameFilePath string, destination string, op string) (result FileOperationResult, err error)

Rename rename a file or directory.

accountName is the Azure Data Lake Store account to execute filesystem operations on. renameFilePath is the Data Lake Store path (starting with '/') of the file or directory to move/rename. destination is the path to move/rename the file or folder to op is the constant value for the operation.

func (GroupClient) RenamePreparer 

func (client GroupClient) RenamePreparer(accountName string, renameFilePath string, destination string, op string) (*http.Request, error)

RenamePreparer prepares the Rename request.

func (GroupClient) RenameResponder 

func (client GroupClient) RenameResponder(resp *http.Response) (result FileOperationResult, err error)

RenameResponder handles the response to the Rename request. The method always closes the http.Response Body.

func (GroupClient) RenameSender 

func (client GroupClient) RenameSender(req *http.Request) (*http.Response, error)

RenameSender sends the Rename request. The method will close the http.Response Body if it receives an error.

func (GroupClient) SetACL 

func (client GroupClient) SetACL(accountName string, setACLFilePath string, aclspec string, op string) (result autorest.Response, err error)

SetACL sets the Access Control List (ACL) for a file or folder.

accountName is the Azure Data Lake Store account to execute filesystem operations on. setACLFilePath is the Data Lake Store path (starting with '/') of the file or directory on which to set the ACL. aclspec is the ACL spec included in ACL creation operations in the format '[default:]user|group|other::r|-w|-x|-' op is the constant value for the operation.

func (GroupClient) SetACLPreparer 

func (client GroupClient) SetACLPreparer(accountName string, setACLFilePath string, aclspec string, op string) (*http.Request, error)

SetACLPreparer prepares the SetACL request.

func (GroupClient) SetACLResponder 

func (client GroupClient) SetACLResponder(resp *http.Response) (result autorest.Response, err error)

SetACLResponder handles the response to the SetACL request. The method always closes the http.Response Body.

func (GroupClient) SetACLSender 

func (client GroupClient) SetACLSender(req *http.Request) (*http.Response, error)

SetACLSender sends the SetACL request. The method will close the http.Response Body if it receives an error.

func (GroupClient) SetFileExpiry 

func (client GroupClient) SetFileExpiry(accountName string, filePath string, expiryOption ExpiryOptionType, op string, expireTime *int64) (result autorest.Response, err error)

SetFileExpiry sets or removes the expiration time on the specified file. This operation can only be executed against files. Folders are not supported.

accountName is the Azure Data Lake Store account to execute filesystem operations on. filePath is the Data Lake Store path (starting with '/') of the file on which to set or remove the expiration time. expiryOption is indicates the type of expiration to use for the file: 1. NeverExpire: ExpireTime is ignored. 2. RelativeToNow: ExpireTime is an integer in milliseconds representing the expiration date relative to when file expiration is updated. 3. RelativeToCreationDate: ExpireTime is an integer in milliseconds representing the expiration date relative to file creation. 4. Absolute: ExpireTime is an integer in milliseconds, as a Unix timestamp relative to 1/1/1970 00:00:00. op is the constant value for the operation. expireTime is the time that the file will expire, corresponding to the ExpiryOption that was set.

func (GroupClient) SetFileExpiryPreparer 

func (client GroupClient) SetFileExpiryPreparer(accountName string, filePath string, expiryOption ExpiryOptionType, op string, expireTime *int64) (*http.Request, error)

SetFileExpiryPreparer prepares the SetFileExpiry request.

func (GroupClient) SetFileExpiryResponder 

func (client GroupClient) SetFileExpiryResponder(resp *http.Response) (result autorest.Response, err error)

SetFileExpiryResponder handles the response to the SetFileExpiry request. The method always closes the http.Response Body.

func (GroupClient) SetFileExpirySender 

func (client GroupClient) SetFileExpirySender(req *http.Request) (*http.Response, error)

SetFileExpirySender sends the SetFileExpiry request. The method will close the http.Response Body if it receives an error.

func (GroupClient) SetOwner 

func (client GroupClient) SetOwner(accountName string, setOwnerFilePath string, op string, owner string, group string) (result autorest.Response, err error)

SetOwner sets the owner of a file or directory.

accountName is the Azure Data Lake Store account to execute filesystem operations on. setOwnerFilePath is the Data Lake Store path (starting with '/') of the file or directory for which to set the owner. op is the constant value for the operation. owner is the AAD Object ID of the user owner of the file or directory. If empty, the property will remain unchanged. group is the AAD Object ID of the group owner of the file or directory. If empty, the property will remain unchanged.

func (GroupClient) SetOwnerPreparer 

func (client GroupClient) SetOwnerPreparer(accountName string, setOwnerFilePath string, op string, owner string, group string) (*http.Request, error)

SetOwnerPreparer prepares the SetOwner request.

func (GroupClient) SetOwnerResponder 

func (client GroupClient) SetOwnerResponder(resp *http.Response) (result autorest.Response, err error)

SetOwnerResponder handles the response to the SetOwner request. The method always closes the http.Response Body.

func (GroupClient) SetOwnerSender 

func (client GroupClient) SetOwnerSender(req *http.Request) (*http.Response, error)

SetOwnerSender sends the SetOwner request. The method will close the http.Response Body if it receives an error.

func (GroupClient) SetPermission 

func (client GroupClient) SetPermission(accountName string, setPermissionFilePath string, op string, permission string) (result autorest.Response, err error)

SetPermission sets the permission of the file or folder.

accountName is the Azure Data Lake Store account to execute filesystem operations on. setPermissionFilePath is the Data Lake Store path (starting with '/') of the file or directory for which to set the permission. op is the constant value for the operation. permission is a string representation of the permission (i.e 'rwx'). If empty, this property remains unchanged.

func (GroupClient) SetPermissionPreparer 

func (client GroupClient) SetPermissionPreparer(accountName string, setPermissionFilePath string, op string, permission string) (*http.Request, error)

SetPermissionPreparer prepares the SetPermission request.

func (GroupClient) SetPermissionResponder 

func (client GroupClient) SetPermissionResponder(resp *http.Response) (result autorest.Response, err error)

SetPermissionResponder handles the response to the SetPermission request. The method always closes the http.Response Body.

func (GroupClient) SetPermissionSender 

func (client GroupClient) SetPermissionSender(req *http.Request) (*http.Response, error)

SetPermissionSender sends the SetPermission request. The method will close the http.Response Body if it receives an error.

type ManagementClient 

type ManagementClient struct {
	autorest.Client
	AdlsFileSystemDNSSuffix string
}

ManagementClient is the base client for Filesystem.

func New 

func New() ManagementClient

New creates an instance of the ManagementClient client.

func NewWithoutDefaults 

func NewWithoutDefaults(adlsFileSystemDNSSuffix string) ManagementClient

NewWithoutDefaults creates an instance of the ManagementClient client.

type ReadCloser 

type ReadCloser struct {
	autorest.Response `json:"-"`
	Value             *io.ReadCloser `json:"value,omitempty"`
}

ReadCloser is

type SyncFlag 

type SyncFlag string

SyncFlag enumerates the values for sync flag. 

const (
	// CLOSE specifies the close state for sync flag.
	CLOSE SyncFlag = "CLOSE"
	// DATA specifies the data state for sync flag.
	DATA SyncFlag = "DATA"
	// METADATA specifies the metadata state for sync flag.
	METADATA SyncFlag = "METADATA"
)

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.