Documentation ¶
Index ¶
- Constants
- Variables
- func FormatTimesForSASSigning(startTime, expiryTime time.Time) (string, string)
- func NewPipeline(c Credential, o PipelineOptions) pipeline.Pipeline
- func NewRequestLogPolicyFactory_Deprecated(o RequestLogOptions) pipeline.Factory
- func NewResponseError(cause error, response *http.Response, description string) error
- func NewRetryPolicyFactory(o RetryOptions) pipeline.Factory
- func NewRetryReader(ctx context.Context, initialResponse *http.Response, info HTTPGetterInfo, ...) io.ReadCloser
- func NewTelemetryPolicyFactory(o TelemetryOptions) pipeline.Factory
- func NewUniqueRequestIDPolicyFactory() pipeline.Factory
- func UserAgent() string
- func Version() string
- type AccountSASPermissions
- type AccountSASResourceTypes
- type AccountSASServices
- type AccountSASSignatureValues
- type BfsURLParts
- type BlobFSAccessControl
- type BlobFSHTTPHeaders
- type CreateDirectoryOptions
- type CreateFileOptions
- type Credential
- type DataLakeStorageError
- type DataLakeStorageErrorError
- type DirectoryCreateResponse
- func (dcr DirectoryCreateResponse) ContentLength() int64
- func (dcr DirectoryCreateResponse) Date() string
- func (dcr DirectoryCreateResponse) ETag() string
- func (dcr DirectoryCreateResponse) LastModified() string
- func (dcr DirectoryCreateResponse) Response() *http.Response
- func (dcr DirectoryCreateResponse) Status() string
- func (dcr DirectoryCreateResponse) StatusCode() int
- func (dcr DirectoryCreateResponse) XMsContinuation() string
- func (dcr DirectoryCreateResponse) XMsRequestID() string
- func (dcr DirectoryCreateResponse) XMsVersion() string
- type DirectoryDeleteResponse
- func (ddr DirectoryDeleteResponse) Date() string
- func (ddr DirectoryDeleteResponse) Response() *http.Response
- func (ddr DirectoryDeleteResponse) Status() string
- func (ddr DirectoryDeleteResponse) StatusCode() int
- func (ddr DirectoryDeleteResponse) XMsContinuation() string
- func (ddr DirectoryDeleteResponse) XMsRequestID() string
- func (ddr DirectoryDeleteResponse) XMsVersion() string
- type DirectoryGetPropertiesResponse
- func (dgpr DirectoryGetPropertiesResponse) AcceptRanges() string
- func (dgpr DirectoryGetPropertiesResponse) CacheControl() string
- func (dgpr DirectoryGetPropertiesResponse) ContentDisposition() string
- func (dgpr DirectoryGetPropertiesResponse) ContentEncoding() string
- func (dgpr DirectoryGetPropertiesResponse) ContentLanguage() string
- func (dgpr DirectoryGetPropertiesResponse) ContentLength() int64
- func (dgpr DirectoryGetPropertiesResponse) ContentMD5() []byte
- func (dgpr DirectoryGetPropertiesResponse) ContentRange() string
- func (dgpr DirectoryGetPropertiesResponse) ContentType() string
- func (dgpr DirectoryGetPropertiesResponse) Date() string
- func (dgpr DirectoryGetPropertiesResponse) ETag() string
- func (dgpr DirectoryGetPropertiesResponse) LastModified() string
- func (dgpr DirectoryGetPropertiesResponse) NewMetadata() (Metadata, error)
- func (dgpr DirectoryGetPropertiesResponse) Response() *http.Response
- func (dgpr DirectoryGetPropertiesResponse) Status() string
- func (dgpr DirectoryGetPropertiesResponse) StatusCode() int
- func (dgpr DirectoryGetPropertiesResponse) XMsLeaseDuration() string
- func (dgpr DirectoryGetPropertiesResponse) XMsLeaseState() string
- func (dgpr DirectoryGetPropertiesResponse) XMsLeaseStatus() string
- func (dgpr DirectoryGetPropertiesResponse) XMsProperties() string
- func (dgpr DirectoryGetPropertiesResponse) XMsRequestID() string
- func (dgpr DirectoryGetPropertiesResponse) XMsResourceType() string
- func (dgpr DirectoryGetPropertiesResponse) XMsVersion() string
- type DirectoryListResponse
- func (dlr DirectoryListResponse) Date() string
- func (dlr *DirectoryListResponse) Directories() []string
- func (dlr DirectoryListResponse) ETag() string
- func (dlr *DirectoryListResponse) Files() []Path
- func (dlr *DirectoryListResponse) FilesAndDirectories() []Path
- func (dlr DirectoryListResponse) LastModified() string
- func (dlr DirectoryListResponse) Response() *http.Response
- func (dlr DirectoryListResponse) Status() string
- func (dlr DirectoryListResponse) StatusCode() int
- func (dlr DirectoryListResponse) XMsContinuation() string
- func (dlr DirectoryListResponse) XMsRequestID() string
- func (dlr DirectoryListResponse) XMsVersion() string
- type DirectoryURL
- func (d DirectoryURL) Create(ctx context.Context, recreateIfExists bool) (*DirectoryCreateResponse, error)
- func (d DirectoryURL) CreateWithOptions(ctx context.Context, options CreateDirectoryOptions) (*DirectoryCreateResponse, error)
- func (d DirectoryURL) Delete(ctx context.Context, continuationString *string, recursive bool) (*DirectoryDeleteResponse, error)
- func (d DirectoryURL) FileSystemURL() FileSystemURL
- func (d DirectoryURL) GetAccessControl(ctx context.Context) (BlobFSAccessControl, error)
- func (d DirectoryURL) GetProperties(ctx context.Context) (*DirectoryGetPropertiesResponse, error)
- func (d DirectoryURL) IsDirectory(ctx context.Context) (bool, error)
- func (d DirectoryURL) IsFileSystemRoot() bool
- func (d DirectoryURL) ListDirectorySegment(ctx context.Context, marker Marker, recursive bool) (*DirectoryListResponse, error)
- func (d DirectoryURL) NewDirectoryURL(dirName string) DirectoryURL
- func (d DirectoryURL) NewFileURL(fileName string) FileURL
- func (d DirectoryURL) NewFileUrl() FileURL
- func (d DirectoryURL) Rename(ctx context.Context, options RenameDirectoryOptions) (DirectoryURL, error)
- func (d DirectoryURL) SetAccessControl(ctx context.Context, permissions BlobFSAccessControl) (*PathUpdateResponse, error)
- func (d DirectoryURL) String() string
- func (d DirectoryURL) URL() url.URL
- func (d DirectoryURL) WithPipeline(p pipeline.Pipeline) DirectoryURL
- type DownloadResponse
- func (dr DownloadResponse) AcceptRanges() string
- func (dr *DownloadResponse) Body(o RetryReaderOptions) io.ReadCloser
- func (dr DownloadResponse) CacheControl() string
- func (dr DownloadResponse) ContentDisposition() string
- func (dr DownloadResponse) ContentEncoding() string
- func (dr DownloadResponse) ContentLanguage() string
- func (dr DownloadResponse) ContentLength() int64
- func (dr DownloadResponse) ContentRange() string
- func (dr DownloadResponse) ContentType() string
- func (dr DownloadResponse) Date() string
- func (dr DownloadResponse) ETag() string
- func (dr DownloadResponse) LastModified() string
- func (dr DownloadResponse) RequestID() string
- func (dr DownloadResponse) Response() *http.Response
- func (dr DownloadResponse) Status() string
- func (dr DownloadResponse) StatusCode() int
- func (dr DownloadResponse) Version() string
- type FailedReadNotifier
- type FileSystemURL
- func (s FileSystemURL) Create(ctx context.Context) (*FilesystemCreateResponse, error)
- func (s FileSystemURL) Delete(ctx context.Context) (*FilesystemDeleteResponse, error)
- func (s FileSystemURL) GetAccessControl(ctx context.Context) (BlobFSAccessControl, error)
- func (s FileSystemURL) GetProperties(ctx context.Context) (*FilesystemGetPropertiesResponse, error)
- func (s FileSystemURL) ListPaths(ctx context.Context, options ListPathsFilesystemOptions) (*PathList, error)
- func (s FileSystemURL) NewDirectoryURL(directoryName string) DirectoryURL
- func (s FileSystemURL) NewRootDirectoryURL() DirectoryURL
- func (s FileSystemURL) SetAccessControl(ctx context.Context, permissions BlobFSAccessControl) (*PathUpdateResponse, error)
- func (s FileSystemURL) String() string
- func (s FileSystemURL) URL() url.URL
- func (s FileSystemURL) WithPipeline(p pipeline.Pipeline) FileSystemURL
- type FileURL
- func (f FileURL) AppendData(ctx context.Context, offset int64, body io.ReadSeeker) (*PathUpdateResponse, error)
- func (f FileURL) Create(ctx context.Context, headers BlobFSHTTPHeaders, ...) (*PathCreateResponse, error)
- func (f FileURL) CreateWithOptions(ctx context.Context, options CreateFileOptions, ...) (*PathCreateResponse, error)
- func (f FileURL) Delete(ctx context.Context) (*PathDeleteResponse, error)
- func (f FileURL) Download(ctx context.Context, offset int64, count int64) (*DownloadResponse, error)
- func (f FileURL) FlushData(ctx context.Context, fileSize int64, contentMd5 []byte, ...) (*PathUpdateResponse, error)
- func (f FileURL) GetAccessControl(ctx context.Context) (BlobFSAccessControl, error)
- func (f FileURL) GetParentDir() (DirectoryURL, error)
- func (f FileURL) GetProperties(ctx context.Context) (*PathGetPropertiesResponse, error)
- func (f FileURL) Rename(ctx context.Context, options RenameFileOptions) (FileURL, error)
- func (f FileURL) SetAccessControl(ctx context.Context, permissions BlobFSAccessControl) (*PathUpdateResponse, error)
- func (f FileURL) String() string
- func (f FileURL) URL() url.URL
- func (f FileURL) WithPipeline(p pipeline.Pipeline) FileURL
- type Filesystem
- type FilesystemCreateResponse
- func (fcr FilesystemCreateResponse) Date() string
- func (fcr FilesystemCreateResponse) ETag() string
- func (fcr FilesystemCreateResponse) LastModified() string
- func (fcr FilesystemCreateResponse) Response() *http.Response
- func (fcr FilesystemCreateResponse) Status() string
- func (fcr FilesystemCreateResponse) StatusCode() int
- func (fcr FilesystemCreateResponse) XMsNamespaceEnabled() string
- func (fcr FilesystemCreateResponse) XMsRequestID() string
- func (fcr FilesystemCreateResponse) XMsVersion() string
- type FilesystemDeleteResponse
- func (fdr FilesystemDeleteResponse) Date() string
- func (fdr FilesystemDeleteResponse) Response() *http.Response
- func (fdr FilesystemDeleteResponse) Status() string
- func (fdr FilesystemDeleteResponse) StatusCode() int
- func (fdr FilesystemDeleteResponse) XMsRequestID() string
- func (fdr FilesystemDeleteResponse) XMsVersion() string
- type FilesystemGetPropertiesResponse
- func (fgpr FilesystemGetPropertiesResponse) Date() string
- func (fgpr FilesystemGetPropertiesResponse) ETag() string
- func (fgpr FilesystemGetPropertiesResponse) LastModified() string
- func (fgpr FilesystemGetPropertiesResponse) Response() *http.Response
- func (fgpr FilesystemGetPropertiesResponse) Status() string
- func (fgpr FilesystemGetPropertiesResponse) StatusCode() int
- func (fgpr FilesystemGetPropertiesResponse) XMsNamespaceEnabled() string
- func (fgpr FilesystemGetPropertiesResponse) XMsProperties() string
- func (fgpr FilesystemGetPropertiesResponse) XMsRequestID() string
- func (fgpr FilesystemGetPropertiesResponse) XMsVersion() string
- type FilesystemList
- func (fl FilesystemList) ContentType() string
- func (fl FilesystemList) Date() string
- func (fl FilesystemList) Response() *http.Response
- func (fl FilesystemList) Status() string
- func (fl FilesystemList) StatusCode() int
- func (fl FilesystemList) XMsContinuation() string
- func (fl FilesystemList) XMsRequestID() string
- func (fl FilesystemList) XMsVersion() string
- type FilesystemSetPropertiesResponse
- func (fspr FilesystemSetPropertiesResponse) Date() string
- func (fspr FilesystemSetPropertiesResponse) ETag() string
- func (fspr FilesystemSetPropertiesResponse) LastModified() string
- func (fspr FilesystemSetPropertiesResponse) Response() *http.Response
- func (fspr FilesystemSetPropertiesResponse) Status() string
- func (fspr FilesystemSetPropertiesResponse) StatusCode() int
- func (fspr FilesystemSetPropertiesResponse) XMsRequestID() string
- func (fspr FilesystemSetPropertiesResponse) XMsVersion() string
- type HTTPGetter
- type HTTPGetterInfo
- type IPRange
- type ListPathsFilesystemOptions
- type Marker
- type Metadata
- type Path
- type PathCreateResponse
- func (pcr PathCreateResponse) ContentLength() int64
- func (pcr PathCreateResponse) Date() string
- func (pcr PathCreateResponse) ETag() string
- func (pcr PathCreateResponse) LastModified() string
- func (pcr PathCreateResponse) Response() *http.Response
- func (pcr PathCreateResponse) Status() string
- func (pcr PathCreateResponse) StatusCode() int
- func (pcr PathCreateResponse) XMsContinuation() string
- func (pcr PathCreateResponse) XMsRequestID() string
- func (pcr PathCreateResponse) XMsVersion() string
- type PathDeleteResponse
- func (pdr PathDeleteResponse) Date() string
- func (pdr PathDeleteResponse) Response() *http.Response
- func (pdr PathDeleteResponse) Status() string
- func (pdr PathDeleteResponse) StatusCode() int
- func (pdr PathDeleteResponse) XMsContinuation() string
- func (pdr PathDeleteResponse) XMsRequestID() string
- func (pdr PathDeleteResponse) XMsVersion() string
- type PathGetPropertiesActionType
- type PathGetPropertiesResponse
- func (pgpr PathGetPropertiesResponse) AcceptRanges() string
- func (pgpr PathGetPropertiesResponse) CacheControl() string
- func (pgpr PathGetPropertiesResponse) ContentDisposition() string
- func (pgpr PathGetPropertiesResponse) ContentEncoding() string
- func (pgpr PathGetPropertiesResponse) ContentLanguage() string
- func (pgpr PathGetPropertiesResponse) ContentLength() int64
- func (pgpr PathGetPropertiesResponse) ContentMD5() []byte
- func (pgpr PathGetPropertiesResponse) ContentRange() string
- func (pgpr PathGetPropertiesResponse) ContentType() string
- func (pgpr PathGetPropertiesResponse) Date() string
- func (pgpr PathGetPropertiesResponse) ETag() string
- func (pgpr PathGetPropertiesResponse) LastModified() string
- func (bgpr PathGetPropertiesResponse) NewMetadata() (Metadata, error)
- func (pgpr PathGetPropertiesResponse) Response() *http.Response
- func (pgpr PathGetPropertiesResponse) Status() string
- func (pgpr PathGetPropertiesResponse) StatusCode() int
- func (pgpr PathGetPropertiesResponse) XMsACL() string
- func (pgpr PathGetPropertiesResponse) XMsGroup() string
- func (pgpr PathGetPropertiesResponse) XMsLeaseDuration() string
- func (pgpr PathGetPropertiesResponse) XMsLeaseState() string
- func (pgpr PathGetPropertiesResponse) XMsLeaseStatus() string
- func (pgpr PathGetPropertiesResponse) XMsOwner() string
- func (pgpr PathGetPropertiesResponse) XMsPermissions() string
- func (pgpr PathGetPropertiesResponse) XMsProperties() string
- func (pgpr PathGetPropertiesResponse) XMsRequestID() string
- func (pgpr PathGetPropertiesResponse) XMsResourceType() string
- func (pgpr PathGetPropertiesResponse) XMsVersion() string
- type PathLeaseActionType
- type PathLeaseResponse
- func (plr PathLeaseResponse) Date() string
- func (plr PathLeaseResponse) ETag() string
- func (plr PathLeaseResponse) LastModified() string
- func (plr PathLeaseResponse) Response() *http.Response
- func (plr PathLeaseResponse) Status() string
- func (plr PathLeaseResponse) StatusCode() int
- func (plr PathLeaseResponse) XMsLeaseID() string
- func (plr PathLeaseResponse) XMsLeaseTime() string
- func (plr PathLeaseResponse) XMsRequestID() string
- func (plr PathLeaseResponse) XMsVersion() string
- type PathList
- func (pl PathList) Date() string
- func (pl PathList) ETag() string
- func (pl PathList) LastModified() string
- func (pl PathList) Response() *http.Response
- func (pl PathList) Status() string
- func (pl PathList) StatusCode() int
- func (pl PathList) XMsContinuation() string
- func (pl PathList) XMsRequestID() string
- func (pl PathList) XMsVersion() string
- type PathRenameModeType
- type PathResourceType
- type PathUpdateActionType
- type PathUpdateResponse
- func (pur PathUpdateResponse) AcceptRanges() string
- func (pur PathUpdateResponse) CacheControl() string
- func (pur PathUpdateResponse) ContentDisposition() string
- func (pur PathUpdateResponse) ContentEncoding() string
- func (pur PathUpdateResponse) ContentLanguage() string
- func (pur PathUpdateResponse) ContentLength() int64
- func (pur PathUpdateResponse) ContentRange() string
- func (pur PathUpdateResponse) ContentType() string
- func (pur PathUpdateResponse) Date() string
- func (pur PathUpdateResponse) ETag() string
- func (pur PathUpdateResponse) LastModified() string
- func (pur PathUpdateResponse) Response() *http.Response
- func (pur PathUpdateResponse) Status() string
- func (pur PathUpdateResponse) StatusCode() int
- func (pur PathUpdateResponse) XMsProperties() string
- func (pur PathUpdateResponse) XMsRequestID() string
- func (pur PathUpdateResponse) XMsVersion() string
- type PipelineOptions
- type ReadResponse
- func (rr ReadResponse) AcceptRanges() string
- func (rr ReadResponse) Body() io.ReadCloser
- func (rr ReadResponse) CacheControl() string
- func (rr ReadResponse) ContentDisposition() string
- func (rr ReadResponse) ContentEncoding() string
- func (rr ReadResponse) ContentLanguage() string
- func (rr ReadResponse) ContentLength() int64
- func (rr ReadResponse) ContentMD5() string
- func (rr ReadResponse) ContentRange() string
- func (rr ReadResponse) ContentType() string
- func (rr ReadResponse) Date() string
- func (rr ReadResponse) ETag() string
- func (rr ReadResponse) LastModified() string
- func (rr ReadResponse) Response() *http.Response
- func (rr ReadResponse) Status() string
- func (rr ReadResponse) StatusCode() int
- func (rr ReadResponse) XMsLeaseDuration() string
- func (rr ReadResponse) XMsLeaseState() string
- func (rr ReadResponse) XMsLeaseStatus() string
- func (rr ReadResponse) XMsProperties() string
- func (rr ReadResponse) XMsRequestID() string
- func (rr ReadResponse) XMsResourceType() string
- func (rr ReadResponse) XMsVersion() string
- type RenameDirectoryOptions
- type RenameFileOptions
- type RequestLogOptions
- type ResponseError
- type RetryOptions
- type RetryPolicy
- type RetryReaderOptions
- type SASProtocol
- type SASQueryParameters
- func (p *SASQueryParameters) CacheControl() string
- func (p *SASQueryParameters) ContentDisposition() string
- func (p *SASQueryParameters) ContentEncoding() string
- func (p *SASQueryParameters) ContentLanguage() string
- func (p *SASQueryParameters) ContentType() string
- func (p *SASQueryParameters) Encode() string
- func (p *SASQueryParameters) ExpiryTime() time.Time
- func (p *SASQueryParameters) IPRange() IPRange
- func (p *SASQueryParameters) Identifier() string
- func (p *SASQueryParameters) Permissions() string
- func (p *SASQueryParameters) Protocol() SASProtocol
- func (p *SASQueryParameters) Resource() string
- func (p *SASQueryParameters) ResourceTypes() string
- func (p *SASQueryParameters) Services() string
- func (p *SASQueryParameters) Signature() string
- func (p *SASQueryParameters) StartTime() time.Time
- func (p *SASQueryParameters) Version() string
- type ServiceCodeType
- type ServiceURL
- func (s ServiceURL) ListFilesystemsSegment(ctx context.Context, marker *string) (*FilesystemList, error)
- func (s ServiceURL) NewFileSystemURL(fileSystemName string) FileSystemURL
- func (s ServiceURL) String() string
- func (s ServiceURL) URL() url.URL
- func (s ServiceURL) WithPipeline(p pipeline.Pipeline) ServiceURL
- type SharedKeyCredential
- type StorageError
- type TelemetryOptions
- type TokenCredential
Constants ¶
const ( // CountToEnd indicates a flag for count parameter. It means the count of bytes // from start offset to the end of file. CountToEnd = 0 )
const ReadOnClosedBodyMessage = "read on closed response body"
const SASTimeFormat = "2006-01-02T15:04:05Z" //"2017-07-27T00:00:00Z" // ISO 8601
SASTimeFormat represents the format of a SAS start or expiry time. Use it when formatting/parsing a time.Time.
const SASVersion = ServiceVersion
SASVersion indicates the SAS version.
const (
// ServiceVersion specifies the version of the operations used in this package.
ServiceVersion = "2018-11-09"
)
const SigAzure = "sig" // calling code expects this to be lower case
constants here, not in common, to avoid circular dependency. Alternative would be to not use the constants here in azbfs.
const SigXAmzForAws = "x-amz-signature" // calling code expects this to be lower case
Variables ¶
var SASTimeFormats = []string{"2006-01-02T15:04:05.0000000Z", SASTimeFormat, "2006-01-02T15:04Z", "2006-01-02"} // ISO 8601 formats, please refer to https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas for more details.
changes regarding additional time formats credit to ATOMiCNebula, just ported to azbfs.
Functions ¶
func FormatTimesForSASSigning ¶
FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a SASField's StartTime or ExpiryTime fields. Returns "" if value.IsZero().
func NewPipeline ¶
func NewPipeline(c Credential, o PipelineOptions) pipeline.Pipeline
NewPipeline creates a Pipeline using the specified credentials and options.
func NewRequestLogPolicyFactory_Deprecated ¶
func NewRequestLogPolicyFactory_Deprecated(o RequestLogOptions) pipeline.Factory
NewRequestLogPolicyFactory_Deprecated creates a RequestLogPolicyFactory object configured using the specified options. Deprecated because we are moving to centralize everything on the one logging policy in STE
func NewResponseError ¶
NewResponseError creates an error object that implements the error interface.
func NewRetryPolicyFactory ¶
func NewRetryPolicyFactory(o RetryOptions) pipeline.Factory
NewRetryPolicyFactory creates a RetryPolicyFactory object configured using the specified options.
func NewRetryReader ¶
func NewRetryReader(ctx context.Context, initialResponse *http.Response, info HTTPGetterInfo, o RetryReaderOptions, getter HTTPGetter) io.ReadCloser
NewRetryReader creates a retry reader.
func NewTelemetryPolicyFactory ¶
func NewTelemetryPolicyFactory(o TelemetryOptions) pipeline.Factory
NewTelemetryPolicyFactory creates a factory that can create telemetry policy objects which add telemetry information to outgoing HTTP requests.
func NewUniqueRequestIDPolicyFactory ¶
NewUniqueRequestIDPolicyFactory creates a UniqueRequestIDPolicyFactory object that sets the request's x-ms-client-request-id header if it doesn't already exist.
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 AccountSASPermissions ¶
type AccountSASPermissions struct {
Read, Write, Delete, List, Add, Create, Update, Process bool
}
The AccountSASPermissions type simplifies creating the permissions string for an Azure Storage Account SAS. Initialize an instance of this type and then call its String method to set AccountSASSignatureValues' Permissions field.
func (*AccountSASPermissions) Parse ¶
func (p *AccountSASPermissions) Parse(s string) error
Parse initializes the AccountSASPermissions' fields from a string.
func (AccountSASPermissions) String ¶
func (p AccountSASPermissions) String() string
String produces the SAS permissions string for an Azure Storage account. Call this method to set AccountSASSignatureValues' Permissions field.
type AccountSASResourceTypes ¶
type AccountSASResourceTypes struct {
Service, Container, Object bool
}
The AccountSASResourceTypes type simplifies creating the resource types string for an Azure Storage Account SAS. Initialize an instance of this type and then call its String method to set AccountSASSignatureValues' ResourceTypes field.
func (*AccountSASResourceTypes) Parse ¶
func (rt *AccountSASResourceTypes) Parse(s string) error
Parse initializes the AccountSASResourceType's fields from a string.
func (AccountSASResourceTypes) String ¶
func (rt AccountSASResourceTypes) String() string
String produces the SAS resource types string for an Azure Storage account. Call this method to set AccountSASSignatureValues' ResourceTypes field.
type AccountSASServices ¶
type AccountSASServices struct {
Blob, Queue, File bool
}
The AccountSASServices type simplifies creating the services string for an Azure Storage Account SAS. Initialize an instance of this type and then call its String method to set AccountSASSignatureValues' Services field.
func (*AccountSASServices) Parse ¶
func (a *AccountSASServices) Parse(s string) error
Parse initializes the AccountSASServices' fields from a string.
func (AccountSASServices) String ¶
func (s AccountSASServices) String() string
String produces the SAS services string for an Azure Storage account. Call this method to set AccountSASSignatureValues' Services field.
type AccountSASSignatureValues ¶
type AccountSASSignatureValues struct { Version string `param:"sv"` // If not specified, this defaults to SASVersion Protocol SASProtocol `param:"spr"` // See the SASProtocol* constants StartTime time.Time `param:"st"` // Not specified if IsZero ExpiryTime time.Time `param:"se"` // Not specified if IsZero Permissions string `param:"sp"` // Create by initializing a AccountSASPermissions and then call String() IPRange IPRange `param:"sip"` Services string `param:"ss"` // Create by initializing AccountSASServices and then call String() ResourceTypes string `param:"srt"` // Create by initializing AccountSASResourceTypes and then call String() }
AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account. For more information, see https://docs.microsoft.com/rest/api/storageservices/constructing-an-account-sas
func (AccountSASSignatureValues) NewSASQueryParameters ¶
func (v AccountSASSignatureValues) NewSASQueryParameters(sharedKeyCredential *SharedKeyCredential) (SASQueryParameters, error)
NewSASQueryParameters uses an account's shared key credential to sign this signature values to produce the proper SAS query parameters.
type BfsURLParts ¶
type BfsURLParts struct { Scheme string // Ex: "https://" Host string // Ex: "account.dfs.core.windows.net" FileSystemName string // File System name, Ex: "myfilesystem" DirectoryOrFilePath string // Path of directory or file, Ex: "mydirectory/myfile" UnparsedParams string SAS SASQueryParameters // contains filtered or unexported fields }
A BfsURLParts object represents the components that make up an Azure Storage FileSystem/Directory/File URL. You parse an existing URL into its parts by calling NewBfsURLParts(). You construct a URL from parts by calling URL().
func NewBfsURLParts ¶
func NewBfsURLParts(u url.URL) BfsURLParts
NewBfsURLParts parses a URL initializing BfsURLParts' fields. Any other query parameters remain in the UnparsedParams field. This method overwrites all fields in the BfsURLParts object.
func (BfsURLParts) URL ¶
func (up BfsURLParts) URL() url.URL
URL returns a URL object whose fields are initialized from the BfsURLParts fields.
type BlobFSAccessControl ¶
type BlobFSAccessControl struct { Owner string Group string ACL string // Combining ACL & Permissions = invalid for SetAccessControl. Permissions string }
BlobFSAccessControl represents the set of custom headers available for defining access conditions for the content.
type BlobFSHTTPHeaders ¶
type BlobFSHTTPHeaders struct { ContentType string ContentEncoding string ContentLanguage string ContentDisposition string CacheControl string }
BlobFSHTTPHeaders represents the set of custom headers available for defining information about the content.
type CreateDirectoryOptions ¶
type CreateDirectoryOptions struct { // Whether or not to recreate the directory if it exists. RecreateIfExists bool // User defined properties to be stored with the directory. Metadata map[string]string }
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
type CreateFileOptions ¶
type CreateFileOptions struct { // Custom headers to apply to the file. Headers BlobFSHTTPHeaders // User defined properties to be stored with the file. Metadata map[string]string }
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
type Credential ¶
Credential represent any credential type; it is used to create a credential policy Factory.
func NewAnonymousCredential ¶
func NewAnonymousCredential() Credential
NewAnonymousCredential creates an anonymous credential for use with HTTP(S) requests that read public resource or for use with Shared Access Signatures (SAS).
type DataLakeStorageError ¶
type DataLakeStorageError struct { // Error - The service error response object. Error *DataLakeStorageErrorError `json:"error,omitempty"` }
DataLakeStorageError ...
type DataLakeStorageErrorError ¶
type DataLakeStorageErrorError struct { // Code - The service error code. Code *string `json:"code,omitempty"` // Message - The service error message. Message *string `json:"message,omitempty"` }
DataLakeStorageErrorError - The service error response object.
type DirectoryCreateResponse ¶
type DirectoryCreateResponse PathCreateResponse
DirectoryCreateResponse is the CreatePathResponse response type returned for directory specific operations The type is used to establish difference in the response for file and directory operations since both type of operations has same response type.
func (DirectoryCreateResponse) ContentLength ¶
func (dcr DirectoryCreateResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (DirectoryCreateResponse) Date ¶
func (dcr DirectoryCreateResponse) Date() string
Date returns the value for header Date.
func (DirectoryCreateResponse) ETag ¶
func (dcr DirectoryCreateResponse) ETag() string
ETag returns the value for header ETag.
func (DirectoryCreateResponse) LastModified ¶
func (dcr DirectoryCreateResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (DirectoryCreateResponse) Response ¶
func (dcr DirectoryCreateResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (DirectoryCreateResponse) Status ¶
func (dcr DirectoryCreateResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (DirectoryCreateResponse) StatusCode ¶
func (dcr DirectoryCreateResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (DirectoryCreateResponse) XMsContinuation ¶
func (dcr DirectoryCreateResponse) XMsContinuation() string
XMsContinuation returns the value for header x-ms-continuation.
func (DirectoryCreateResponse) XMsRequestID ¶
func (dcr DirectoryCreateResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (DirectoryCreateResponse) XMsVersion ¶
func (dcr DirectoryCreateResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type DirectoryDeleteResponse ¶
type DirectoryDeleteResponse PathDeleteResponse
DirectoryDeleteResponse is the DeletePathResponse response type returned for directory specific operations The type is used to establish difference in the response for file and directory operations since both type of operations has same response type.
func (DirectoryDeleteResponse) Date ¶
func (ddr DirectoryDeleteResponse) Date() string
Date returns the value for header Date.
func (DirectoryDeleteResponse) Response ¶
func (ddr DirectoryDeleteResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (DirectoryDeleteResponse) Status ¶
func (ddr DirectoryDeleteResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (DirectoryDeleteResponse) StatusCode ¶
func (ddr DirectoryDeleteResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (DirectoryDeleteResponse) XMsContinuation ¶
func (ddr DirectoryDeleteResponse) XMsContinuation() string
XMsContinuation returns the value for header x-ms-continuation.
func (DirectoryDeleteResponse) XMsRequestID ¶
func (ddr DirectoryDeleteResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (DirectoryDeleteResponse) XMsVersion ¶
func (ddr DirectoryDeleteResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type DirectoryGetPropertiesResponse ¶
type DirectoryGetPropertiesResponse PathGetPropertiesResponse
DirectoryGetPropertiesResponse is the GetPathPropertiesResponse response type returned for directory specific operations The type is used to establish difference in the response for file and directory operations since both type of operations has same response type.
func (DirectoryGetPropertiesResponse) AcceptRanges ¶
func (dgpr DirectoryGetPropertiesResponse) AcceptRanges() string
AcceptRanges returns the value for header Accept-Ranges.
func (DirectoryGetPropertiesResponse) CacheControl ¶
func (dgpr DirectoryGetPropertiesResponse) CacheControl() string
CacheControl returns the value for header Cache-Control.
func (DirectoryGetPropertiesResponse) ContentDisposition ¶
func (dgpr DirectoryGetPropertiesResponse) ContentDisposition() string
ContentDisposition returns the value for header Content-Disposition.
func (DirectoryGetPropertiesResponse) ContentEncoding ¶
func (dgpr DirectoryGetPropertiesResponse) ContentEncoding() string
ContentEncoding returns the value for header Content-Encoding.
func (DirectoryGetPropertiesResponse) ContentLanguage ¶
func (dgpr DirectoryGetPropertiesResponse) ContentLanguage() string
ContentLanguage returns the value for header Content-Language.
func (DirectoryGetPropertiesResponse) ContentLength ¶
func (dgpr DirectoryGetPropertiesResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (DirectoryGetPropertiesResponse) ContentMD5 ¶
func (dgpr DirectoryGetPropertiesResponse) ContentMD5() []byte
ContentMD5 returns the value for header Content-MD5.
func (DirectoryGetPropertiesResponse) ContentRange ¶
func (dgpr DirectoryGetPropertiesResponse) ContentRange() string
ContentRange returns the value for header Content-Range.
func (DirectoryGetPropertiesResponse) ContentType ¶
func (dgpr DirectoryGetPropertiesResponse) ContentType() string
ContentType returns the value for header Content-Type.
func (DirectoryGetPropertiesResponse) Date ¶
func (dgpr DirectoryGetPropertiesResponse) Date() string
Date returns the value for header Date.
func (DirectoryGetPropertiesResponse) ETag ¶
func (dgpr DirectoryGetPropertiesResponse) ETag() string
ETag returns the value for header ETag.
func (DirectoryGetPropertiesResponse) LastModified ¶
func (dgpr DirectoryGetPropertiesResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (DirectoryGetPropertiesResponse) NewMetadata ¶ added in v10.13.33
func (dgpr DirectoryGetPropertiesResponse) NewMetadata() (Metadata, error)
NewMetadata returns user-defined key/value pairs.
func (DirectoryGetPropertiesResponse) Response ¶
func (dgpr DirectoryGetPropertiesResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (DirectoryGetPropertiesResponse) Status ¶
func (dgpr DirectoryGetPropertiesResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (DirectoryGetPropertiesResponse) StatusCode ¶
func (dgpr DirectoryGetPropertiesResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (DirectoryGetPropertiesResponse) XMsLeaseDuration ¶
func (dgpr DirectoryGetPropertiesResponse) XMsLeaseDuration() string
XMsLeaseDuration returns the value for header x-ms-lease-duration.
func (DirectoryGetPropertiesResponse) XMsLeaseState ¶
func (dgpr DirectoryGetPropertiesResponse) XMsLeaseState() string
XMsLeaseState returns the value for header x-ms-lease-state.
func (DirectoryGetPropertiesResponse) XMsLeaseStatus ¶
func (dgpr DirectoryGetPropertiesResponse) XMsLeaseStatus() string
XMsLeaseStatus returns the value for header x-ms-lease-status.
func (DirectoryGetPropertiesResponse) XMsProperties ¶
func (dgpr DirectoryGetPropertiesResponse) XMsProperties() string
XMsProperties returns the value for header x-ms-properties.
func (DirectoryGetPropertiesResponse) XMsRequestID ¶
func (dgpr DirectoryGetPropertiesResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (DirectoryGetPropertiesResponse) XMsResourceType ¶
func (dgpr DirectoryGetPropertiesResponse) XMsResourceType() string
XMsResourceType returns the value for header x-ms-resource-type.
func (DirectoryGetPropertiesResponse) XMsVersion ¶
func (dgpr DirectoryGetPropertiesResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type DirectoryListResponse ¶
type DirectoryListResponse PathList // TODO: Used to by ListPathResponse. Have I changed it to the right thing?
DirectoryListResponse is the ListSchema response type. This type declaration is used to implement useful methods on ListPath response
func (DirectoryListResponse) Date ¶
func (dlr DirectoryListResponse) Date() string
Date returns the value for header Date.
func (*DirectoryListResponse) Directories ¶
func (dlr *DirectoryListResponse) Directories() []string
Directories returns the slice of all directories in ListDirectorySegment Response It does not include the files inside the directory only returns the sub-directories
func (DirectoryListResponse) ETag ¶
func (dlr DirectoryListResponse) ETag() string
ETag returns the value for header ETag.
func (*DirectoryListResponse) Files ¶
func (dlr *DirectoryListResponse) Files() []Path
Files returns the slice of all Files in ListDirectorySegment Response. It does not include the sub-directory path
func (*DirectoryListResponse) FilesAndDirectories ¶
func (dlr *DirectoryListResponse) FilesAndDirectories() []Path
func (DirectoryListResponse) LastModified ¶
func (dlr DirectoryListResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (DirectoryListResponse) Response ¶
func (dlr DirectoryListResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (DirectoryListResponse) Status ¶
func (dlr DirectoryListResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (DirectoryListResponse) StatusCode ¶
func (dlr DirectoryListResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (DirectoryListResponse) XMsContinuation ¶
func (dlr DirectoryListResponse) XMsContinuation() string
XMsContinuation returns the value for header x-ms-continuation.
func (DirectoryListResponse) XMsRequestID ¶
func (dlr DirectoryListResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (DirectoryListResponse) XMsVersion ¶
func (dlr DirectoryListResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type DirectoryURL ¶
type DirectoryURL struct {
// contains filtered or unexported fields
}
A DirectoryURL represents a URL to the Azure Storage directory allowing you to manipulate its directories and files.
func NewDirectoryURL ¶
func NewDirectoryURL(url url.URL, p pipeline.Pipeline) DirectoryURL
NewDirectoryURL creates a DirectoryURL object using the specified URL and request policy pipeline.
func (DirectoryURL) Create ¶
func (d DirectoryURL) Create(ctx context.Context, recreateIfExists bool) (*DirectoryCreateResponse, error)
Create creates a new directory within a File System
func (DirectoryURL) CreateWithOptions ¶
func (d DirectoryURL) CreateWithOptions(ctx context.Context, options CreateDirectoryOptions) (*DirectoryCreateResponse, error)
Create creates a new directory within a File System
func (DirectoryURL) Delete ¶
func (d DirectoryURL) Delete(ctx context.Context, continuationString *string, recursive bool) (*DirectoryDeleteResponse, error)
Delete removes the specified empty directory. Note that the directory must be empty before it can be deleted.. For more information, see https://docs.microsoft.com/rest/api/storageservices/delete-directory.
func (DirectoryURL) FileSystemURL ¶
func (d DirectoryURL) FileSystemURL() FileSystemURL
FileSystemURL returns the fileSystemUrl from the directoryUrl FileSystemURL is of the FS in which the current directory exists.
func (DirectoryURL) GetAccessControl ¶
func (d DirectoryURL) GetAccessControl(ctx context.Context) (BlobFSAccessControl, error)
func (DirectoryURL) GetProperties ¶
func (d DirectoryURL) GetProperties(ctx context.Context) (*DirectoryGetPropertiesResponse, error)
GetProperties returns the directory's metadata and system properties.
func (DirectoryURL) IsDirectory ¶
func (d DirectoryURL) IsDirectory(ctx context.Context) (bool, error)
IsDirectory determines whether the resource at given directoryUrl is a directory Url or not It returns false if the directoryUrl is not able to get resource properties It returns false if the url represent a file in the filesystem TODO reconsider for SDK release
func (DirectoryURL) IsFileSystemRoot ¶
func (d DirectoryURL) IsFileSystemRoot() bool
func (DirectoryURL) ListDirectorySegment ¶
func (d DirectoryURL) ListDirectorySegment(ctx context.Context, marker Marker, recursive bool) (*DirectoryListResponse, error)
ListDirectorySegment returns files/directories inside the directory. If recursive is set to true then ListDirectorySegment will recursively list all files/directories inside the directory. Use an empty Marker to start enumeration from the beginning. After getting a segment, process it, and then call ListDirectorySegment again (passing the the previously-returned Marker) to get the next segment.
func (DirectoryURL) NewDirectoryURL ¶
func (d DirectoryURL) NewDirectoryURL(dirName string) DirectoryURL
NewDirectoryURL creates a new Directory Url for Sub directory inside the directory of given directory URL. The new NewDirectoryURL uses the same request policy pipeline as the DirectoryURL. To change the pipeline, create the NewDirectoryUrl and then call its WithPipeline method passing in the desired pipeline object.
func (DirectoryURL) NewFileURL ¶
func (d DirectoryURL) NewFileURL(fileName string) FileURL
NewFileURL creates a new FileURL object by concatenating fileName to the end of DirectoryURL's URL. The new FileURL uses the same request policy pipeline as the DirectoryURL. To change the pipeline, create the FileURL and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's NewFileURL instead of calling this object's NewFileURL method.
func (DirectoryURL) NewFileUrl ¶
func (d DirectoryURL) NewFileUrl() FileURL
NewFileUrl converts the current directory Url into the NewFileUrl This api is used when the directoryUrl is to represents a file
func (DirectoryURL) Rename ¶
func (d DirectoryURL) Rename(ctx context.Context, options RenameDirectoryOptions) (DirectoryURL, error)
Renames the directory to the provided destination
func (DirectoryURL) SetAccessControl ¶
func (d DirectoryURL) SetAccessControl(ctx context.Context, permissions BlobFSAccessControl) (*PathUpdateResponse, error)
func (DirectoryURL) String ¶
func (d DirectoryURL) String() string
String returns the URL as a string.
func (DirectoryURL) URL ¶
func (d DirectoryURL) URL() url.URL
URL returns the URL endpoint used by the DirectoryURL object.
func (DirectoryURL) WithPipeline ¶
func (d DirectoryURL) WithPipeline(p pipeline.Pipeline) DirectoryURL
WithPipeline creates a new DirectoryURL object identical to the source but with the specified request policy pipeline.
type DownloadResponse ¶
type DownloadResponse struct {
// contains filtered or unexported fields
}
DownloadResponse wraps AutoRest generated downloadResponse and helps to provide info for retry.
func (DownloadResponse) AcceptRanges ¶
func (dr DownloadResponse) AcceptRanges() string
AcceptRanges returns the value for header Accept-Ranges.
func (*DownloadResponse) Body ¶
func (dr *DownloadResponse) Body(o RetryReaderOptions) io.ReadCloser
Body constructs a stream to read data from with a resilient reader option. A zero-value option means to get a raw stream.
func (DownloadResponse) CacheControl ¶
func (dr DownloadResponse) CacheControl() string
CacheControl returns the value for header Cache-Control.
func (DownloadResponse) ContentDisposition ¶
func (dr DownloadResponse) ContentDisposition() string
ContentDisposition returns the value for header Content-Disposition.
func (DownloadResponse) ContentEncoding ¶
func (dr DownloadResponse) ContentEncoding() string
ContentEncoding returns the value for header Content-Encoding.
func (DownloadResponse) ContentLanguage ¶
func (dr DownloadResponse) ContentLanguage() string
ContentLanguage returns the value for header Content-Language.
func (DownloadResponse) ContentLength ¶
func (dr DownloadResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (DownloadResponse) ContentRange ¶
func (dr DownloadResponse) ContentRange() string
ContentRange returns the value for header Content-Range.
func (DownloadResponse) ContentType ¶
func (dr DownloadResponse) ContentType() string
ContentType returns the value for header Content-Type.
func (DownloadResponse) Date ¶
func (dr DownloadResponse) Date() string
Date returns the value for header Date.
func (DownloadResponse) ETag ¶
func (dr DownloadResponse) ETag() string
ETag returns the value for header ETag.
func (DownloadResponse) LastModified ¶
func (dr DownloadResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (DownloadResponse) RequestID ¶
func (dr DownloadResponse) RequestID() string
RequestID returns the value for header x-ms-request-id.
func (DownloadResponse) Response ¶
func (dr DownloadResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (DownloadResponse) Status ¶
func (dr DownloadResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (DownloadResponse) StatusCode ¶
func (dr DownloadResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (DownloadResponse) Version ¶
func (dr DownloadResponse) Version() string
Version returns the value for header x-ms-version.
type FailedReadNotifier ¶
type FailedReadNotifier func(failureCount int, lastError error, offset int64, count int64, willRetry bool)
FailedReadNotifier is a function type that represents the notification function called when a read fails
type FileSystemURL ¶
type FileSystemURL struct {
// contains filtered or unexported fields
}
A FileSystemURL represents a URL to the Azure Storage Blob File System allowing you to manipulate its directories and files.
func NewFileSystemURL ¶
func NewFileSystemURL(url url.URL, p pipeline.Pipeline) FileSystemURL
NewFileSystemURL creates a FileSystemURL object using the specified URL and request policy pipeline.
func (FileSystemURL) Create ¶
func (s FileSystemURL) Create(ctx context.Context) (*FilesystemCreateResponse, error)
Create creates a new file system within a storage account. If a file system with the same name already exists, the operation fails. quotaInGB specifies the maximum size of the file system in gigabytes, 0 means you accept service's default quota.
func (FileSystemURL) Delete ¶
func (s FileSystemURL) Delete(ctx context.Context) (*FilesystemDeleteResponse, error)
Delete marks the specified file system for deletion. The file system and any files contained within it are later deleted during garbage collection.
func (FileSystemURL) GetAccessControl ¶
func (s FileSystemURL) GetAccessControl(ctx context.Context) (BlobFSAccessControl, error)
func (FileSystemURL) GetProperties ¶
func (s FileSystemURL) GetProperties(ctx context.Context) (*FilesystemGetPropertiesResponse, error)
GetProperties returns all user-defined metadata and system properties for the specified file system or file system snapshot.
func (FileSystemURL) ListPaths ¶
func (s FileSystemURL) ListPaths(ctx context.Context, options ListPathsFilesystemOptions) (*PathList, error)
ListPaths returns a list of paths in the file system.
func (FileSystemURL) NewDirectoryURL ¶
func (s FileSystemURL) NewDirectoryURL(directoryName string) DirectoryURL
NewDirectoryURL creates a new DirectoryURL object by concatenating directoryName to the end of FileSystemURL's URL. The new DirectoryURL uses the same request policy pipeline as the FileSystemURL. To change the pipeline, create the DirectoryURL and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's NewDirectoryURL instead of calling this object's NewDirectoryURL method.
func (FileSystemURL) NewRootDirectoryURL ¶
func (s FileSystemURL) NewRootDirectoryURL() DirectoryURL
NewRootDirectoryURL creates a new DirectoryURL object using FileSystemURL's URL. The new DirectoryURL uses the same request policy pipeline as the FileSystemURL. To change the pipeline, create the DirectoryURL and then call its WithPipeline method passing in the desired pipeline object. Or, call NewDirectoryURL instead of calling the NewDirectoryURL method.
func (FileSystemURL) SetAccessControl ¶
func (s FileSystemURL) SetAccessControl(ctx context.Context, permissions BlobFSAccessControl) (*PathUpdateResponse, error)
func (FileSystemURL) String ¶
func (s FileSystemURL) String() string
String returns the URL as a string.
func (FileSystemURL) URL ¶
func (s FileSystemURL) URL() url.URL
URL returns the URL endpoint used by the FileSystemURL object.
func (FileSystemURL) WithPipeline ¶
func (s FileSystemURL) WithPipeline(p pipeline.Pipeline) FileSystemURL
WithPipeline creates a new FileSystemURL object identical to the source but with the specified request policy pipeline.
type FileURL ¶
type FileURL struct {
// contains filtered or unexported fields
}
A FileURL represents a URL to an Azure Storage file.
func NewFileURL ¶
NewFileURL creates a FileURL object using the specified URL and request policy pipeline.
func (FileURL) AppendData ¶
func (f FileURL) AppendData(ctx context.Context, offset int64, body io.ReadSeeker) (*PathUpdateResponse, error)
UploadRange writes bytes to a file. offset indicates the offset at which to begin writing, in bytes. custom headers are not valid on this operation
func (FileURL) Create ¶
func (f FileURL) Create(ctx context.Context, headers BlobFSHTTPHeaders, permissions BlobFSAccessControl) (*PathCreateResponse, error)
Create creates a new file or replaces a file. Note that this method only initializes the file. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
func (FileURL) CreateWithOptions ¶
func (f FileURL) CreateWithOptions(ctx context.Context, options CreateFileOptions, permissions BlobFSAccessControl) (*PathCreateResponse, error)
Create creates a new file or replaces a file. Note that this method only initializes the file. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
func (FileURL) Delete ¶
func (f FileURL) Delete(ctx context.Context) (*PathDeleteResponse, error)
Delete immediately removes the file from the storage account. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.
func (FileURL) Download ¶
func (f FileURL) Download(ctx context.Context, offset int64, count int64) (*DownloadResponse, error)
Download downloads count bytes of data from the start offset. If count is CountToEnd (0), then data is read from specified offset to the end. The response includes all of the file’s properties. However, passing true for rangeGetContentMD5 returns the range’s MD5 in the ContentMD5 response header/property if the range is <= 4MB; the HTTP request fails with 400 (Bad Request) if the requested range is greater than 4MB. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-file.
func (FileURL) FlushData ¶
func (f FileURL) FlushData(ctx context.Context, fileSize int64, contentMd5 []byte, headers BlobFSHTTPHeaders, retainUncommittedData bool, closeFile bool) (*PathUpdateResponse, error)
flushes writes previously uploaded data to a file The contentMd5 parameter, if not nil, should represent the MD5 hash that has been computed for the file as whole
func (FileURL) GetAccessControl ¶
func (f FileURL) GetAccessControl(ctx context.Context) (BlobFSAccessControl, error)
func (FileURL) GetParentDir ¶
func (f FileURL) GetParentDir() (DirectoryURL, error)
func (FileURL) GetProperties ¶
func (f FileURL) GetProperties(ctx context.Context) (*PathGetPropertiesResponse, error)
GetProperties returns the file's metadata and properties. For more information, see https://docs.microsoft.com/rest/api/storageservices/get-file-properties.
func (FileURL) SetAccessControl ¶
func (f FileURL) SetAccessControl(ctx context.Context, permissions BlobFSAccessControl) (*PathUpdateResponse, error)
type Filesystem ¶
type Filesystem struct { Name *string `json:"name,omitempty"` LastModified *string `json:"lastModified,omitempty"` ETag *string `json:"eTag,omitempty"` }
Filesystem ...
type FilesystemCreateResponse ¶
type FilesystemCreateResponse struct {
// contains filtered or unexported fields
}
FilesystemCreateResponse ...
func (FilesystemCreateResponse) Date ¶
func (fcr FilesystemCreateResponse) Date() string
Date returns the value for header Date.
func (FilesystemCreateResponse) ETag ¶
func (fcr FilesystemCreateResponse) ETag() string
ETag returns the value for header ETag.
func (FilesystemCreateResponse) LastModified ¶
func (fcr FilesystemCreateResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (FilesystemCreateResponse) Response ¶
func (fcr FilesystemCreateResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (FilesystemCreateResponse) Status ¶
func (fcr FilesystemCreateResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (FilesystemCreateResponse) StatusCode ¶
func (fcr FilesystemCreateResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (FilesystemCreateResponse) XMsNamespaceEnabled ¶
func (fcr FilesystemCreateResponse) XMsNamespaceEnabled() string
XMsNamespaceEnabled returns the value for header x-ms-namespace-enabled.
func (FilesystemCreateResponse) XMsRequestID ¶
func (fcr FilesystemCreateResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (FilesystemCreateResponse) XMsVersion ¶
func (fcr FilesystemCreateResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type FilesystemDeleteResponse ¶
type FilesystemDeleteResponse struct {
// contains filtered or unexported fields
}
FilesystemDeleteResponse ...
func (FilesystemDeleteResponse) Date ¶
func (fdr FilesystemDeleteResponse) Date() string
Date returns the value for header Date.
func (FilesystemDeleteResponse) Response ¶
func (fdr FilesystemDeleteResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (FilesystemDeleteResponse) Status ¶
func (fdr FilesystemDeleteResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (FilesystemDeleteResponse) StatusCode ¶
func (fdr FilesystemDeleteResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (FilesystemDeleteResponse) XMsRequestID ¶
func (fdr FilesystemDeleteResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (FilesystemDeleteResponse) XMsVersion ¶
func (fdr FilesystemDeleteResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type FilesystemGetPropertiesResponse ¶
type FilesystemGetPropertiesResponse struct {
// contains filtered or unexported fields
}
FilesystemGetPropertiesResponse ...
func (FilesystemGetPropertiesResponse) Date ¶
func (fgpr FilesystemGetPropertiesResponse) Date() string
Date returns the value for header Date.
func (FilesystemGetPropertiesResponse) ETag ¶
func (fgpr FilesystemGetPropertiesResponse) ETag() string
ETag returns the value for header ETag.
func (FilesystemGetPropertiesResponse) LastModified ¶
func (fgpr FilesystemGetPropertiesResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (FilesystemGetPropertiesResponse) Response ¶
func (fgpr FilesystemGetPropertiesResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (FilesystemGetPropertiesResponse) Status ¶
func (fgpr FilesystemGetPropertiesResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (FilesystemGetPropertiesResponse) StatusCode ¶
func (fgpr FilesystemGetPropertiesResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (FilesystemGetPropertiesResponse) XMsNamespaceEnabled ¶
func (fgpr FilesystemGetPropertiesResponse) XMsNamespaceEnabled() string
XMsNamespaceEnabled returns the value for header x-ms-namespace-enabled.
func (FilesystemGetPropertiesResponse) XMsProperties ¶
func (fgpr FilesystemGetPropertiesResponse) XMsProperties() string
XMsProperties returns the value for header x-ms-properties.
func (FilesystemGetPropertiesResponse) XMsRequestID ¶
func (fgpr FilesystemGetPropertiesResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (FilesystemGetPropertiesResponse) XMsVersion ¶
func (fgpr FilesystemGetPropertiesResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type FilesystemList ¶
type FilesystemList struct { Filesystems []Filesystem `json:"filesystems,omitempty"` // contains filtered or unexported fields }
FilesystemList ...
func (FilesystemList) ContentType ¶
func (fl FilesystemList) ContentType() string
ContentType returns the value for header Content-Type.
func (FilesystemList) Date ¶
func (fl FilesystemList) Date() string
Date returns the value for header Date.
func (FilesystemList) Response ¶
func (fl FilesystemList) Response() *http.Response
Response returns the raw HTTP response object.
func (FilesystemList) Status ¶
func (fl FilesystemList) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (FilesystemList) StatusCode ¶
func (fl FilesystemList) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (FilesystemList) XMsContinuation ¶
func (fl FilesystemList) XMsContinuation() string
XMsContinuation returns the value for header x-ms-continuation.
func (FilesystemList) XMsRequestID ¶
func (fl FilesystemList) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (FilesystemList) XMsVersion ¶
func (fl FilesystemList) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type FilesystemSetPropertiesResponse ¶
type FilesystemSetPropertiesResponse struct {
// contains filtered or unexported fields
}
FilesystemSetPropertiesResponse ...
func (FilesystemSetPropertiesResponse) Date ¶
func (fspr FilesystemSetPropertiesResponse) Date() string
Date returns the value for header Date.
func (FilesystemSetPropertiesResponse) ETag ¶
func (fspr FilesystemSetPropertiesResponse) ETag() string
ETag returns the value for header ETag.
func (FilesystemSetPropertiesResponse) LastModified ¶
func (fspr FilesystemSetPropertiesResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (FilesystemSetPropertiesResponse) Response ¶
func (fspr FilesystemSetPropertiesResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (FilesystemSetPropertiesResponse) Status ¶
func (fspr FilesystemSetPropertiesResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (FilesystemSetPropertiesResponse) StatusCode ¶
func (fspr FilesystemSetPropertiesResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (FilesystemSetPropertiesResponse) XMsRequestID ¶
func (fspr FilesystemSetPropertiesResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (FilesystemSetPropertiesResponse) XMsVersion ¶
func (fspr FilesystemSetPropertiesResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type HTTPGetter ¶
HTTPGetter is a function type that refers to a method that performs an HTTP GET operation.
type HTTPGetterInfo ¶
type HTTPGetterInfo struct { // Offset specifies the start offset that should be used when // creating the HTTP GET request's Range header Offset int64 // Count specifies the count of bytes that should be used to calculate // the end offset when creating the HTTP GET request's Range header Count int64 // ETag specifies the resource's etag that should be used when creating // the HTTP GET request's If-Match header ETag string }
HTTPGetterInfo is passed to an HTTPGetter function passing it parameters that should be used to make an HTTP GET request.
type IPRange ¶
type IPRange struct { Start net.IP // Not specified if length = 0 End net.IP // Not specified if length = 0 }
IPRange represents a SAS IP range's start IP and (optionally) end IP.
type ListPathsFilesystemOptions ¶
type ListPathsFilesystemOptions struct { // Filters results to paths in this directory. Path *string // Whether or not to list recursively. Recursive bool // Whether or not AAD Object IDs will be converted to user principal name. UpnReturned *bool // The maximum number of items to return. MaxResults *int32 // The continuation token to resume listing. ContinuationToken *string }
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/list.
type Marker ¶ added in v10.13.33
type Marker struct {
Val *string
}
Marker represents an opaque value used in paged responses.
func (Marker) NotDone ¶ added in v10.13.33
NotDone returns true if the list enumeration should be started or is not yet complete. Specifically, NotDone returns true for a just-initialized (zero value) Marker indicating that you should make an initial request to get a result portion from the service. NotDone also returns true whenever the service returns an interim result portion. NotDone returns false only after the service has returned the final result portion.
type Metadata ¶ added in v10.13.33
func NewMetadata ¶ added in v10.13.33
NewMetadata returns user-defined key/value pairs.
type Path ¶
type Path struct { Name *string `json:"name,omitempty"` // begin manual edit to generated code IsDirectory *bool `json:"isDirectory,string,omitempty"` LastModified *string `json:"lastModified,omitempty"` ETag *string `json:"eTag,omitempty"` // begin manual edit to generated code ContentLength *int64 `json:"contentLength,string,omitempty"` // begin manual addition to generated code // TODO: // (a) How can we verify this will actually work with the JSON that the service will emit, when the service starts to do so? // (b) One day, consider converting this to use a custom type, that implements TextMarshaller, as has been done // for the XML-based responses in other SDKs. For now, the decoding from Base64 is up to the caller, and the name is chosen // to reflect that. ContentMD5Base64 *string `json:"contentMd5,string,omitempty"` Owner *string `json:"owner,omitempty"` Group *string `json:"group,omitempty"` Permissions *string `json:"permissions,omitempty"` }
Path ...
func (Path) ContentMD5 ¶
func (Path) LastModifiedTime ¶
type PathCreateResponse ¶
type PathCreateResponse struct {
// contains filtered or unexported fields
}
PathCreateResponse ...
func (PathCreateResponse) ContentLength ¶
func (pcr PathCreateResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (PathCreateResponse) Date ¶
func (pcr PathCreateResponse) Date() string
Date returns the value for header Date.
func (PathCreateResponse) ETag ¶
func (pcr PathCreateResponse) ETag() string
ETag returns the value for header ETag.
func (PathCreateResponse) LastModified ¶
func (pcr PathCreateResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (PathCreateResponse) Response ¶
func (pcr PathCreateResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (PathCreateResponse) Status ¶
func (pcr PathCreateResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (PathCreateResponse) StatusCode ¶
func (pcr PathCreateResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (PathCreateResponse) XMsContinuation ¶
func (pcr PathCreateResponse) XMsContinuation() string
XMsContinuation returns the value for header x-ms-continuation.
func (PathCreateResponse) XMsRequestID ¶
func (pcr PathCreateResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (PathCreateResponse) XMsVersion ¶
func (pcr PathCreateResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type PathDeleteResponse ¶
type PathDeleteResponse struct {
// contains filtered or unexported fields
}
PathDeleteResponse ...
func (PathDeleteResponse) Date ¶
func (pdr PathDeleteResponse) Date() string
Date returns the value for header Date.
func (PathDeleteResponse) Response ¶
func (pdr PathDeleteResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (PathDeleteResponse) Status ¶
func (pdr PathDeleteResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (PathDeleteResponse) StatusCode ¶
func (pdr PathDeleteResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (PathDeleteResponse) XMsContinuation ¶
func (pdr PathDeleteResponse) XMsContinuation() string
XMsContinuation returns the value for header x-ms-continuation.
func (PathDeleteResponse) XMsRequestID ¶
func (pdr PathDeleteResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (PathDeleteResponse) XMsVersion ¶
func (pdr PathDeleteResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type PathGetPropertiesActionType ¶
type PathGetPropertiesActionType string
PathGetPropertiesActionType enumerates the values for path get properties action type.
const ( // PathGetPropertiesActionGetAccessControl ... PathGetPropertiesActionGetAccessControl PathGetPropertiesActionType = "getAccessControl" // PathGetPropertiesActionGetStatus ... PathGetPropertiesActionGetStatus PathGetPropertiesActionType = "getStatus" // PathGetPropertiesActionNone represents an empty PathGetPropertiesActionType. PathGetPropertiesActionNone PathGetPropertiesActionType = "" )
func PossiblePathGetPropertiesActionTypeValues ¶
func PossiblePathGetPropertiesActionTypeValues() []PathGetPropertiesActionType
PossiblePathGetPropertiesActionTypeValues returns an array of possible values for the PathGetPropertiesActionType const type.
type PathGetPropertiesResponse ¶
type PathGetPropertiesResponse struct {
// contains filtered or unexported fields
}
PathGetPropertiesResponse ...
func (PathGetPropertiesResponse) AcceptRanges ¶
func (pgpr PathGetPropertiesResponse) AcceptRanges() string
AcceptRanges returns the value for header Accept-Ranges.
func (PathGetPropertiesResponse) CacheControl ¶
func (pgpr PathGetPropertiesResponse) CacheControl() string
CacheControl returns the value for header Cache-Control.
func (PathGetPropertiesResponse) ContentDisposition ¶
func (pgpr PathGetPropertiesResponse) ContentDisposition() string
ContentDisposition returns the value for header Content-Disposition.
func (PathGetPropertiesResponse) ContentEncoding ¶
func (pgpr PathGetPropertiesResponse) ContentEncoding() string
ContentEncoding returns the value for header Content-Encoding.
func (PathGetPropertiesResponse) ContentLanguage ¶
func (pgpr PathGetPropertiesResponse) ContentLanguage() string
ContentLanguage returns the value for header Content-Language.
func (PathGetPropertiesResponse) ContentLength ¶
func (pgpr PathGetPropertiesResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (PathGetPropertiesResponse) ContentMD5 ¶
func (pgpr PathGetPropertiesResponse) ContentMD5() []byte
ContentMD5 returns the value for header Content-MD5. begin manual edit to generated code
func (PathGetPropertiesResponse) ContentRange ¶
func (pgpr PathGetPropertiesResponse) ContentRange() string
ContentRange returns the value for header Content-Range.
func (PathGetPropertiesResponse) ContentType ¶
func (pgpr PathGetPropertiesResponse) ContentType() string
ContentType returns the value for header Content-Type.
func (PathGetPropertiesResponse) Date ¶
func (pgpr PathGetPropertiesResponse) Date() string
Date returns the value for header Date.
func (PathGetPropertiesResponse) ETag ¶
func (pgpr PathGetPropertiesResponse) ETag() string
ETag returns the value for header ETag.
func (PathGetPropertiesResponse) LastModified ¶
func (pgpr PathGetPropertiesResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (PathGetPropertiesResponse) NewMetadata ¶ added in v10.13.33
func (bgpr PathGetPropertiesResponse) NewMetadata() (Metadata, error)
NewMetadata returns user-defined key/value pairs.
func (PathGetPropertiesResponse) Response ¶
func (pgpr PathGetPropertiesResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (PathGetPropertiesResponse) Status ¶
func (pgpr PathGetPropertiesResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (PathGetPropertiesResponse) StatusCode ¶
func (pgpr PathGetPropertiesResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (PathGetPropertiesResponse) XMsACL ¶
func (pgpr PathGetPropertiesResponse) XMsACL() string
XMsACL returns the value for header x-ms-acl.
func (PathGetPropertiesResponse) XMsGroup ¶
func (pgpr PathGetPropertiesResponse) XMsGroup() string
XMsGroup returns the value for header x-ms-group.
func (PathGetPropertiesResponse) XMsLeaseDuration ¶
func (pgpr PathGetPropertiesResponse) XMsLeaseDuration() string
XMsLeaseDuration returns the value for header x-ms-lease-duration.
func (PathGetPropertiesResponse) XMsLeaseState ¶
func (pgpr PathGetPropertiesResponse) XMsLeaseState() string
XMsLeaseState returns the value for header x-ms-lease-state.
func (PathGetPropertiesResponse) XMsLeaseStatus ¶
func (pgpr PathGetPropertiesResponse) XMsLeaseStatus() string
XMsLeaseStatus returns the value for header x-ms-lease-status.
func (PathGetPropertiesResponse) XMsOwner ¶
func (pgpr PathGetPropertiesResponse) XMsOwner() string
XMsOwner returns the value for header x-ms-owner.
func (PathGetPropertiesResponse) XMsPermissions ¶
func (pgpr PathGetPropertiesResponse) XMsPermissions() string
XMsPermissions returns the value for header x-ms-permissions.
func (PathGetPropertiesResponse) XMsProperties ¶
func (pgpr PathGetPropertiesResponse) XMsProperties() string
XMsProperties returns the value for header x-ms-properties.
func (PathGetPropertiesResponse) XMsRequestID ¶
func (pgpr PathGetPropertiesResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (PathGetPropertiesResponse) XMsResourceType ¶
func (pgpr PathGetPropertiesResponse) XMsResourceType() string
XMsResourceType returns the value for header x-ms-resource-type.
func (PathGetPropertiesResponse) XMsVersion ¶
func (pgpr PathGetPropertiesResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type PathLeaseActionType ¶
type PathLeaseActionType string
PathLeaseActionType enumerates the values for path lease action type.
const ( // PathLeaseActionAcquire ... PathLeaseActionAcquire PathLeaseActionType = "acquire" // PathLeaseActionBreak ... PathLeaseActionBreak PathLeaseActionType = "break" // PathLeaseActionChange ... PathLeaseActionChange PathLeaseActionType = "change" // PathLeaseActionNone represents an empty PathLeaseActionType. PathLeaseActionNone PathLeaseActionType = "" // PathLeaseActionRelease ... PathLeaseActionRelease PathLeaseActionType = "release" // PathLeaseActionRenew ... PathLeaseActionRenew PathLeaseActionType = "renew" )
func PossiblePathLeaseActionTypeValues ¶
func PossiblePathLeaseActionTypeValues() []PathLeaseActionType
PossiblePathLeaseActionTypeValues returns an array of possible values for the PathLeaseActionType const type.
type PathLeaseResponse ¶
type PathLeaseResponse struct {
// contains filtered or unexported fields
}
PathLeaseResponse ...
func (PathLeaseResponse) Date ¶
func (plr PathLeaseResponse) Date() string
Date returns the value for header Date.
func (PathLeaseResponse) ETag ¶
func (plr PathLeaseResponse) ETag() string
ETag returns the value for header ETag.
func (PathLeaseResponse) LastModified ¶
func (plr PathLeaseResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (PathLeaseResponse) Response ¶
func (plr PathLeaseResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (PathLeaseResponse) Status ¶
func (plr PathLeaseResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (PathLeaseResponse) StatusCode ¶
func (plr PathLeaseResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (PathLeaseResponse) XMsLeaseID ¶
func (plr PathLeaseResponse) XMsLeaseID() string
XMsLeaseID returns the value for header x-ms-lease-id.
func (PathLeaseResponse) XMsLeaseTime ¶
func (plr PathLeaseResponse) XMsLeaseTime() string
XMsLeaseTime returns the value for header x-ms-lease-time.
func (PathLeaseResponse) XMsRequestID ¶
func (plr PathLeaseResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (PathLeaseResponse) XMsVersion ¶
func (plr PathLeaseResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type PathList ¶
type PathList struct { Paths []Path `json:"paths,omitempty"` // contains filtered or unexported fields }
PathList ...
func (PathList) LastModified ¶
LastModified returns the value for header Last-Modified.
func (PathList) StatusCode ¶
StatusCode returns the HTTP status code of the response, e.g. 200.
func (PathList) XMsContinuation ¶
XMsContinuation returns the value for header x-ms-continuation.
func (PathList) XMsRequestID ¶
XMsRequestID returns the value for header x-ms-request-id.
func (PathList) XMsVersion ¶
XMsVersion returns the value for header x-ms-version.
type PathRenameModeType ¶
type PathRenameModeType string
PathRenameModeType enumerates the values for path rename mode type.
const ( // PathRenameModeLegacy ... PathRenameModeLegacy PathRenameModeType = "legacy" // PathRenameModeNone represents an empty PathRenameModeType. PathRenameModeNone PathRenameModeType = "" // PathRenameModePosix ... PathRenameModePosix PathRenameModeType = "posix" )
func PossiblePathRenameModeTypeValues ¶
func PossiblePathRenameModeTypeValues() []PathRenameModeType
PossiblePathRenameModeTypeValues returns an array of possible values for the PathRenameModeType const type.
type PathResourceType ¶
type PathResourceType string
PathResourceType enumerates the values for path resource type.
const ( // PathResourceDirectory ... PathResourceDirectory PathResourceType = "directory" // PathResourceFile ... PathResourceFile PathResourceType = "file" // PathResourceNone represents an empty PathResourceType. PathResourceNone PathResourceType = "" )
func PossiblePathResourceTypeValues ¶
func PossiblePathResourceTypeValues() []PathResourceType
PossiblePathResourceTypeValues returns an array of possible values for the PathResourceType const type.
type PathUpdateActionType ¶
type PathUpdateActionType string
PathUpdateActionType enumerates the values for path update action type.
const ( // PathUpdateActionAppend ... PathUpdateActionAppend PathUpdateActionType = "append" // PathUpdateActionFlush ... PathUpdateActionFlush PathUpdateActionType = "flush" // PathUpdateActionNone represents an empty PathUpdateActionType. PathUpdateActionNone PathUpdateActionType = "" // PathUpdateActionSetAccessControl ... PathUpdateActionSetAccessControl PathUpdateActionType = "setAccessControl" // PathUpdateActionSetProperties ... PathUpdateActionSetProperties PathUpdateActionType = "setProperties" )
func PossiblePathUpdateActionTypeValues ¶
func PossiblePathUpdateActionTypeValues() []PathUpdateActionType
PossiblePathUpdateActionTypeValues returns an array of possible values for the PathUpdateActionType const type.
type PathUpdateResponse ¶
type PathUpdateResponse struct {
// contains filtered or unexported fields
}
PathUpdateResponse ...
func (PathUpdateResponse) AcceptRanges ¶
func (pur PathUpdateResponse) AcceptRanges() string
AcceptRanges returns the value for header Accept-Ranges.
func (PathUpdateResponse) CacheControl ¶
func (pur PathUpdateResponse) CacheControl() string
CacheControl returns the value for header Cache-Control.
func (PathUpdateResponse) ContentDisposition ¶
func (pur PathUpdateResponse) ContentDisposition() string
ContentDisposition returns the value for header Content-Disposition.
func (PathUpdateResponse) ContentEncoding ¶
func (pur PathUpdateResponse) ContentEncoding() string
ContentEncoding returns the value for header Content-Encoding.
func (PathUpdateResponse) ContentLanguage ¶
func (pur PathUpdateResponse) ContentLanguage() string
ContentLanguage returns the value for header Content-Language.
func (PathUpdateResponse) ContentLength ¶
func (pur PathUpdateResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (PathUpdateResponse) ContentRange ¶
func (pur PathUpdateResponse) ContentRange() string
ContentRange returns the value for header Content-Range.
func (PathUpdateResponse) ContentType ¶
func (pur PathUpdateResponse) ContentType() string
ContentType returns the value for header Content-Type.
func (PathUpdateResponse) Date ¶
func (pur PathUpdateResponse) Date() string
Date returns the value for header Date.
func (PathUpdateResponse) ETag ¶
func (pur PathUpdateResponse) ETag() string
ETag returns the value for header ETag.
func (PathUpdateResponse) LastModified ¶
func (pur PathUpdateResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (PathUpdateResponse) Response ¶
func (pur PathUpdateResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (PathUpdateResponse) Status ¶
func (pur PathUpdateResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (PathUpdateResponse) StatusCode ¶
func (pur PathUpdateResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (PathUpdateResponse) XMsProperties ¶
func (pur PathUpdateResponse) XMsProperties() string
XMsProperties returns the value for header x-ms-properties.
func (PathUpdateResponse) XMsRequestID ¶
func (pur PathUpdateResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (PathUpdateResponse) XMsVersion ¶
func (pur PathUpdateResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type PipelineOptions ¶
type PipelineOptions struct { // Log configures the pipeline's logging infrastructure indicating what information is logged and where. Log pipeline.LogOptions // Retry configures the built-in retry policy behavior. Retry RetryOptions // RequestLog configures the built-in request logging policy. RequestLog RequestLogOptions // Telemetry configures the built-in telemetry policy behavior. Telemetry TelemetryOptions // HTTPSender configures the sender of HTTP requests HTTPSender pipeline.Factory }
PipelineOptions is used to configure a request policy pipeline's retry policy and logging.
type ReadResponse ¶
type ReadResponse struct {
// contains filtered or unexported fields
}
ReadResponse - Wraps the response from the pathClient.Read method.
func (ReadResponse) AcceptRanges ¶
func (rr ReadResponse) AcceptRanges() string
AcceptRanges returns the value for header Accept-Ranges.
func (ReadResponse) Body ¶
func (rr ReadResponse) Body() io.ReadCloser
Body returns the raw HTTP response object's Body.
func (ReadResponse) CacheControl ¶
func (rr ReadResponse) CacheControl() string
CacheControl returns the value for header Cache-Control.
func (ReadResponse) ContentDisposition ¶
func (rr ReadResponse) ContentDisposition() string
ContentDisposition returns the value for header Content-Disposition.
func (ReadResponse) ContentEncoding ¶
func (rr ReadResponse) ContentEncoding() string
ContentEncoding returns the value for header Content-Encoding.
func (ReadResponse) ContentLanguage ¶
func (rr ReadResponse) ContentLanguage() string
ContentLanguage returns the value for header Content-Language.
func (ReadResponse) ContentLength ¶
func (rr ReadResponse) ContentLength() int64
ContentLength returns the value for header Content-Length.
func (ReadResponse) ContentMD5 ¶
func (rr ReadResponse) ContentMD5() string
ContentMD5 returns the value for header Content-MD5.
func (ReadResponse) ContentRange ¶
func (rr ReadResponse) ContentRange() string
ContentRange returns the value for header Content-Range.
func (ReadResponse) ContentType ¶
func (rr ReadResponse) ContentType() string
ContentType returns the value for header Content-Type.
func (ReadResponse) Date ¶
func (rr ReadResponse) Date() string
Date returns the value for header Date.
func (ReadResponse) ETag ¶
func (rr ReadResponse) ETag() string
ETag returns the value for header ETag.
func (ReadResponse) LastModified ¶
func (rr ReadResponse) LastModified() string
LastModified returns the value for header Last-Modified.
func (ReadResponse) Response ¶
func (rr ReadResponse) Response() *http.Response
Response returns the raw HTTP response object.
func (ReadResponse) Status ¶
func (rr ReadResponse) Status() string
Status returns the HTTP status message of the response, e.g. "200 OK".
func (ReadResponse) StatusCode ¶
func (rr ReadResponse) StatusCode() int
StatusCode returns the HTTP status code of the response, e.g. 200.
func (ReadResponse) XMsLeaseDuration ¶
func (rr ReadResponse) XMsLeaseDuration() string
XMsLeaseDuration returns the value for header x-ms-lease-duration.
func (ReadResponse) XMsLeaseState ¶
func (rr ReadResponse) XMsLeaseState() string
XMsLeaseState returns the value for header x-ms-lease-state.
func (ReadResponse) XMsLeaseStatus ¶
func (rr ReadResponse) XMsLeaseStatus() string
XMsLeaseStatus returns the value for header x-ms-lease-status.
func (ReadResponse) XMsProperties ¶
func (rr ReadResponse) XMsProperties() string
XMsProperties returns the value for header x-ms-properties.
func (ReadResponse) XMsRequestID ¶
func (rr ReadResponse) XMsRequestID() string
XMsRequestID returns the value for header x-ms-request-id.
func (ReadResponse) XMsResourceType ¶
func (rr ReadResponse) XMsResourceType() string
XMsResourceType returns the value for header x-ms-resource-type.
func (ReadResponse) XMsVersion ¶
func (rr ReadResponse) XMsVersion() string
XMsVersion returns the value for header x-ms-version.
type RenameDirectoryOptions ¶
type RenameDirectoryOptions struct { // The optional destination file system for the directory. DestinationFileSystem *string // The destination path for the directory. DestinationPath string // The new SAS for a destination Directory DestinationSas *string }
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
type RenameFileOptions ¶
type RenameFileOptions struct { // The optional destination file system for the file. DestinationFileSystem *string // The destination path for the file. DestinationPath string // The new SAS for a destination file DestinationSas *string }
For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
type RequestLogOptions ¶
type RequestLogOptions struct { // LogWarningIfTryOverThreshold logs a warning if a tried operation takes longer than the specified // duration (-1=no logging; 0=default threshold). LogWarningIfTryOverThreshold time.Duration // SyslogDisabled is a flag to check if logging to Syslog/Windows-Event-Logger is enabled or not // We by default print to Syslog/Windows-Event-Logger. // If SyslogDisabled is not provided explicitly, the default value will be false. SyslogDisabled bool }
RequestLogOptions configures the retry policy's behavior.
type ResponseError ¶
type ResponseError interface { // Error exposes the Error(), Temporary() and Timeout() methods. net.Error // Includes the Go error interface // Response returns the HTTP response. You may examine this but you should not modify it. Response() *http.Response }
ResponseError identifies a responder-generated network or response parsing error.
type RetryOptions ¶
type RetryOptions struct { // Policy tells the pipeline what kind of retry policy to use. See the RetryPolicy* constants.\ // A value of zero means that you accept our default policy. Policy RetryPolicy // MaxTries specifies the maximum number of attempts an operation will be tried before producing an error (0=default). // A value of zero means that you accept our default policy. A value of 1 means 1 try and no retries. MaxTries int32 // TryTimeout indicates the maximum time allowed for any single try of an HTTP request. // A value of zero means that you accept our default timeout. NOTE: When transferring large amounts // of data, the default TryTimeout will probably not be sufficient. You should override this value // based on the bandwidth available to the host machine and proximity to the Storage service. A good // starting point may be something like (60 seconds per MB of anticipated-payload-size). TryTimeout time.Duration // RetryDelay specifies the amount of delay to use before retrying an operation (0=default). // When RetryPolicy is specified as RetryPolicyExponential, the delay increases exponentially // with each retry up to a maximum specified by MaxRetryDelay. // If you specify 0, then you must also specify 0 for MaxRetryDelay. // If you specify RetryDelay, then you must also specify MaxRetryDelay, and MaxRetryDelay should be // equal to or greater than RetryDelay. RetryDelay time.Duration // MaxRetryDelay specifies the maximum delay allowed before retrying an operation (0=default). // If you specify 0, then you must also specify 0 for RetryDelay. MaxRetryDelay time.Duration }
RetryOptions configures the retry policy's behavior.
type RetryPolicy ¶
type RetryPolicy int32
RetryPolicy tells the pipeline what kind of retry policy to use. See the RetryPolicy* constants.
const ( // RetryPolicyExponential tells the pipeline to use an exponential back-off retry policy RetryPolicyExponential RetryPolicy = 0 // RetryPolicyFixed tells the pipeline to use a fixed back-off retry policy RetryPolicyFixed RetryPolicy = 1 )
type RetryReaderOptions ¶
type RetryReaderOptions struct { // MaxRetryRequests specifies the maximum number of HTTP GET requests that will be made // while reading from a RetryReader. A value of zero means that no additional HTTP // GET requests will be made. MaxRetryRequests int // NotifyFailedRead is called, if non-nil, after any failure to read. Expected usage is diagnostic logging. NotifyFailedRead FailedReadNotifier // TreatEarlyCloseAsError can be set to true to prevent retries after "read on closed response body". By default, // retryReader has the following special behaviour: closing the response body before it is all read is treated as a // retryable error. This is to allow callers to force a retry by closing the body from another goroutine (e.g. if the = // read is too slow, caller may want to force a retry in the hope that the retry will be quicker). If // TreatEarlyCloseAsError is true, then retryReader's special behaviour is suppressed, and "read on closed body" is instead // treated as a fatal (non-retryable) error. // Note that setting TreatEarlyCloseAsError only guarantees that Closing will produce a fatal error if the Close happens // from the same "thread" (goroutine) as Read. Concurrent Close calls from other goroutines may instead produce network errors // which will be retried. TreatEarlyCloseAsError bool // contains filtered or unexported fields }
RetryReaderOptions contains properties which can help to decide when to do retry.
type SASProtocol ¶
type SASProtocol string
const ( // SASProtocolHTTPS can be specified for a SAS protocol SASProtocolHTTPS SASProtocol = "https" // SASProtocolHTTPSandHTTP can be specified for a SAS protocol SASProtocolHTTPSandHTTP SASProtocol = "https,http" )
type SASQueryParameters ¶
type SASQueryParameters struct {
// contains filtered or unexported fields
}
A SASQueryParameters object represents the components that make up an Azure Storage SAS' query parameters. You parse a map of query parameters into its fields by calling NewSASQueryParameters(). You add the components to a query parameter map by calling AddToValues(). NOTE: Changing any field requires computing a new SAS signature using a XxxSASSignatureValues type.
This type defines the components used by all Azure Storage resources (Containers, Blobs, Files, & Queues).
func GetSasQueryParams ¶
func GetSasQueryParams(sas string) SASQueryParameters
func (*SASQueryParameters) CacheControl ¶
func (p *SASQueryParameters) CacheControl() string
func (*SASQueryParameters) ContentDisposition ¶
func (p *SASQueryParameters) ContentDisposition() string
func (*SASQueryParameters) ContentEncoding ¶
func (p *SASQueryParameters) ContentEncoding() string
func (*SASQueryParameters) ContentLanguage ¶
func (p *SASQueryParameters) ContentLanguage() string
func (*SASQueryParameters) ContentType ¶
func (p *SASQueryParameters) ContentType() string
func (*SASQueryParameters) Encode ¶
func (p *SASQueryParameters) Encode() string
Encode encodes the SAS query parameters into URL encoded form sorted by key.
func (*SASQueryParameters) ExpiryTime ¶
func (p *SASQueryParameters) ExpiryTime() time.Time
func (*SASQueryParameters) IPRange ¶
func (p *SASQueryParameters) IPRange() IPRange
func (*SASQueryParameters) Identifier ¶
func (p *SASQueryParameters) Identifier() string
func (*SASQueryParameters) Permissions ¶
func (p *SASQueryParameters) Permissions() string
func (*SASQueryParameters) Protocol ¶
func (p *SASQueryParameters) Protocol() SASProtocol
func (*SASQueryParameters) Resource ¶
func (p *SASQueryParameters) Resource() string
func (*SASQueryParameters) ResourceTypes ¶
func (p *SASQueryParameters) ResourceTypes() string
func (*SASQueryParameters) Services ¶
func (p *SASQueryParameters) Services() string
func (*SASQueryParameters) Signature ¶
func (p *SASQueryParameters) Signature() string
func (*SASQueryParameters) StartTime ¶
func (p *SASQueryParameters) StartTime() time.Time
func (*SASQueryParameters) Version ¶
func (p *SASQueryParameters) Version() string
type ServiceCodeType ¶
type ServiceCodeType string
ServiceCodeType is a string identifying a storage service error. For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/status-and-error-codes2
const ( // ServiceCodeNone is the default value. It indicates that the error was related to the service or that the service didn't return a code. ServiceCodeNone ServiceCodeType = "" // ServiceCodeAccountAlreadyExists means the specified account already exists. ServiceCodeAccountAlreadyExists ServiceCodeType = "AccountAlreadyExists" // ServiceCodeAccountBeingCreated means the specified account is in the process of being created (403). ServiceCodeAccountBeingCreated ServiceCodeType = "AccountBeingCreated" // ServiceCodeAccountIsDisabled means the specified account is disabled (403). ServiceCodeAccountIsDisabled ServiceCodeType = "AccountIsDisabled" // ServiceCodeAuthenticationFailed means the server failed to authenticate the request. Make sure the value of the Authorization header is formed correctly including the signature (403). ServiceCodeAuthenticationFailed ServiceCodeType = "AuthenticationFailed" // ServiceCodeConditionHeadersNotSupported means the condition headers are not supported (400). ServiceCodeConditionHeadersNotSupported ServiceCodeType = "ConditionHeadersNotSupported" // ServiceCodeConditionNotMet means the condition specified in the conditional header(s) was not met for a read/write operation (304/412). ServiceCodeConditionNotMet ServiceCodeType = "ConditionNotMet" // ServiceCodeEmptyMetadataKey means the key for one of the metadata key-value pairs is empty (400). ServiceCodeEmptyMetadataKey ServiceCodeType = "EmptyMetadataKey" // ServiceCodeInsufficientAccountPermissions means read operations are currently disabled or Write operations are not allowed or The account being accessed does not have sufficient permissions to execute this operation (403). ServiceCodeInsufficientAccountPermissions ServiceCodeType = "InsufficientAccountPermissions" // ServiceCodeInternalError means the server encountered an internal error. Please retry the request (500). ServiceCodeInternalError ServiceCodeType = "InternalError" // ServiceCodeInvalidAuthenticationInfo means the authentication information was not provided in the correct format. Verify the value of Authorization header (400). ServiceCodeInvalidAuthenticationInfo ServiceCodeType = "InvalidAuthenticationInfo" // ServiceCodeInvalidHeaderValue means the value provided for one of the HTTP headers was not in the correct format (400). ServiceCodeInvalidHeaderValue ServiceCodeType = "InvalidHeaderValue" // ServiceCodeInvalidHTTPVerb means the HTTP verb specified was not recognized by the server (400). ServiceCodeInvalidHTTPVerb ServiceCodeType = "InvalidHttpVerb" // ServiceCodeInvalidInput means one of the request inputs is not valid (400). ServiceCodeInvalidInput ServiceCodeType = "InvalidInput" // ServiceCodeInvalidMd5 means the MD5 value specified in the request is invalid. The MD5 value must be 128 bits and Base64-encoded (400). ServiceCodeInvalidMd5 ServiceCodeType = "InvalidMd5" // ServiceCodeInvalidMetadata means the specified metadata is invalid. It includes characters that are not permitted (400). ServiceCodeInvalidMetadata ServiceCodeType = "InvalidMetadata" // ServiceCodeInvalidQueryParameterValue means an invalid value was specified for one of the query parameters in the request URI (400). ServiceCodeInvalidQueryParameterValue ServiceCodeType = "InvalidQueryParameterValue" // ServiceCodeInvalidRange means the range specified is invalid for the current size of the resource (416). ServiceCodeInvalidRange ServiceCodeType = "InvalidRange" // ServiceCodeInvalidResourceName means the specified resource name contains invalid characters (400). ServiceCodeInvalidResourceName ServiceCodeType = "InvalidResourceName" // ServiceCodeInvalidURI means the requested URI does not represent any resource on the server (400). ServiceCodeInvalidURI ServiceCodeType = "InvalidUri" // ServiceCodeInvalidXMLDocument means the specified XML is not syntactically valid (400). ServiceCodeInvalidXMLDocument ServiceCodeType = "InvalidXmlDocument" // ServiceCodeInvalidXMLNodeValue means the value provided for one of the XML nodes in the request body was not in the correct format (400). ServiceCodeInvalidXMLNodeValue ServiceCodeType = "InvalidXmlNodeValue" // ServiceCodeMd5Mismatch means the MD5 value specified in the request did not match the MD5 value calculated by the server (400). ServiceCodeMd5Mismatch ServiceCodeType = "Md5Mismatch" // ServiceCodeMetadataTooLarge means the size of the specified metadata exceeds the maximum size permitted (400). ServiceCodeMetadataTooLarge ServiceCodeType = "MetadataTooLarge" // ServiceCodeMissingContentLengthHeader means the Content-Length header was not specified (411). ServiceCodeMissingContentLengthHeader ServiceCodeType = "MissingContentLengthHeader" // ServiceCodeMissingRequiredQueryParameter means a required query parameter was not specified for this request (400). ServiceCodeMissingRequiredQueryParameter ServiceCodeType = "MissingRequiredQueryParameter" // ServiceCodeMissingRequiredHeader means a required HTTP header was not specified (400). ServiceCodeMissingRequiredHeader ServiceCodeType = "MissingRequiredHeader" // ServiceCodeMissingRequiredXMLNode means a required XML node was not specified in the request body (400). ServiceCodeMissingRequiredXMLNode ServiceCodeType = "MissingRequiredXmlNode" // ServiceCodeMultipleConditionHeadersNotSupported means multiple condition headers are not supported (400). ServiceCodeMultipleConditionHeadersNotSupported ServiceCodeType = "MultipleConditionHeadersNotSupported" // ServiceCodeOperationTimedOut means the operation could not be completed within the permitted time (500). ServiceCodeOperationTimedOut ServiceCodeType = "OperationTimedOut" // ServiceCodeOutOfRangeInput means one of the request inputs is out of range (400). ServiceCodeOutOfRangeInput ServiceCodeType = "OutOfRangeInput" // ServiceCodeOutOfRangeQueryParameterValue means a query parameter specified in the request URI is outside the permissible range (400). ServiceCodeOutOfRangeQueryParameterValue ServiceCodeType = "OutOfRangeQueryParameterValue" /// ServiceCodePathAlreadyExists means that the path (e.g. when trying to create a directory) already exists ServiceCodePathAlreadyExists ServiceCodeType = "PathAlreadyExists" // ServiceCodePathNotFound means the specified path does not exist (404). ServiceCodePathNotFound ServiceCodeType = "PathNotFound" // ServiceCodeRequestBodyTooLarge means the size of the request body exceeds the maximum size permitted (413). ServiceCodeRequestBodyTooLarge ServiceCodeType = "RequestBodyTooLarge" // ServiceCodeResourceTypeMismatch means the specified resource type does not match the type of the existing resource (409). ServiceCodeResourceTypeMismatch ServiceCodeType = "ResourceTypeMismatch" // ServiceCodeRequestURLFailedToParse means the url in the request could not be parsed (400). ServiceCodeRequestURLFailedToParse ServiceCodeType = "RequestUrlFailedToParse" // ServiceCodeResourceAlreadyExists means the specified resource already exists (409). ServiceCodeResourceAlreadyExists ServiceCodeType = "ResourceAlreadyExists" // ServiceCodeFileSystemAlreadyExists means the specified file system already exists (409). ServiceCodeFileSystemAlreadyExists ServiceCodeType = "FilesystemAlreadyExists" // ServiceCodeResourceNotFound means the specified resource does not exist (404). ServiceCodeResourceNotFound ServiceCodeType = "ResourceNotFound" // ServiceCodeSourcePathNotFound means the specified path does not exist (404). ServiceCodeSourcePathNotFound ServiceCodeType = "SourcePathNotFound" // ServiceCodeServerBusy means the server is currently unable to receive requests. Please retry your request or Ingress/egress is over the account limit or operations per second is over the account limit (503). ServiceCodeServerBusy ServiceCodeType = "ServerBusy" // ServiceCodeUnsupportedHeader means one of the HTTP headers specified in the request is not supported (400). ServiceCodeUnsupportedHeader ServiceCodeType = "UnsupportedHeader" // ServiceCodeUnsupportedXMLNode means one of the XML nodes specified in the request body is not supported (400). ServiceCodeUnsupportedXMLNode ServiceCodeType = "UnsupportedXmlNode" // ServiceCodeUnsupportedQueryParameter means one of the query parameters specified in the request URI is not supported (400). ServiceCodeUnsupportedQueryParameter ServiceCodeType = "UnsupportedQueryParameter" // ServiceCodeUnsupportedHTTPVerb means the resource doesn't support the specified HTTP verb (405). ServiceCodeUnsupportedHTTPVerb ServiceCodeType = "UnsupportedHttpVerb" )
type ServiceURL ¶
type ServiceURL struct {
// contains filtered or unexported fields
}
A ServiceURL represents a URL to the Azure Storage File service allowing you to manipulate file shares.
func NewServiceURL ¶
func NewServiceURL(url url.URL, p pipeline.Pipeline) ServiceURL
NewServiceURL creates a ServiceURL object using the specified URL and request policy pipeline.
func (ServiceURL) ListFilesystemsSegment ¶
func (s ServiceURL) ListFilesystemsSegment(ctx context.Context, marker *string) (*FilesystemList, error)
func (ServiceURL) NewFileSystemURL ¶
func (s ServiceURL) NewFileSystemURL(fileSystemName string) FileSystemURL
NewFileSystemURL creates a new ShareURL object by concatenating shareName to the end of ServiceURL's URL. The new ShareURL uses the same request policy pipeline as the ServiceURL. To change the pipeline, create the ShareURL and then call its WithPipeline method passing in the desired pipeline object. Or, call this package's NewFileSystemURL instead of calling this object's NewFileSystemURL method.
func (ServiceURL) URL ¶
func (s ServiceURL) URL() url.URL
URL returns the URL endpoint used by the ServiceURL object.
func (ServiceURL) WithPipeline ¶
func (s ServiceURL) WithPipeline(p pipeline.Pipeline) ServiceURL
WithPipeline creates a new ServiceURL object identical to the source but with the specified request policy pipeline.
type SharedKeyCredential ¶
type SharedKeyCredential struct {
// contains filtered or unexported fields
}
SharedKeyCredential contains an account's name and its primary or secondary key. It is immutable making it shareable and goroutine-safe.
func NewSharedKeyCredential ¶
func NewSharedKeyCredential(accountName, accountKey string) *SharedKeyCredential
NewSharedKeyCredential creates an immutable SharedKeyCredential containing the storage account's name and either its primary or secondary key.
func (SharedKeyCredential) AccountName ¶
func (f SharedKeyCredential) AccountName() string
AccountName returns the Storage account's name.
func (*SharedKeyCredential) ComputeHMACSHA256 ¶
func (f *SharedKeyCredential) ComputeHMACSHA256(message string) (base64String string)
ComputeHMACSHA256 generates a hash signature for an HTTP request or for a SAS.
func (*SharedKeyCredential) New ¶
func (f *SharedKeyCredential) New(next pipeline.Policy, po *pipeline.PolicyOptions) pipeline.Policy
New creates a credential policy object.
type StorageError ¶
type StorageError interface { // ResponseError implements error's Error(), net.Error's Temporary() and Timeout() methods & Response(). ResponseError // ServiceCode returns a service error code. Your code can use this to make error recovery decisions. ServiceCode() ServiceCodeType }
StorageError identifies a responder-generated network or response parsing error.
type TelemetryOptions ¶
type TelemetryOptions struct { // Value is a string prepended to each request's User-Agent and sent to the service. // The service records the user-agent in logs for diagnostics and tracking of client requests. Value string }
TelemetryOptions configures the telemetry policy's behavior.
type TokenCredential ¶
type TokenCredential interface { Credential Token() string SetToken(newToken string) }
TokenCredential represents a token credential (which is also a pipeline.Factory).
func NewTokenCredential ¶
func NewTokenCredential(initialToken string, tokenRefresher func(credential TokenCredential) time.Duration) TokenCredential
NewTokenCredential creates a token credential for use with role-based access control (RBAC) access to Azure Storage resources. You initialize the TokenCredential with an initial token value. If you pass a non-nil value for tokenRefresher, then the function you pass will be called immediately (so it can refresh and change the TokenCredential's token value by calling SetToken; your tokenRefresher function must return a time.Duration indicating how long the TokenCredential object should wait before calling your tokenRefresher function again.
Source Files ¶
- datalake_storage_transforms.go
- parsing_urls.go
- path_extensions.go
- url_directory.go
- url_file.go
- url_filesystem.go
- url_service.go
- version.go
- zc_credential_anonymous.go
- zc_credential_shared_key.go
- zc_credential_token.go
- zc_directoryRequestOptions.go
- zc_fileRequestOptions.go
- zc_filesystemRequestOptions.go
- zc_mmf_unix.go
- zc_pipeline.go
- zc_policy_request_log.go
- zc_policy_retry.go
- zc_policy_telemetry.go
- zc_policy_unique_request_id.go
- zc_retry_reader.go
- zc_sas_account.go
- zc_sas_query_params.go
- zc_service_codes_common.go
- zc_storage_error.go
- zc_util_validate.go
- zc_uuid.go
- zz_generated_client.go
- zz_generated_filesystem.go
- zz_generated_models.go
- zz_generated_path.go
- zz_generated_responder_policy.go
- zz_generated_response_error.go
- zz_generated_validation.go
- zz_generated_version.go
- zz_response_model.go