storagedatalake

package
v41.1.0+incompatible Latest Latest
Warning

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

 Go to latest Published: Apr 2, 2020 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package storagedatalake implements the Azure ARM Storagedatalake service API version 2019-10-31.

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

Index

Constants

View Source 
const (
	// DefaultDNSSuffix is the default value for dns suffix
	DefaultDNSSuffix = "dfs.core.windows.net"
)

Variables

This section is empty.

Functions

func UserAgent 

func UserAgent() string

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

func Version 

func Version() string

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

Types

type BaseClient 

type BaseClient struct {
	autorest.Client
	XMsVersion  string
	AccountName string
	DNSSuffix   string
}

BaseClient is the base client for Storagedatalake.

func New 

func New(xMsVersion string, accountName string) BaseClient

New creates an instance of the BaseClient client.

func NewWithoutDefaults 

func NewWithoutDefaults(xMsVersion string, accountName string, dNSSuffix string) BaseClient

NewWithoutDefaults creates an instance of the BaseClient client.

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 Filesystem 

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

Filesystem ...

type FilesystemClient 

type FilesystemClient struct {
	BaseClient
}

FilesystemClient is the azure Data Lake Storage provides storage for Hadoop and other big data workloads.

func NewFilesystemClient 

func NewFilesystemClient(xMsVersion string, accountName string) FilesystemClient

NewFilesystemClient creates an instance of the FilesystemClient client.

func (FilesystemClient) Create 

func (client FilesystemClient) Create(ctx context.Context, filesystem string, xMsProperties string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

Create create a filesystem rooted at the specified location. If the filesystem already exists, the operation fails. This operation does not support conditional HTTP requests. Parameters: filesystem - the filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. xMsProperties - user-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (FilesystemClient) CreatePreparer 

func (client FilesystemClient) CreatePreparer(ctx context.Context, filesystem string, xMsProperties string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (FilesystemClient) CreateResponder 

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

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

func (FilesystemClient) CreateSender 

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

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

func (FilesystemClient) Delete 

func (client FilesystemClient) Delete(ctx context.Context, filesystem string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

Delete marks the filesystem for deletion. When a filesystem is deleted, a filesystem with the same identifier cannot be created for at least 30 seconds. While the filesystem is being deleted, attempts to create a filesystem with the same identifier will fail with status code 409 (Conflict), with the service returning additional error information indicating that the filesystem is being deleted. All other operations, including operations on any files or directories within the filesystem, will fail with status code 404 (Not Found) while the filesystem is being deleted. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: filesystem - the filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (FilesystemClient) DeletePreparer 

func (client FilesystemClient) DeletePreparer(ctx context.Context, filesystem string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (FilesystemClient) DeleteResponder 

func (client FilesystemClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

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

func (FilesystemClient) DeleteSender 

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

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

func (FilesystemClient) GetProperties 

func (client FilesystemClient) GetProperties(ctx context.Context, filesystem string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

GetProperties all system and user-defined filesystem properties are specified in the response headers. Parameters: filesystem - the filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (FilesystemClient) GetPropertiesPreparer 

func (client FilesystemClient) GetPropertiesPreparer(ctx context.Context, filesystem string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

GetPropertiesPreparer prepares the GetProperties request.

func (FilesystemClient) GetPropertiesResponder 

func (client FilesystemClient) GetPropertiesResponder(resp *http.Response) (result autorest.Response, err error)

GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.

func (FilesystemClient) GetPropertiesSender 

func (client FilesystemClient) GetPropertiesSender(req *http.Request) (*http.Response, error)

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

func (FilesystemClient) List 

func (client FilesystemClient) List(ctx context.Context, prefix string, continuation string, maxResults *int32, xMsClientRequestID string, timeout *int32, xMsDate string) (result FilesystemList, err error)

List list filesystems and their properties in given account. Parameters: prefix - filters results to filesystems within the specified prefix. continuation - the number of filesystems returned with each invocation is limited. If the number of filesystems to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the filesystems. maxResults - an optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (FilesystemClient) ListPreparer 

func (client FilesystemClient) ListPreparer(ctx context.Context, prefix string, continuation string, maxResults *int32, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

ListPreparer prepares the List request.

func (FilesystemClient) ListResponder 

func (client FilesystemClient) ListResponder(resp *http.Response) (result FilesystemList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (FilesystemClient) ListSender 

func (client FilesystemClient) ListSender(req *http.Request) (*http.Response, error)

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

func (FilesystemClient) SetProperties 

func (client FilesystemClient) SetProperties(ctx context.Context, filesystem string, xMsProperties string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

SetProperties set properties for the filesystem. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: filesystem - the filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. xMsProperties - optional. User-defined properties to be stored with the filesystem, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. If the filesystem exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (FilesystemClient) SetPropertiesPreparer 

func (client FilesystemClient) SetPropertiesPreparer(ctx context.Context, filesystem string, xMsProperties string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

SetPropertiesPreparer prepares the SetProperties request.

func (FilesystemClient) SetPropertiesResponder 

func (client FilesystemClient) SetPropertiesResponder(resp *http.Response) (result autorest.Response, err error)

SetPropertiesResponder handles the response to the SetProperties request. The method always closes the http.Response Body.

func (FilesystemClient) SetPropertiesSender 

func (client FilesystemClient) SetPropertiesSender(req *http.Request) (*http.Response, error)

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

type FilesystemList 

type FilesystemList struct {
	autorest.Response `json:"-"`
	Filesystems       *[]Filesystem `json:"filesystems,omitempty"`
}

FilesystemList ...

type Path 

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

Path ...

type PathClient 

type PathClient struct {
	BaseClient
}

PathClient is the azure Data Lake Storage provides storage for Hadoop and other big data workloads.

func NewPathClient 

func NewPathClient(xMsVersion string, accountName string) PathClient

NewPathClient creates an instance of the PathClient client.

func (PathClient) Create 

func (client PathClient) Create(ctx context.Context, filesystem string, pathParameter string, resource PathResourceType, continuation string, mode PathRenameMode, cacheControl string, contentEncoding string, contentLanguage string, contentDisposition string, xMsCacheControl string, xMsContentType string, xMsContentEncoding string, xMsContentLanguage string, xMsContentDisposition string, xMsRenameSource string, xMsLeaseID string, xMsSourceLeaseID string, xMsProperties string, xMsPermissions string, xMsUmask string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsSourceIfMatch string, xMsSourceIfNoneMatch string, xMsSourceIfModifiedSince string, xMsSourceIfUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

Create create or rename a file or directory. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). To fail if the destination already exists, use a conditional request with If-None-Match: "*". Parameters: filesystem - the filesystem identifier. pathParameter - the file or directory path. resource - required only for Create File and Create Directory. The value must be "file" or "directory". continuation - optional. When renaming a directory, the number of paths that are renamed with each invocation is limited. If the number of paths to be renamed exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the rename operation to continue renaming the directory. mode - optional. Valid only when namespace is enabled. This parameter determines the behavior of the rename operation. The value must be "legacy" or "posix", and the default value will be "posix". cacheControl - optional. The service stores this value and includes it in the "Cache-Control" response header for "Read File" operations for "Read File" operations. contentEncoding - optional. Specifies which content encodings have been applied to the file. This value is returned to the client when the "Read File" operation is performed. contentLanguage - optional. Specifies the natural language used by the intended audience for the file. contentDisposition - optional. The service stores this value and includes it in the "Content-Disposition" response header for "Read File" operations. xMsCacheControl - optional. The service stores this value and includes it in the "Cache-Control" response header for "Read File" operations. xMsContentType - optional. The service stores this value and includes it in the "Content-Type" response header for "Read File" operations. xMsContentEncoding - optional. The service stores this value and includes it in the "Content-Encoding" response header for "Read File" operations. xMsContentLanguage - optional. The service stores this value and includes it in the "Content-Language" response header for "Read File" operations. xMsContentDisposition - optional. The service stores this value and includes it in the "Content-Disposition" response header for "Read File" operations. xMsRenameSource - an optional file or directory to be renamed. The value must have the following format: "/{filesystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved. This value must be a URL percent-encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. xMsLeaseID - optional. A lease ID for the path specified in the URI. The path to be overwritten must have an active lease and the lease ID must match. xMsSourceLeaseID - optional for rename operations. A lease ID for the source path. The source path must have an active lease and the lease ID must match. xMsProperties - optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. xMsPermissions - optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. xMsUmask - optional and only valid if Hierarchical Namespace is enabled for the account. When creating a file or directory and the parent folder does not have a default ACL, the umask restricts the permissions of the file or directory to be created. The resulting permission is given by p & ^u, where p is the permission and u is the umask. For example, if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified in 4-digit octal notation (e.g. 0766). ifMatch - optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. ifNoneMatch - optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsSourceIfMatch - optional. An ETag value. Specify this header to perform the rename operation only if the source's ETag matches the value specified. The ETag must be specified in quotes. xMsSourceIfNoneMatch - optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the rename operation only if the source's ETag does not match the value specified. The ETag must be specified in quotes. xMsSourceIfModifiedSince - optional. A date and time value. Specify this header to perform the rename operation only if the source has been modified since the specified date and time. xMsSourceIfUnmodifiedSince - optional. A date and time value. Specify this header to perform the rename operation only if the source has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) CreatePreparer 

func (client PathClient) CreatePreparer(ctx context.Context, filesystem string, pathParameter string, resource PathResourceType, continuation string, mode PathRenameMode, cacheControl string, contentEncoding string, contentLanguage string, contentDisposition string, xMsCacheControl string, xMsContentType string, xMsContentEncoding string, xMsContentLanguage string, xMsContentDisposition string, xMsRenameSource string, xMsLeaseID string, xMsSourceLeaseID string, xMsProperties string, xMsPermissions string, xMsUmask string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsSourceIfMatch string, xMsSourceIfNoneMatch string, xMsSourceIfModifiedSince string, xMsSourceIfUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

CreatePreparer prepares the Create request.

func (PathClient) CreateResponder 

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

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

func (PathClient) CreateSender 

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

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

func (PathClient) Delete 

func (client PathClient) Delete(ctx context.Context, filesystem string, pathParameter string, recursive *bool, continuation string, xMsLeaseID string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

Delete delete the file or directory. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: filesystem - the filesystem identifier. pathParameter - the file or directory path. recursive - required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted. If "false" and the directory is non-empty, an error occurs. continuation - optional. When deleting a directory, the number of paths that are deleted with each invocation is limited. If the number of paths to be deleted exceeds this limit, a continuation token is returned in this response header. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the delete operation to continue deleting the directory. xMsLeaseID - the lease ID must be specified if there is an active lease. ifMatch - optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. ifNoneMatch - optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) DeletePreparer 

func (client PathClient) DeletePreparer(ctx context.Context, filesystem string, pathParameter string, recursive *bool, continuation string, xMsLeaseID string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (PathClient) DeleteResponder 

func (client PathClient) DeleteResponder(resp *http.Response) (result autorest.Response, err error)

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

func (PathClient) DeleteSender 

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

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

func (PathClient) GetProperties 

func (client PathClient) GetProperties(ctx context.Context, filesystem string, pathParameter string, action PathGetPropertiesAction, upn *bool, fsAction string, xMsLeaseID string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

GetProperties get Properties returns all system and user defined properties for a path. Get Status returns all system defined properties for a path. Get Access Control List returns the access control list for a path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: filesystem - the filesystem identifier. pathParameter - the file or directory path. action - optional. If the value is "getStatus" only the system defined properties for the path are returned. If the value is "getAccessControl" the access control list is returned in the response headers (Hierarchical Namespace must be enabled for the account), otherwise the properties are returned. upn - optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the x-ms-owner, x-ms-group, and x-ms-acl response headers will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names. fsAction - required only for check access action. Valid only when Hierarchical Namespace is enabled for the account. File system operation read/write/execute in string form, matching regex pattern '[rwx-]{3}' xMsLeaseID - optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path. ifMatch - optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. ifNoneMatch - optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) GetPropertiesPreparer 

func (client PathClient) GetPropertiesPreparer(ctx context.Context, filesystem string, pathParameter string, action PathGetPropertiesAction, upn *bool, fsAction string, xMsLeaseID string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

GetPropertiesPreparer prepares the GetProperties request.

func (PathClient) GetPropertiesResponder 

func (client PathClient) GetPropertiesResponder(resp *http.Response) (result autorest.Response, err error)

GetPropertiesResponder handles the response to the GetProperties request. The method always closes the http.Response Body.

func (PathClient) GetPropertiesSender 

func (client PathClient) GetPropertiesSender(req *http.Request) (*http.Response, error)

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

func (PathClient) Lease 

func (client PathClient) Lease(ctx context.Context, xMsLeaseAction PathLeaseAction, filesystem string, pathParameter string, xMsLeaseDuration *int32, xMsLeaseBreakPeriod *int32, xMsLeaseID string, xMsProposedLeaseID string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

Lease create and manage a lease to restrict write and delete access to the path. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: xMsLeaseAction - there are five lease actions: "acquire", "break", "change", "renew", and "release". Use "acquire" and specify the "x-ms-proposed-lease-id" and "x-ms-lease-duration" to acquire a new lease. Use "break" to break an existing lease. When a lease is broken, the lease break period is allowed to elapse, during which time no lease operation except break and release can be performed on the file. When a lease is successfully broken, the response indicates the interval in seconds until a new lease can be acquired. Use "change" and specify the current lease ID in "x-ms-lease-id" and the new lease ID in "x-ms-proposed-lease-id" to change the lease ID of an active lease. Use "renew" and specify the "x-ms-lease-id" to renew an existing lease. Use "release" and specify the "x-ms-lease-id" to release a lease. filesystem - the filesystem identifier. pathParameter - the file or directory path. xMsLeaseDuration - the lease duration is required to acquire a lease, and specifies the duration of the lease in seconds. The lease duration must be between 15 and 60 seconds or -1 for infinite lease. xMsLeaseBreakPeriod - the lease break period duration is optional to break a lease, and specifies the break period of the lease in seconds. The lease break duration must be between 0 and 60 seconds. xMsLeaseID - required when "x-ms-lease-action" is "renew", "change" or "release". For the renew and release actions, this must match the current lease ID. xMsProposedLeaseID - required when "x-ms-lease-action" is "acquire" or "change". A lease will be acquired with this lease ID if the operation is successful. ifMatch - optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. ifNoneMatch - optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) LeasePreparer 

func (client PathClient) LeasePreparer(ctx context.Context, xMsLeaseAction PathLeaseAction, filesystem string, pathParameter string, xMsLeaseDuration *int32, xMsLeaseBreakPeriod *int32, xMsLeaseID string, xMsProposedLeaseID string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

LeasePreparer prepares the Lease request.

func (PathClient) LeaseResponder 

func (client PathClient) LeaseResponder(resp *http.Response) (result autorest.Response, err error)

LeaseResponder handles the response to the Lease request. The method always closes the http.Response Body.

func (PathClient) LeaseSender 

func (client PathClient) LeaseSender(req *http.Request) (*http.Response, error)

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

func (PathClient) List 

func (client PathClient) List(ctx context.Context, recursive bool, filesystem string, directory string, continuation string, maxResults *int32, upn *bool, xMsClientRequestID string, timeout *int32, xMsDate string) (result PathList, err error)

List list filesystem paths and their properties. Parameters: recursive - if "true", all paths are listed; otherwise, only paths at the root of the filesystem are listed. If "directory" is specified, the list will only include paths that share the same root. filesystem - the filesystem identifier. The value must start and end with a letter or number and must contain only letters, numbers, and the dash (-) character. Consecutive dashes are not permitted. All letters must be lowercase. The value must have between 3 and 63 characters. directory - filters results to paths within the specified directory. An error occurs if the directory does not exist. continuation - the number of paths returned with each invocation is limited. If the number of paths to be returned exceeds this limit, a continuation token is returned in the response header x-ms-continuation. When a continuation token is returned in the response, it must be specified in a subsequent invocation of the list operation to continue listing the paths. maxResults - an optional value that specifies the maximum number of items to return. If omitted or greater than 5,000, the response will include up to 5,000 items. upn - optional. Valid only when Hierarchical Namespace is enabled for the account. If "true", the user identity values returned in the owner and group fields of each list entry will be transformed from Azure Active Directory Object IDs to User Principal Names. If "false", the values will be returned as Azure Active Directory Object IDs. The default value is false. Note that group and application Object IDs are not translated because they do not have unique friendly names. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) ListPreparer 

func (client PathClient) ListPreparer(ctx context.Context, recursive bool, filesystem string, directory string, continuation string, maxResults *int32, upn *bool, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

ListPreparer prepares the List request.

func (PathClient) ListResponder 

func (client PathClient) ListResponder(resp *http.Response) (result PathList, err error)

ListResponder handles the response to the List request. The method always closes the http.Response Body.

func (PathClient) ListSender 

func (client PathClient) ListSender(req *http.Request) (*http.Response, error)

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

func (PathClient) Read 

func (client PathClient) Read(ctx context.Context, filesystem string, pathParameter string, rangeParameter string, xMsLeaseID string, xMsRangeGetContentMd5 *bool, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (result ReadCloser, err error)

Read read the contents of a file. For read operations, range requests are supported. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: filesystem - the filesystem identifier. pathParameter - the file or directory path. rangeParameter - the HTTP Range request header specifies one or more byte ranges of the resource to be retrieved. xMsLeaseID - optional. If this header is specified, the operation will be performed only if both of the following conditions are met: i) the path's lease is currently active and ii) the lease ID specified in the request matches that of the path. xMsRangeGetContentMd5 - optional. When this header is set to "true" and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4MB in size. If this header is specified without the Range header, the service returns status code 400 (Bad Request). If this header is set to true when the range exceeds 4 MB in size, the service returns status code 400 (Bad Request). ifMatch - optional. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. ifNoneMatch - optional. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. ifModifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) ReadPreparer 

func (client PathClient) ReadPreparer(ctx context.Context, filesystem string, pathParameter string, rangeParameter string, xMsLeaseID string, xMsRangeGetContentMd5 *bool, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

ReadPreparer prepares the Read request.

func (PathClient) ReadResponder 

func (client PathClient) ReadResponder(resp *http.Response) (result ReadCloser, err error)

ReadResponder handles the response to the Read request. The method always closes the http.Response Body.

func (PathClient) ReadSender 

func (client PathClient) ReadSender(req *http.Request) (*http.Response, error)

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

func (PathClient) Update 

func (client PathClient) Update(ctx context.Context, action PathUpdateAction, filesystem string, pathParameter string, position *int64, retainUncommittedData *bool, closeParameter *bool, contentLength *int64, contentMD5 string, xMsLeaseID string, xMsCacheControl string, xMsContentType string, xMsContentDisposition string, xMsContentEncoding string, xMsContentLanguage string, xMsContentMd5 string, xMsProperties string, xMsOwner string, xMsGroup string, xMsPermissions string, xMsACL string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, requestBody io.ReadCloser, xMsClientRequestID string, timeout *int32, xMsDate string) (result autorest.Response, err error)

Update uploads data to be appended to a file, flushes (writes) previously uploaded data to a file, sets properties for a file or directory, or sets access control for a file or directory. Data can only be appended to a file. This operation supports conditional HTTP requests. For more information, see [Specifying Conditional Headers for Blob Service Operations](https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-conditional-headers-for-blob-service-operations). Parameters: action - the action must be "append" to upload data to be appended to a file, "flush" to flush previously uploaded data to a file, "setProperties" to set the properties of a file or directory, or "setAccessControl" to set the owner, group, permissions, or access control list for a file or directory. Note that Hierarchical Namespace must be enabled for the account in order to use access control. Also note that the Access Control List (ACL) includes permissions for the owner, owning group, and others, so the x-ms-permissions and x-ms-acl request headers are mutually exclusive. filesystem - the filesystem identifier. pathParameter - the file or directory path. position - this parameter allows the caller to upload data in parallel and control the order in which it is appended to the file. It is required when uploading data to be appended to the file and when flushing previously uploaded data to the file. The value must be the position where the data is to be appended. Uploaded data is not immediately flushed, or written, to the file. To flush, the previously uploaded data must be contiguous, the position parameter must be specified and equal to the length of the file after all data has been written, and there must not be a request entity body included with the request. retainUncommittedData - valid only for flush operations. If "true", uncommitted data is retained after the flush operation completes; otherwise, the uncommitted data is deleted after the flush operation. The default is false. Data at offsets less than the specified position are written to the file when flush succeeds, but this optional parameter allows data after the flush position to be retained for a future flush operation. closeParameter - azure Storage Events allow applications to receive notifications when files change. When Azure Storage Events are enabled, a file changed event is raised. This event has a property indicating whether this is the final change to distinguish the difference between an intermediate flush to a file stream and the final close of a file stream. The close query parameter is valid only when the action is "flush" and change notifications are enabled. If the value of close is "true" and the flush operation completes successfully, the service raises a file change notification with a property indicating that this is the final update (the file stream has been closed). If "false" a change notification is raised indicating the file has changed. The default is false. This query parameter is set to true by the Hadoop ABFS driver to indicate that the file stream has been closed." contentLength - required for "Append Data" and "Flush Data". Must be 0 for "Flush Data". Must be the length of the request content in bytes for "Append Data". contentMD5 - optional. An MD5 hash of the request content. This header is valid on "Append" and "Flush" operations. This hash is used to verify the integrity of the request content during transport. When this header is specified, the storage service compares the hash of the content that has arrived with this header value. If the two hashes do not match, the operation will fail with error code 400 (Bad Request). Note that this MD5 hash is not stored with the file. This header is associated with the request content, and not with the stored content of the file itself. xMsLeaseID - the lease ID must be specified if there is an active lease. xMsCacheControl - optional and only valid for flush and set properties operations. The service stores this value and includes it in the "Cache-Control" response header for "Read File" operations. xMsContentType - optional and only valid for flush and set properties operations. The service stores this value and includes it in the "Content-Type" response header for "Read File" operations. xMsContentDisposition - optional and only valid for flush and set properties operations. The service stores this value and includes it in the "Content-Disposition" response header for "Read File" operations. xMsContentEncoding - optional and only valid for flush and set properties operations. The service stores this value and includes it in the "Content-Encoding" response header for "Read File" operations. xMsContentLanguage - optional and only valid for flush and set properties operations. The service stores this value and includes it in the "Content-Language" response header for "Read File" operations. xMsContentMd5 - optional and only valid for "Flush & Set Properties" operations. The service stores this value and includes it in the "Content-Md5" response header for "Read & Get Properties" operations. If this property is not specified on the request, then the property will be cleared for the file. Subsequent calls to "Read & Get Properties" will not return this property unless it is explicitly set on that file again. xMsProperties - optional. User-defined properties to be stored with the file or directory, in the format of a comma-separated list of name and value pairs "n1=v1, n2=v2, ...", where each value is a base64 encoded string. Note that the string may only contain ASCII characters in the ISO-8859-1 character set. Valid only for the setProperties operation. If the file or directory exists, any properties not included in the list will be removed. All properties are removed if the header is omitted. To merge new and existing properties, first get all existing properties and the current E-Tag, then make a conditional request with the E-Tag and include values for all properties. xMsOwner - optional and valid only for the setAccessControl operation. Sets the owner of the file or directory. xMsGroup - optional and valid only for the setAccessControl operation. Sets the owning group of the file or directory. xMsPermissions - optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access permissions for the file owner, the file owning group, and others. Each class may be granted read, write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit octal notation (e.g. 0766) are supported. Invalid in conjunction with x-ms-acl. xMsACL - optional and valid only for the setAccessControl operation. Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries that fully replaces the existing access control list (ACL). Each access control entry (ACE) consists of a scope, a type, a user or group identifier, and permissions in the format "[scope:][type]:[id]:[permissions]". The scope must be "default" to indicate the ACE belongs to the default ACL for a directory; otherwise scope is implicit and the ACE belongs to the access ACL. There are four ACE types: "user" grants rights to the owner or a named user, "group" grants rights to the owning group or a named group, "mask" restricts rights granted to named users and the members of groups, and "other" grants rights to all users not found in any of the other entries. The user or group identifier is omitted for entries of type "mask" and "other". The user or group identifier is also omitted for the owner and owning group. The permission field is a 3-character sequence where the first character is 'r' to grant read access, the second character is 'w' to grant write access, and the third character is 'x' to grant execute permission. If access is not granted, the '-' character is used to denote that the permission is denied. For example, the following ACL grants read, write, and execute rights to the file owner and john.doe@contoso, the read right to the owning group, and nothing to everyone else: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Invalid in conjunction with x-ms-permissions. ifMatch - optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value. Specify this header to perform the operation only if the resource's ETag matches the value specified. The ETag must be specified in quotes. ifNoneMatch - optional for Flush Data and Set Properties, but invalid for Append Data. An ETag value or the special wildcard ("*") value. Specify this header to perform the operation only if the resource's ETag does not match the value specified. The ETag must be specified in quotes. ifModifiedSince - optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has been modified since the specified date and time. ifUnmodifiedSince - optional for Flush Data and Set Properties, but invalid for Append Data. A date and time value. Specify this header to perform the operation only if the resource has not been modified since the specified date and time. requestBody - valid only for append operations. The data to be uploaded and appended to the file. xMsClientRequestID - a UUID recorded in the analytics logs for troubleshooting and correlation. timeout - an optional operation timeout value in seconds. The period begins when the request is received by the service. If the timeout value elapses before the operation completes, the operation fails. xMsDate - specifies the Coordinated Universal Time (UTC) for the request. This is required when using shared key authorization.

func (PathClient) UpdatePreparer 

func (client PathClient) UpdatePreparer(ctx context.Context, action PathUpdateAction, filesystem string, pathParameter string, position *int64, retainUncommittedData *bool, closeParameter *bool, contentLength *int64, contentMD5 string, xMsLeaseID string, xMsCacheControl string, xMsContentType string, xMsContentDisposition string, xMsContentEncoding string, xMsContentLanguage string, xMsContentMd5 string, xMsProperties string, xMsOwner string, xMsGroup string, xMsPermissions string, xMsACL string, ifMatch string, ifNoneMatch string, ifModifiedSince string, ifUnmodifiedSince string, requestBody io.ReadCloser, xMsClientRequestID string, timeout *int32, xMsDate string) (*http.Request, error)

UpdatePreparer prepares the Update request.

func (PathClient) UpdateResponder 

func (client PathClient) UpdateResponder(resp *http.Response) (result autorest.Response, err error)

UpdateResponder handles the response to the Update request. The method always closes the http.Response Body.

func (PathClient) UpdateSender 

func (client PathClient) UpdateSender(req *http.Request) (*http.Response, error)

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

type PathGetPropertiesAction 

type PathGetPropertiesAction string

PathGetPropertiesAction enumerates the values for path get properties action. 

const (
	// CheckAccess ...
	CheckAccess PathGetPropertiesAction = "checkAccess"
	// GetAccessControl ...
	GetAccessControl PathGetPropertiesAction = "getAccessControl"
	// GetStatus ...
	GetStatus PathGetPropertiesAction = "getStatus"
)

func PossiblePathGetPropertiesActionValues 

func PossiblePathGetPropertiesActionValues() []PathGetPropertiesAction

PossiblePathGetPropertiesActionValues returns an array of possible values for the PathGetPropertiesAction const type.

type PathLeaseAction 

type PathLeaseAction string

PathLeaseAction enumerates the values for path lease action. 

const (
	// Acquire ...
	Acquire PathLeaseAction = "acquire"
	// Break ...
	Break PathLeaseAction = "break"
	// Change ...
	Change PathLeaseAction = "change"
	// Release ...
	Release PathLeaseAction = "release"
	// Renew ...
	Renew PathLeaseAction = "renew"
)

func PossiblePathLeaseActionValues 

func PossiblePathLeaseActionValues() []PathLeaseAction

PossiblePathLeaseActionValues returns an array of possible values for the PathLeaseAction const type.

type PathList 

type PathList struct {
	autorest.Response `json:"-"`
	Paths             *[]Path `json:"paths,omitempty"`
}

PathList ...

type PathRenameMode 

type PathRenameMode string

PathRenameMode enumerates the values for path rename mode. 

const (
	// Legacy ...
	Legacy PathRenameMode = "legacy"
	// Posix ...
	Posix PathRenameMode = "posix"
)

func PossiblePathRenameModeValues 

func PossiblePathRenameModeValues() []PathRenameMode

PossiblePathRenameModeValues returns an array of possible values for the PathRenameMode const type.

type PathResourceType 

type PathResourceType string

PathResourceType enumerates the values for path resource type. 

const (
	// Directory ...
	Directory PathResourceType = "directory"
	// File ...
	File PathResourceType = "file"
)

func PossiblePathResourceTypeValues 

func PossiblePathResourceTypeValues() []PathResourceType

PossiblePathResourceTypeValues returns an array of possible values for the PathResourceType const type.

type PathUpdateAction 

type PathUpdateAction string

PathUpdateAction enumerates the values for path update action. 

const (
	// Append ...
	Append PathUpdateAction = "append"
	// Flush ...
	Flush PathUpdateAction = "flush"
	// SetAccessControl ...
	SetAccessControl PathUpdateAction = "setAccessControl"
	// SetProperties ...
	SetProperties PathUpdateAction = "setProperties"
)

func PossiblePathUpdateActionValues 

func PossiblePathUpdateActionValues() []PathUpdateAction

PossiblePathUpdateActionValues returns an array of possible values for the PathUpdateAction const type.

type ReadCloser 

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

ReadCloser ...

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.