azbfs

package
v10.0.2+incompatible Latest Latest
Warning

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

Go to latest
Published: Sep 28, 2018 License: MIT Imports: 27 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// CountToEnd indiciates a flag for count parameter. It means the count of bytes
	// from start offset to the end of file.
	CountToEnd = 0
)
View Source
const (
	// ServiceVersion specifies the version of the operations used in this package.
	ServiceVersion = "2018-03-28"
)

Variables

This section is empty.

Functions

func NewPipeline

func NewPipeline(c Credential, o PipelineOptions) pipeline.Pipeline

NewPipeline creates a Pipeline using the specified credentials and options.

func NewRequestLogPolicyFactory

func NewRequestLogPolicyFactory(o RequestLogOptions) pipeline.Factory

NewRequestLogPolicyFactory creates a RequestLogPolicyFactory object configured using the specified options.

func NewResponseError

func NewResponseError(cause error, response *http.Response, description string) error

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

func NewUniqueRequestIDPolicyFactory() pipeline.Factory

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 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
	// 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 CreateFilesystemResponse

type CreateFilesystemResponse struct {
	// contains filtered or unexported fields
}

CreateFilesystemResponse ...

func (CreateFilesystemResponse) Date

func (cfr CreateFilesystemResponse) Date() string

Date returns the value for header Date.

func (CreateFilesystemResponse) ETag

func (cfr CreateFilesystemResponse) ETag() string

ETag returns the value for header ETag.

func (CreateFilesystemResponse) LastModified

func (cfr CreateFilesystemResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (CreateFilesystemResponse) Response

func (cfr CreateFilesystemResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (CreateFilesystemResponse) Status

func (cfr CreateFilesystemResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (CreateFilesystemResponse) StatusCode

func (cfr CreateFilesystemResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (CreateFilesystemResponse) XMsNamespaceEnabled

func (cfr CreateFilesystemResponse) XMsNamespaceEnabled() string

XMsNamespaceEnabled returns the value for header x-ms-namespace-enabled.

func (CreateFilesystemResponse) XMsRequestID

func (cfr CreateFilesystemResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (CreateFilesystemResponse) XMsVersion

func (cfr CreateFilesystemResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type CreatePathResponse

type CreatePathResponse struct {
	// contains filtered or unexported fields
}

CreatePathResponse ...

func (CreatePathResponse) ContentLength

func (cpr CreatePathResponse) ContentLength() string

ContentLength returns the value for header Content-Length.

func (CreatePathResponse) Date

func (cpr CreatePathResponse) Date() string

Date returns the value for header Date.

func (CreatePathResponse) ETag

func (cpr CreatePathResponse) ETag() string

ETag returns the value for header ETag.

func (CreatePathResponse) LastModified

func (cpr CreatePathResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (CreatePathResponse) Response

func (cpr CreatePathResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (CreatePathResponse) Status

func (cpr CreatePathResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (CreatePathResponse) StatusCode

func (cpr CreatePathResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (CreatePathResponse) XMsContinuation

func (cpr CreatePathResponse) XMsContinuation() string

XMsContinuation returns the value for header x-ms-continuation.

func (CreatePathResponse) XMsRequestID

func (cpr CreatePathResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (CreatePathResponse) XMsVersion

func (cpr CreatePathResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type Credential

type Credential interface {
	pipeline.Factory
	// contains filtered or unexported methods
}

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 DeleteFilesystemResponse

type DeleteFilesystemResponse struct {
	// contains filtered or unexported fields
}

DeleteFilesystemResponse ...

func (DeleteFilesystemResponse) Date

func (dfr DeleteFilesystemResponse) Date() string

Date returns the value for header Date.

func (DeleteFilesystemResponse) Response

func (dfr DeleteFilesystemResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (DeleteFilesystemResponse) Status

func (dfr DeleteFilesystemResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (DeleteFilesystemResponse) StatusCode

func (dfr DeleteFilesystemResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (DeleteFilesystemResponse) XMsRequestID

func (dfr DeleteFilesystemResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (DeleteFilesystemResponse) XMsVersion

func (dfr DeleteFilesystemResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type DeletePathResponse

type DeletePathResponse struct {
	// contains filtered or unexported fields
}

DeletePathResponse ...

func (DeletePathResponse) Date

func (dpr DeletePathResponse) Date() string

Date returns the value for header Date.

func (DeletePathResponse) Response

func (dpr DeletePathResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (DeletePathResponse) Status

func (dpr DeletePathResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (DeletePathResponse) StatusCode

func (dpr DeletePathResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (DeletePathResponse) XMsContinuation

func (dpr DeletePathResponse) XMsContinuation() string

XMsContinuation returns the value for header x-ms-continuation.

func (DeletePathResponse) XMsRequestID

func (dpr DeletePathResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (DeletePathResponse) XMsVersion

func (dpr DeletePathResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type DirectoryCreateResponse

type DirectoryCreateResponse CreatePathResponse

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() string

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 DeletePathResponse

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 GetPathPropertiesResponse

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() string

ContentLength returns the value for header Content-Length.

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

Date returns the value for header Date.

func (DirectoryGetPropertiesResponse) ETag

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) 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 ListSchema

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() []ListEntrySchema

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() []ListEntrySchema

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

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) GetProperties

GetProperties returns the directory's metadata and system properties.

func (DirectoryURL) IsDirectory

func (d DirectoryURL) IsDirectory(ctx context.Context) bool

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) ListDirectorySegment

func (d DirectoryURL) ListDirectorySegment(ctx context.Context, marker *string, 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) 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

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() string

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 ErrorSchema

type ErrorSchema struct {
	// Error - The service error response object.
	Error *ErrorSchemaError `json:"error,omitempty"`
}

ErrorSchema ...

type ErrorSchemaError

type ErrorSchemaError struct {
	// Code - The service error code.
	Code *string `json:"code,omitempty"`
	// Message - The service error message.
	Message *string `json:"message,omitempty"`
}

ErrorSchemaError - The service error response object.

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

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

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) GetProperties

GetProperties returns all user-defined metadata and system properties for the specified file system or file system snapshot.

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) 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

func NewFileURL(url url.URL, p pipeline.Pipeline) FileURL

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) (*UpdatePathResponse, error)

UploadRange writes bytes to a file. offset indiciates the offset at which to begin writing, in bytes.

func (FileURL) Create

func (f FileURL) Create(ctx context.Context) (*CreatePathResponse, 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/create-file.

func (FileURL) Delete

func (f FileURL) Delete(ctx context.Context) (*DeletePathResponse, 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) (*UpdatePathResponse, error)

flushes writes previously uploaded data to a file

func (FileURL) GetProperties

func (f FileURL) GetProperties(ctx context.Context) (*GetPathPropertiesResponse, 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) String

func (f FileURL) String() string

String returns the URL as a string.

func (FileURL) URL

func (f FileURL) URL() url.URL

URL returns the URL endpoint used by the FileURL object.

func (FileURL) WithPipeline

func (f FileURL) WithPipeline(p pipeline.Pipeline) FileURL

WithPipeline creates a new FileURL object identical to the source but with the specified request policy pipeline.

type GetFilesystemPropertiesResponse

type GetFilesystemPropertiesResponse struct {
	// contains filtered or unexported fields
}

GetFilesystemPropertiesResponse ...

func (GetFilesystemPropertiesResponse) Date

Date returns the value for header Date.

func (GetFilesystemPropertiesResponse) ETag

ETag returns the value for header ETag.

func (GetFilesystemPropertiesResponse) LastModified

func (gfpr GetFilesystemPropertiesResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (GetFilesystemPropertiesResponse) Response

Response returns the raw HTTP response object.

func (GetFilesystemPropertiesResponse) Status

Status returns the HTTP status message of the response, e.g. "200 OK".

func (GetFilesystemPropertiesResponse) StatusCode

func (gfpr GetFilesystemPropertiesResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (GetFilesystemPropertiesResponse) XMsNamespaceEnabled

func (gfpr GetFilesystemPropertiesResponse) XMsNamespaceEnabled() string

XMsNamespaceEnabled returns the value for header x-ms-namespace-enabled.

func (GetFilesystemPropertiesResponse) XMsProperties

func (gfpr GetFilesystemPropertiesResponse) XMsProperties() string

XMsProperties returns the value for header x-ms-properties.

func (GetFilesystemPropertiesResponse) XMsRequestID

func (gfpr GetFilesystemPropertiesResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (GetFilesystemPropertiesResponse) XMsVersion

func (gfpr GetFilesystemPropertiesResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type GetPathPropertiesResponse

type GetPathPropertiesResponse struct {
	// contains filtered or unexported fields
}

GetPathPropertiesResponse ...

func (GetPathPropertiesResponse) AcceptRanges

func (gppr GetPathPropertiesResponse) AcceptRanges() string

AcceptRanges returns the value for header Accept-Ranges.

func (GetPathPropertiesResponse) CacheControl

func (gppr GetPathPropertiesResponse) CacheControl() string

CacheControl returns the value for header Cache-Control.

func (GetPathPropertiesResponse) ContentDisposition

func (gppr GetPathPropertiesResponse) ContentDisposition() string

ContentDisposition returns the value for header Content-Disposition.

func (GetPathPropertiesResponse) ContentEncoding

func (gppr GetPathPropertiesResponse) ContentEncoding() string

ContentEncoding returns the value for header Content-Encoding.

func (GetPathPropertiesResponse) ContentLanguage

func (gppr GetPathPropertiesResponse) ContentLanguage() string

ContentLanguage returns the value for header Content-Language.

func (GetPathPropertiesResponse) ContentLength

func (gppr GetPathPropertiesResponse) ContentLength() string

ContentLength returns the value for header Content-Length.

func (GetPathPropertiesResponse) ContentRange

func (gppr GetPathPropertiesResponse) ContentRange() string

ContentRange returns the value for header Content-Range.

func (GetPathPropertiesResponse) ContentType

func (gppr GetPathPropertiesResponse) ContentType() string

ContentType returns the value for header Content-Type.

func (GetPathPropertiesResponse) Date

func (gppr GetPathPropertiesResponse) Date() string

Date returns the value for header Date.

func (GetPathPropertiesResponse) ETag

func (gppr GetPathPropertiesResponse) ETag() string

ETag returns the value for header ETag.

func (GetPathPropertiesResponse) LastModified

func (gppr GetPathPropertiesResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (GetPathPropertiesResponse) Response

func (gppr GetPathPropertiesResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (GetPathPropertiesResponse) Status

func (gppr GetPathPropertiesResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (GetPathPropertiesResponse) StatusCode

func (gppr GetPathPropertiesResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (GetPathPropertiesResponse) XMsACL

func (gppr GetPathPropertiesResponse) XMsACL() string

XMsACL returns the value for header x-ms-acl.

func (GetPathPropertiesResponse) XMsGroup

func (gppr GetPathPropertiesResponse) XMsGroup() string

XMsGroup returns the value for header x-ms-group.

func (GetPathPropertiesResponse) XMsLeaseDuration

func (gppr GetPathPropertiesResponse) XMsLeaseDuration() string

XMsLeaseDuration returns the value for header x-ms-lease-duration.

func (GetPathPropertiesResponse) XMsLeaseState

func (gppr GetPathPropertiesResponse) XMsLeaseState() string

XMsLeaseState returns the value for header x-ms-lease-state.

func (GetPathPropertiesResponse) XMsLeaseStatus

func (gppr GetPathPropertiesResponse) XMsLeaseStatus() string

XMsLeaseStatus returns the value for header x-ms-lease-status.

func (GetPathPropertiesResponse) XMsOwner

func (gppr GetPathPropertiesResponse) XMsOwner() string

XMsOwner returns the value for header x-ms-owner.

func (GetPathPropertiesResponse) XMsPermissions

func (gppr GetPathPropertiesResponse) XMsPermissions() string

XMsPermissions returns the value for header x-ms-permissions.

func (GetPathPropertiesResponse) XMsProperties

func (gppr GetPathPropertiesResponse) XMsProperties() string

XMsProperties returns the value for header x-ms-properties.

func (GetPathPropertiesResponse) XMsRequestID

func (gppr GetPathPropertiesResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (GetPathPropertiesResponse) XMsResourceType

func (gppr GetPathPropertiesResponse) XMsResourceType() string

XMsResourceType returns the value for header x-ms-resource-type.

func (GetPathPropertiesResponse) XMsVersion

func (gppr GetPathPropertiesResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type HTTPGetter

type HTTPGetter func(ctx context.Context, i HTTPGetterInfo) (*http.Response, error)

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 LeasePathResponse

type LeasePathResponse struct {
	// contains filtered or unexported fields
}

LeasePathResponse ...

func (LeasePathResponse) Date

func (lpr LeasePathResponse) Date() string

Date returns the value for header Date.

func (LeasePathResponse) ETag

func (lpr LeasePathResponse) ETag() string

ETag returns the value for header ETag.

func (LeasePathResponse) LastModified

func (lpr LeasePathResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (LeasePathResponse) Response

func (lpr LeasePathResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (LeasePathResponse) Status

func (lpr LeasePathResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (LeasePathResponse) StatusCode

func (lpr LeasePathResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (LeasePathResponse) XMsLeaseID

func (lpr LeasePathResponse) XMsLeaseID() string

XMsLeaseID returns the value for header x-ms-lease-id.

func (LeasePathResponse) XMsLeaseTime

func (lpr LeasePathResponse) XMsLeaseTime() string

XMsLeaseTime returns the value for header x-ms-lease-time.

func (LeasePathResponse) XMsRequestID

func (lpr LeasePathResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (LeasePathResponse) XMsVersion

func (lpr LeasePathResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type ListEntrySchema

type ListEntrySchema struct {
	Name          *string `json:"name,omitempty"`
	IsDirectory   *bool   `json:"isDirectory,string,omitempty"`
	LastModified  *string `json:"lastModified,omitempty"`
	ETag          *string `json:"eTag,omitempty"`
	ContentLength *int64  `json:"contentLength,string,omitempty"`
	Owner         *string `json:"owner,omitempty"`
	Group         *string `json:"group,omitempty"`
	Permissions   *string `json:"permissions,omitempty"`
}

ListEntrySchema ...

type ListFilesystemEntry

type ListFilesystemEntry struct {
	Name         *string `json:"name,omitempty"`
	LastModified *string `json:"lastModified,omitempty"`
	ETag         *string `json:"eTag,omitempty"`
}

ListFilesystemEntry ...

type ListFilesystemSchema

type ListFilesystemSchema struct {
	Filesystems []ListFilesystemEntry `json:"filesystems,omitempty"`
	// contains filtered or unexported fields
}

ListFilesystemSchema ...

func (ListFilesystemSchema) ContentType

func (lfs ListFilesystemSchema) ContentType() string

ContentType returns the value for header Content-Type.

func (ListFilesystemSchema) Date

func (lfs ListFilesystemSchema) Date() string

Date returns the value for header Date.

func (ListFilesystemSchema) Response

func (lfs ListFilesystemSchema) Response() *http.Response

Response returns the raw HTTP response object.

func (ListFilesystemSchema) Status

func (lfs ListFilesystemSchema) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (ListFilesystemSchema) StatusCode

func (lfs ListFilesystemSchema) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (ListFilesystemSchema) XMsContinuation

func (lfs ListFilesystemSchema) XMsContinuation() string

XMsContinuation returns the value for header x-ms-continuation.

func (ListFilesystemSchema) XMsRequestID

func (lfs ListFilesystemSchema) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (ListFilesystemSchema) XMsVersion

func (lfs ListFilesystemSchema) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

type ListSchema

type ListSchema struct {
	Paths []ListEntrySchema `json:"paths,omitempty"`
	// contains filtered or unexported fields
}

ListSchema ...

func (ListSchema) Date

func (ls ListSchema) Date() string

Date returns the value for header Date.

func (ListSchema) ETag

func (ls ListSchema) ETag() string

ETag returns the value for header ETag.

func (ListSchema) LastModified

func (ls ListSchema) LastModified() string

LastModified returns the value for header Last-Modified.

func (ListSchema) Response

func (ls ListSchema) Response() *http.Response

Response returns the raw HTTP response object.

func (ListSchema) Status

func (ls ListSchema) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (ListSchema) StatusCode

func (ls ListSchema) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (ListSchema) XMsContinuation

func (ls ListSchema) XMsContinuation() string

XMsContinuation returns the value for header x-ms-continuation.

func (ListSchema) XMsRequestID

func (ls ListSchema) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (ListSchema) XMsVersion

func (ls ListSchema) 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
}

PipelineOptions is used to configure a request policy pipeline's retry policy and logging.

type ReadPathResponse

type ReadPathResponse struct {
	// contains filtered or unexported fields
}

ReadPathResponse ...

func (ReadPathResponse) AcceptRanges

func (rpr ReadPathResponse) AcceptRanges() string

AcceptRanges returns the value for header Accept-Ranges.

func (ReadPathResponse) Body

func (rpr ReadPathResponse) Body() io.ReadCloser

Body returns the raw HTTP response object's Body.

func (ReadPathResponse) CacheControl

func (rpr ReadPathResponse) CacheControl() string

CacheControl returns the value for header Cache-Control.

func (ReadPathResponse) ContentDisposition

func (rpr ReadPathResponse) ContentDisposition() string

ContentDisposition returns the value for header Content-Disposition.

func (ReadPathResponse) ContentEncoding

func (rpr ReadPathResponse) ContentEncoding() string

ContentEncoding returns the value for header Content-Encoding.

func (ReadPathResponse) ContentLanguage

func (rpr ReadPathResponse) ContentLanguage() string

ContentLanguage returns the value for header Content-Language.

func (ReadPathResponse) ContentLength

func (rpr ReadPathResponse) ContentLength() string

ContentLength returns the value for header Content-Length.

func (ReadPathResponse) ContentRange

func (rpr ReadPathResponse) ContentRange() string

ContentRange returns the value for header Content-Range.

func (ReadPathResponse) ContentType

func (rpr ReadPathResponse) ContentType() string

ContentType returns the value for header Content-Type.

func (ReadPathResponse) Date

func (rpr ReadPathResponse) Date() string

Date returns the value for header Date.

func (ReadPathResponse) ETag

func (rpr ReadPathResponse) ETag() string

ETag returns the value for header ETag.

func (ReadPathResponse) LastModified

func (rpr ReadPathResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (ReadPathResponse) Response

func (rpr ReadPathResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (ReadPathResponse) Status

func (rpr ReadPathResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (ReadPathResponse) StatusCode

func (rpr ReadPathResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (ReadPathResponse) XMsLeaseDuration

func (rpr ReadPathResponse) XMsLeaseDuration() string

XMsLeaseDuration returns the value for header x-ms-lease-duration.

func (ReadPathResponse) XMsLeaseState

func (rpr ReadPathResponse) XMsLeaseState() string

XMsLeaseState returns the value for header x-ms-lease-state.

func (ReadPathResponse) XMsLeaseStatus

func (rpr ReadPathResponse) XMsLeaseStatus() string

XMsLeaseStatus returns the value for header x-ms-lease-status.

func (ReadPathResponse) XMsProperties

func (rpr ReadPathResponse) XMsProperties() string

XMsProperties returns the value for header x-ms-properties.

func (ReadPathResponse) XMsRequestID

func (rpr ReadPathResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (ReadPathResponse) XMsResourceType

func (rpr ReadPathResponse) XMsResourceType() string

XMsResourceType returns the value for header x-ms-resource-type.

func (ReadPathResponse) XMsVersion

func (rpr ReadPathResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

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
}

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
	// contains filtered or unexported fields
}

RetryReaderOptions contains properties which can help to decide when to do retry.

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"

	// 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"

	// 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) 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) String

func (s ServiceURL) String() string

String returns the URL as a string.

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 SetFilesystemPropertiesResponse

type SetFilesystemPropertiesResponse struct {
	// contains filtered or unexported fields
}

SetFilesystemPropertiesResponse ...

func (SetFilesystemPropertiesResponse) Date

Date returns the value for header Date.

func (SetFilesystemPropertiesResponse) ETag

ETag returns the value for header ETag.

func (SetFilesystemPropertiesResponse) LastModified

func (sfpr SetFilesystemPropertiesResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (SetFilesystemPropertiesResponse) Response

Response returns the raw HTTP response object.

func (SetFilesystemPropertiesResponse) Status

Status returns the HTTP status message of the response, e.g. "200 OK".

func (SetFilesystemPropertiesResponse) StatusCode

func (sfpr SetFilesystemPropertiesResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (SetFilesystemPropertiesResponse) XMsRequestID

func (sfpr SetFilesystemPropertiesResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (SetFilesystemPropertiesResponse) XMsVersion

func (sfpr SetFilesystemPropertiesResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

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

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.

type UpdatePathResponse

type UpdatePathResponse struct {
	// contains filtered or unexported fields
}

UpdatePathResponse ...

func (UpdatePathResponse) AcceptRanges

func (upr UpdatePathResponse) AcceptRanges() string

AcceptRanges returns the value for header Accept-Ranges.

func (UpdatePathResponse) CacheControl

func (upr UpdatePathResponse) CacheControl() string

CacheControl returns the value for header Cache-Control.

func (UpdatePathResponse) ContentDisposition

func (upr UpdatePathResponse) ContentDisposition() string

ContentDisposition returns the value for header Content-Disposition.

func (UpdatePathResponse) ContentEncoding

func (upr UpdatePathResponse) ContentEncoding() string

ContentEncoding returns the value for header Content-Encoding.

func (UpdatePathResponse) ContentLanguage

func (upr UpdatePathResponse) ContentLanguage() string

ContentLanguage returns the value for header Content-Language.

func (UpdatePathResponse) ContentLength

func (upr UpdatePathResponse) ContentLength() string

ContentLength returns the value for header Content-Length.

func (UpdatePathResponse) ContentRange

func (upr UpdatePathResponse) ContentRange() string

ContentRange returns the value for header Content-Range.

func (UpdatePathResponse) ContentType

func (upr UpdatePathResponse) ContentType() string

ContentType returns the value for header Content-Type.

func (UpdatePathResponse) Date

func (upr UpdatePathResponse) Date() string

Date returns the value for header Date.

func (UpdatePathResponse) ETag

func (upr UpdatePathResponse) ETag() string

ETag returns the value for header ETag.

func (UpdatePathResponse) LastModified

func (upr UpdatePathResponse) LastModified() string

LastModified returns the value for header Last-Modified.

func (UpdatePathResponse) Response

func (upr UpdatePathResponse) Response() *http.Response

Response returns the raw HTTP response object.

func (UpdatePathResponse) Status

func (upr UpdatePathResponse) Status() string

Status returns the HTTP status message of the response, e.g. "200 OK".

func (UpdatePathResponse) StatusCode

func (upr UpdatePathResponse) StatusCode() int

StatusCode returns the HTTP status code of the response, e.g. 200.

func (UpdatePathResponse) XMsProperties

func (upr UpdatePathResponse) XMsProperties() string

XMsProperties returns the value for header x-ms-properties.

func (UpdatePathResponse) XMsRequestID

func (upr UpdatePathResponse) XMsRequestID() string

XMsRequestID returns the value for header x-ms-request-id.

func (UpdatePathResponse) XMsVersion

func (upr UpdatePathResponse) XMsVersion() string

XMsVersion returns the value for header x-ms-version.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL