generated

package
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2024 License: MIT Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const ServiceVersion = "2024-05-04"

Variables

This section is empty.

Functions

This section is empty.

Types

type ACLFailedEntry 

type ACLFailedEntry struct {
	ErrorMessage *string
	Name         *string
	Type         *string
}

func (ACLFailedEntry) MarshalJSON 

func (a ACLFailedEntry) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type ACLFailedEntry.

func (*ACLFailedEntry) UnmarshalJSON 

func (a *ACLFailedEntry) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type ACLFailedEntry.

type CPKInfo 

type CPKInfo struct {
	// The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided
	// if the x-ms-encryption-key header is provided.
	EncryptionAlgorithm *EncryptionAlgorithmType

	// Optional. Specifies the encryption key to use to encrypt the data provided in the request. If not specified, encryption
	// is performed with the root account encryption key. For more information, see
	// Encryption at Rest for Azure Storage Services.
	EncryptionKey *string

	// The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided.
	EncryptionKeySHA256 *string
}

CPKInfo contains a group of parameters for the PathClient.Create method.

type EncryptionAlgorithmType 

type EncryptionAlgorithmType string
const (
	EncryptionAlgorithmTypeAES256 EncryptionAlgorithmType = "AES256"
	EncryptionAlgorithmTypeNone   EncryptionAlgorithmType = "None"
)

func PossibleEncryptionAlgorithmTypeValues 

func PossibleEncryptionAlgorithmTypeValues() []EncryptionAlgorithmType

PossibleEncryptionAlgorithmTypeValues returns the possible values for the EncryptionAlgorithmType const type.

type ExpiryOptions 

type ExpiryOptions string
const (
	ExpiryOptionsAbsolute           ExpiryOptions = "Absolute"
	ExpiryOptionsNeverExpire        ExpiryOptions = "NeverExpire"
	ExpiryOptionsRelativeToCreation ExpiryOptions = "RelativeToCreation"
	ExpiryOptionsRelativeToNow      ExpiryOptions = "RelativeToNow"
)

func PossibleExpiryOptionsValues 

func PossibleExpiryOptionsValues() []ExpiryOptions

PossibleExpiryOptionsValues returns the possible values for the ExpiryOptions const type.

type FileSystem 

type FileSystem struct {
	ETag         *string
	LastModified *string
	Name         *string
}

func (FileSystem) MarshalJSON 

func (f FileSystem) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileSystem.

func (*FileSystem) UnmarshalJSON 

func (f *FileSystem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileSystem.

type FileSystemClient 

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

FileSystemClient contains the methods for the FileSystem group. Don't use this type directly, use a constructor function instead.

func NewFileSystemClient 

func NewFileSystemClient(endpoint string, azClient *azcore.Client) *FileSystemClient

NewFileSystemClient creates a new instance of ServiceClient with the specified values.

  • endpoint - The URL of the service account, share, directory or file that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*FileSystemClient) Create 

func (client *FileSystemClient) Create(ctx context.Context, options *FileSystemClientCreateOptions) (FileSystemClientCreateResponse, 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. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - FileSystemClientCreateOptions contains the optional parameters for the FileSystemClient.Create method.

func (*FileSystemClient) Delete 

func (client *FileSystemClient) Delete(ctx context.Context, options *FileSystemClientDeleteOptions, modifiedAccessConditions *ModifiedAccessConditions) (FileSystemClientDeleteResponse, 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - FileSystemClientDeleteOptions contains the optional parameters for the FileSystemClient.Delete method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

func (*FileSystemClient) Endpoint 

func (client *FileSystemClient) Endpoint() string

func (*FileSystemClient) GetProperties 

func (client *FileSystemClient) GetProperties(ctx context.Context, options *FileSystemClientGetPropertiesOptions) (FileSystemClientGetPropertiesResponse, error)

GetProperties - All system and user-defined filesystem properties are specified in the response headers. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - FileSystemClientGetPropertiesOptions contains the optional parameters for the FileSystemClient.GetProperties method.

func (*FileSystemClient) InternalClient 

func (client *FileSystemClient) InternalClient() *azcore.Client

func (*FileSystemClient) ListBlobHierarchySegmentCreateRequest 

func (client *FileSystemClient) ListBlobHierarchySegmentCreateRequest(ctx context.Context, options *FileSystemClientListBlobHierarchySegmentOptions) (*policy.Request, error)

NewListBlobHierarchySegmentPager - The List Blobs operation returns a list of the blobs under the specified container

Generated from API version 2024-05-04

  • options - FileSystemClientListBlobHierarchySegmentOptions contains the optional parameters for the FileSystemClient.NewListBlobHierarchySegmentPager method.

ListBlobHierarchySegmentCreateRequest creates the ListBlobHierarchySegment request.

func (*FileSystemClient) ListBlobHierarchySegmentHandleResponse 

func (client *FileSystemClient) ListBlobHierarchySegmentHandleResponse(resp *http.Response) (FileSystemClientListPathHierarchySegmentResponse, error)

listBlobHierarchySegmentHandleResponse handles the ListBlobHierarchySegment response.

func (*FileSystemClient) ListPathsCreateRequest 

func (client *FileSystemClient) ListPathsCreateRequest(ctx context.Context, recursive bool, options *FileSystemClientListPathsOptions) (*policy.Request, error)

NewListPathsPager - List FileSystem paths and their properties.

Generated from API version 2024-05-04

  • recursive - Required
  • options - FileSystemClientListPathsOptions contains the optional parameters for the FileSystemClient.NewListPathsPager method.

ListPathsCreateRequest creates the ListPaths request.

func (*FileSystemClient) ListPathsHandleResponse 

func (client *FileSystemClient) ListPathsHandleResponse(resp *http.Response) (FileSystemClientListPathsResponse, error)

listPathsHandleResponse handles the ListPaths response.

func (*FileSystemClient) SetProperties 

func (client *FileSystemClient) SetProperties(ctx context.Context, options *FileSystemClientSetPropertiesOptions, modifiedAccessConditions *ModifiedAccessConditions) (FileSystemClientSetPropertiesResponse, 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - FileSystemClientSetPropertiesOptions contains the optional parameters for the FileSystemClient.SetProperties method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

type FileSystemClientCreateOptions 

type FileSystemClientCreateOptions struct {
	// 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.
	Properties *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

FileSystemClientCreateOptions contains the optional parameters for the FileSystemClient.Create method.

type FileSystemClientCreateResponse 

type FileSystemClientCreateResponse struct {
	// ClientRequestID contains the information returned from the x-ms-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// NamespaceEnabled contains the information returned from the x-ms-namespace-enabled header response.
	NamespaceEnabled *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileSystemClientCreateResponse contains the response from method FileSystemClient.Create.

type FileSystemClientDeleteOptions 

type FileSystemClientDeleteOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

FileSystemClientDeleteOptions contains the optional parameters for the FileSystemClient.Delete method.

type FileSystemClientDeleteResponse 

type FileSystemClientDeleteResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileSystemClientDeleteResponse contains the response from method FileSystemClient.Delete.

type FileSystemClientGetPropertiesOptions 

type FileSystemClientGetPropertiesOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

FileSystemClientGetPropertiesOptions contains the optional parameters for the FileSystemClient.GetProperties method.

type FileSystemClientGetPropertiesResponse 

type FileSystemClientGetPropertiesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// NamespaceEnabled contains the information returned from the x-ms-namespace-enabled header response.
	NamespaceEnabled *string

	// Properties contains the information returned from the x-ms-properties header response.
	Properties *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileSystemClientGetPropertiesResponse contains the response from method FileSystemClient.GetProperties.

type FileSystemClientListBlobHierarchySegmentOptions 

type FileSystemClientListBlobHierarchySegmentOptions struct {
	// When the request includes this parameter, the operation returns a PathPrefix element in the response body that acts as
	// a placeholder for all blobs whose names begin with the same substring up to the
	// appearance of the delimiter character. The delimiter may be a single character or a string.
	Delimiter *string

	// Include this parameter to specify one or more datasets to include in the response.
	Include []ListBlobsIncludeItem

	// A string value that identifies the portion of the list of containers to be returned with the next listing operation. The
	// operation returns the NextMarker value within the response body if the listing
	// operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used
	// as the value for the marker parameter in a subsequent call to request the next
	// page of list items. The marker value is opaque to the client.
	Marker *string

	// 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.
	MaxResults *int32

	// Filters results to filesystems within the specified prefix.
	Prefix *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// Include this parameter to specify one or more datasets to include in the response.. Specifying any value will set the value
	// to deleted.
	Showonly *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

FileSystemClientListBlobHierarchySegmentOptions contains the optional parameters for the FileSystemClient.NewListBlobHierarchySegmentPager method.

type FileSystemClientListPathHierarchySegmentResponse 

type FileSystemClientListPathHierarchySegmentResponse struct {
	// An enumeration of blobs
	ListPathsHierarchySegmentResponse

	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileSystemClientListPathHierarchySegmentResponse contains the response from method FileSystemClient.NewListBlobHierarchySegmentPager.

type FileSystemClientListPathsOptions 

type FileSystemClientListPathsOptions struct {
	// 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.
	Continuation *string

	// 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.
	MaxResults *int32

	// Optional. Filters results to paths within the specified directory. An error occurs if the directory does not exist.
	Path *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// 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.
	Upn *bool
}

FileSystemClientListPathsOptions contains the optional parameters for the FileSystemClient.NewListPathsPager method.

type FileSystemClientListPathsResponse 

type FileSystemClientListPathsResponse struct {
	PathList

	// Continuation contains the information returned from the x-ms-continuation header response.
	Continuation *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileSystemClientListPathsResponse contains the response from method FileSystemClient.NewListPathsPager.

type FileSystemClientSetPropertiesOptions 

type FileSystemClientSetPropertiesOptions struct {
	// 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.
	Properties *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

FileSystemClientSetPropertiesOptions contains the optional parameters for the FileSystemClient.SetProperties method.

type FileSystemClientSetPropertiesResponse 

type FileSystemClientSetPropertiesResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

FileSystemClientSetPropertiesResponse contains the response from method FileSystemClient.SetProperties.

type FileSystemList 

type FileSystemList struct {
	Filesystems []*FileSystem
}

func (FileSystemList) MarshalJSON 

func (f FileSystemList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type FileSystemList.

func (*FileSystemList) UnmarshalJSON 

func (f *FileSystemList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type FileSystemList.

type LeaseAccessConditions 

type LeaseAccessConditions struct {
	// If specified, the operation only succeeds if the resource's lease is active and matches this ID.
	LeaseID *string
}

LeaseAccessConditions contains a group of parameters for the PathClient.Create method.

type LeaseAction added in v1.1.0 

type LeaseAction string
const (
	LeaseActionAcquire        LeaseAction = "acquire"
	LeaseActionAcquireRelease LeaseAction = "acquire-release"
	LeaseActionAutoRenew      LeaseAction = "auto-renew"
	LeaseActionRelease        LeaseAction = "release"
)

func PossibleLeaseActionValues added in v1.1.0 

func PossibleLeaseActionValues() []LeaseAction

PossibleLeaseActionValues returns the possible values for the LeaseAction const type.

type ListBlobsIncludeItem 

type ListBlobsIncludeItem string
const (
	ListBlobsIncludeItemCopy             ListBlobsIncludeItem = "copy"
	ListBlobsIncludeItemDeleted          ListBlobsIncludeItem = "deleted"
	ListBlobsIncludeItemMetadata         ListBlobsIncludeItem = "metadata"
	ListBlobsIncludeItemSnapshots        ListBlobsIncludeItem = "snapshots"
	ListBlobsIncludeItemTags             ListBlobsIncludeItem = "tags"
	ListBlobsIncludeItemUncommittedblobs ListBlobsIncludeItem = "uncommittedblobs"
	ListBlobsIncludeItemVersions         ListBlobsIncludeItem = "versions"
)

func PossibleListBlobsIncludeItemValues 

func PossibleListBlobsIncludeItemValues() []ListBlobsIncludeItem

PossibleListBlobsIncludeItemValues returns the possible values for the ListBlobsIncludeItem const type.

type ListPathsHierarchySegmentResponse 

type ListPathsHierarchySegmentResponse struct {
	// REQUIRED
	FileSystemName *string `xml:"ContainerName,attr"`

	// REQUIRED
	Segment *PathHierarchyListSegment `xml:"Blobs"`

	// REQUIRED
	ServiceEndpoint *string `xml:"ServiceEndpoint,attr"`
	Delimiter       *string `xml:"Delimiter"`
	Marker          *string `xml:"Marker"`
	MaxResults      *int32  `xml:"MaxResults"`
	NextMarker      *string `xml:"NextMarker"`
	Prefix          *string `xml:"Prefix"`
}

ListPathsHierarchySegmentResponse - An enumeration of blobs

type ModifiedAccessConditions 

type ModifiedAccessConditions struct {
	// Specify an ETag value to operate only on blobs with a matching value.
	IfMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has been modified since the specified date/time.
	IfModifiedSince *time.Time

	// Specify an ETag value to operate only on blobs without a matching value.
	IfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date/time.
	IfUnmodifiedSince *time.Time
}

ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

type Path 

type Path struct {
	ContentLength     *int64
	CreationTime      *string
	ETag              *string
	EncryptionContext *string

	// The name of the encryption scope under which the blob is encrypted.
	EncryptionScope *string
	ExpiryTime      *string
	Group           *string
	IsDirectory     *bool
	LastModified    *string
	Name            *string
	Owner           *string
	Permissions     *string
}

func (Path) MarshalJSON 

func (p Path) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type Path.

func (*Path) UnmarshalJSON 

func (p *Path) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type Path.

type PathClient 

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

PathClient contains the methods for the Path group. Don't use this type directly, use a constructor function instead.

func NewPathClient 

func NewPathClient(endpoint string, azClient *azcore.Client) *PathClient

NewPathClient creates a new instance of ServiceClient with the specified values.

  • endpoint - The URL of the service account, share, directory or file that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*PathClient) AppendData 

func (client *PathClient) AppendData(ctx context.Context, body io.ReadSeekCloser, options *PathClientAppendDataOptions, pathHTTPHeaders *PathHTTPHeaders, leaseAccessConditions *LeaseAccessConditions, cpkInfo *CPKInfo) (PathClientAppendDataResponse, error)

AppendData - Append data to the file. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • body - Initial data
  • options - PathClientAppendDataOptions contains the optional parameters for the PathClient.AppendData method.
  • PathHTTPHeaders - PathHTTPHeaders contains a group of parameters for the PathClient.Create method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • CPKInfo - CPKInfo contains a group of parameters for the PathClient.Create method.

func (*PathClient) Create 

func (client *PathClient) Create(ctx context.Context, options *PathClientCreateOptions, pathHTTPHeaders *PathHTTPHeaders, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions, sourceModifiedAccessConditions *SourceModifiedAccessConditions, cpkInfo *CPKInfo) (PathClientCreateResponse, 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: "*". If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientCreateOptions contains the optional parameters for the PathClient.Create method.
  • PathHTTPHeaders - PathHTTPHeaders contains a group of parameters for the PathClient.Create method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.
  • SourceModifiedAccessConditions - SourceModifiedAccessConditions contains a group of parameters for the PathClient.Create method.
  • CPKInfo - CPKInfo contains a group of parameters for the PathClient.Create method.

func (*PathClient) Delete 

func (client *PathClient) Delete(ctx context.Context, options *PathClientDeleteOptions, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions) (PathClientDeleteResponse, 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientDeleteOptions contains the optional parameters for the PathClient.Delete method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

func (*PathClient) Endpoint 

func (client *PathClient) Endpoint() string

func (*PathClient) FlushData 

func (client *PathClient) FlushData(ctx context.Context, options *PathClientFlushDataOptions, pathHTTPHeaders *PathHTTPHeaders, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions, cpkInfo *CPKInfo) (PathClientFlushDataResponse, error)

FlushData - Set the owner, group, permissions, or access control list for a path. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientFlushDataOptions contains the optional parameters for the PathClient.FlushData method.
  • PathHTTPHeaders - PathHTTPHeaders contains a group of parameters for the PathClient.Create method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.
  • CPKInfo - CPKInfo contains a group of parameters for the PathClient.Create method.

func (*PathClient) GetProperties 

func (client *PathClient) GetProperties(ctx context.Context, options *PathClientGetPropertiesOptions, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions) (PathClientGetPropertiesResponse, 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientGetPropertiesOptions contains the optional parameters for the PathClient.GetProperties method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

func (*PathClient) InternalClient 

func (client *PathClient) InternalClient() *azcore.Client

func (*PathClient) Lease 

func (client *PathClient) Lease(ctx context.Context, xmsLeaseAction PathLeaseAction, options *PathClientLeaseOptions, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions) (PathClientLeaseResponse, 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • 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.
  • options - PathClientLeaseOptions contains the optional parameters for the PathClient.Lease method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

func (*PathClient) Read 

func (client *PathClient) Read(ctx context.Context, options *PathClientReadOptions, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions, cpkInfo *CPKInfo) (PathClientReadResponse, 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientReadOptions contains the optional parameters for the PathClient.Read method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.
  • CPKInfo - CPKInfo contains a group of parameters for the PathClient.Create method.

func (*PathClient) SetAccessControl 

func (client *PathClient) SetAccessControl(ctx context.Context, options *PathClientSetAccessControlOptions, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions) (PathClientSetAccessControlResponse, error)

SetAccessControl - Set the owner, group, permissions, or access control list for a path. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientSetAccessControlOptions contains the optional parameters for the PathClient.SetAccessControl method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

func (*PathClient) SetAccessControlRecursive 

func (client *PathClient) SetAccessControlRecursive(ctx context.Context, mode PathSetAccessControlRecursiveMode, options *PathClientSetAccessControlRecursiveOptions) (PathClientSetAccessControlRecursiveResponse, error)

SetAccessControlRecursive - Set the access control list for a path and sub-paths. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • mode - Mode "set" sets POSIX access control rights on files and directories, "modify" modifies one or more POSIX access control rights that pre-exist on files and directories, "remove" removes one or more POSIX access control rights that were present earlier on files and directories
  • options - PathClientSetAccessControlRecursiveOptions contains the optional parameters for the PathClient.SetAccessControlRecursive method.

func (*PathClient) SetAccessControlRecursiveCreateRequest 

func (client *PathClient) SetAccessControlRecursiveCreateRequest(ctx context.Context, mode PathSetAccessControlRecursiveMode, options *PathClientSetAccessControlRecursiveOptions) (*policy.Request, error)

SetAccessControlRecursiveCreateRequest creates the SetAccessControlRecursive request.

func (*PathClient) SetAccessControlRecursiveHandleResponse 

func (client *PathClient) SetAccessControlRecursiveHandleResponse(resp *http.Response) (PathClientSetAccessControlRecursiveResponse, error)

SetAccessControlRecursiveHandleResponse handles the SetAccessControlRecursive response.

func (*PathClient) SetExpiry 

func (client *PathClient) SetExpiry(ctx context.Context, expiryOptions ExpiryOptions, options *PathClientSetExpiryOptions) (PathClientSetExpiryResponse, error)

SetExpiry - Sets the time a blob will expire and be deleted. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • expiryOptions - Required. Indicates mode of the expiry time
  • options - PathClientSetExpiryOptions contains the optional parameters for the PathClient.SetExpiry method.

func (*PathClient) Undelete 

func (client *PathClient) Undelete(ctx context.Context, options *PathClientUndeleteOptions) (PathClientUndeleteResponse, error)

Undelete - Undelete a path that was previously soft deleted If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • options - PathClientUndeleteOptions contains the optional parameters for the PathClient.Undelete method.

func (*PathClient) Update 

func (client *PathClient) Update(ctx context.Context, action PathUpdateAction, mode PathSetAccessControlRecursiveMode, body io.ReadSeekCloser, options *PathClientUpdateOptions, pathHTTPHeaders *PathHTTPHeaders, leaseAccessConditions *LeaseAccessConditions, modifiedAccessConditions *ModifiedAccessConditions) (PathClientUpdateResponse, 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. Concurrent writes to the same file using multiple clients are not 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]. If the operation fails it returns an *azcore.ResponseError type.

Generated from API version 2024-05-04

  • 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, "setAccessControl" to set the owner, group, permissions, or access control list for a file or directory, or "setAccessControlRecursive" to set the access control list for a directory recursively. 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.
  • mode - Mode "set" sets POSIX access control rights on files and directories, "modify" modifies one or more POSIX access control rights that pre-exist on files and directories, "remove" removes one or more POSIX access control rights that were present earlier on files and directories
  • body - Initial data
  • options - PathClientUpdateOptions contains the optional parameters for the PathClient.Update method.
  • PathHTTPHeaders - PathHTTPHeaders contains a group of parameters for the PathClient.Create method.
  • LeaseAccessConditions - LeaseAccessConditions contains a group of parameters for the PathClient.Create method.
  • ModifiedAccessConditions - ModifiedAccessConditions contains a group of parameters for the FileSystemClient.SetProperties method.

type PathClientAppendDataOptions 

type PathClientAppendDataOptions struct {
	// 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".
	ContentLength *int64

	// If file should be flushed after the append
	Flush *bool

	// Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release
	// the lease only on flush. If "acquire-release" it will acquire & complete the
	// operation & release the lease once operation is done.
	LeaseAction *LeaseAction

	// 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.
	LeaseDuration *int64

	// 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.
	Position *int64

	// Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// Specify the transactional crc64 for the body, to be validated by the service.
	TransactionalContentCRC64 []byte
}

PathClientAppendDataOptions contains the optional parameters for the PathClient.AppendData method.

func (*PathClientAppendDataOptions) SetCRC64 

func (a *PathClientAppendDataOptions) SetCRC64(v []byte)

type PathClientAppendDataResponse 

type PathClientAppendDataResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// ContentCRC64 contains the information returned from the x-ms-content-crc64 header response.
	ContentCRC64 []byte

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 []byte

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EncryptionKeySHA256 contains the information returned from the x-ms-encryption-key-sha256 header response.
	EncryptionKeySHA256 *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LeaseRenewed contains the information returned from the x-ms-lease-renewed header response.
	LeaseRenewed *bool

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientAppendDataResponse contains the response from method PathClient.AppendData.

type PathClientCreateOptions 

type PathClientCreateOptions struct {
	// Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries.
	// 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]".
	ACL *string

	// 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.
	Continuation *string

	// Specifies the encryption context to set on the file.
	EncryptionContext *string

	// The time to set the blob to expiry
	ExpiresOn *string

	// Required. Indicates mode of the expiry time
	ExpiryOptions *PathExpiryOptions

	// Optional. The owning group of the blob or directory.
	Group *string

	// 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.
	LeaseDuration *int64

	// 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".
	Mode *PathRenameMode

	// Optional. The owner of the blob or directory.
	Owner *string

	// 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.
	Permissions *string

	// 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.
	Properties *string

	// Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// 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.
	RenameSource *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// Required only for Create File and Create Directory. The value must be "file" or "directory".
	Resource *PathResourceType

	// A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match.
	SourceLeaseID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// 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 bitwise and not 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).
	Umask *string
}

PathClientCreateOptions contains the optional parameters for the PathClient.Create method.

type PathClientCreateResponse 

type PathClientCreateResponse struct {
	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// Continuation contains the information returned from the x-ms-continuation header response.
	Continuation *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EncryptionKeySHA256 contains the information returned from the x-ms-encryption-key-sha256 header response.
	EncryptionKeySHA256 *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientCreateResponse contains the response from method PathClient.Create.

type PathClientDeleteOptions 

type PathClientDeleteOptions struct {
	// 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.
	Continuation *string

	// If true, paginated behavior will be seen. Pagination is for the recursive ACL checks as a POSIX requirement in the server
	// and Delete in an atomic operation once the ACL checks are completed. If false
	// or missing, normal default behavior will kick in, which may timeout in case of very large directories due to recursive
	// ACL checks. This new parameter is introduced for backward compatibility.
	Paginated *bool

	// Required
	Recursive *bool

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

PathClientDeleteOptions contains the optional parameters for the PathClient.Delete method.

type PathClientDeleteResponse 

type PathClientDeleteResponse struct {
	// Continuation contains the information returned from the x-ms-continuation header response.
	Continuation *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// DeletionID contains the information returned from the x-ms-deletion-id header response.
	DeletionID *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string

	// XMSContinuation contains the information returned from the x-ms-continuation header response.
	XMSContinuation *string

	// XMSRequestID contains the information returned from the x-ms-request-id header response.
	XMSRequestID *string

	// XMSVersion contains the information returned from the x-ms-version header response.
	XMSVersion *string
}

PathClientDeleteResponse contains the response from method PathClient.Delete.

type PathClientFlushDataOptions 

type PathClientFlushDataOptions struct {
	// 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."
	Close *bool

	// 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".
	ContentLength *int64

	// Optional. If "acquire" it will acquire the lease. If "auto-renew" it will renew the lease. If "release" it will release
	// the lease only on flush. If "acquire-release" it will acquire & complete the
	// operation & release the lease once operation is done.
	LeaseAction *LeaseAction

	// 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.
	LeaseDuration *int64

	// 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.
	Position *int64

	// Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// 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.
	RetainUncommittedData *bool

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

PathClientFlushDataOptions contains the optional parameters for the PathClient.FlushData method.

type PathClientFlushDataResponse 

type PathClientFlushDataResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EncryptionKeySHA256 contains the information returned from the x-ms-encryption-key-sha256 header response.
	EncryptionKeySHA256 *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseRenewed contains the information returned from the x-ms-lease-renewed header response.
	LeaseRenewed *bool

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientFlushDataResponse contains the response from method PathClient.FlushData.

type PathClientGetPropertiesOptions 

type PathClientGetPropertiesOptions struct {
	// 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.
	Action *PathGetPropertiesAction

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// 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.
	Upn *bool
}

PathClientGetPropertiesOptions contains the optional parameters for the PathClient.GetProperties method.

type PathClientGetPropertiesResponse 

type PathClientGetPropertiesResponse struct {
	// ACL contains the information returned from the x-ms-acl header response.
	ACL *string

	// AcceptRanges contains the information returned from the Accept-Ranges header response.
	AcceptRanges *string

	// CacheControl contains the information returned from the Cache-Control header response.
	CacheControl *string

	// ContentDisposition contains the information returned from the Content-Disposition header response.
	ContentDisposition *string

	// ContentEncoding contains the information returned from the Content-Encoding header response.
	ContentEncoding *string

	// ContentLanguage contains the information returned from the Content-Language header response.
	ContentLanguage *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 *string

	// ContentRange contains the information returned from the Content-Range header response.
	ContentRange *string

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// Group contains the information returned from the x-ms-group header response.
	Group *string

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseDuration contains the information returned from the x-ms-lease-duration header response.
	LeaseDuration *string

	// LeaseState contains the information returned from the x-ms-lease-state header response.
	LeaseState *string

	// LeaseStatus contains the information returned from the x-ms-lease-status header response.
	LeaseStatus *string

	// Owner contains the information returned from the x-ms-owner header response.
	Owner *string

	// Permissions contains the information returned from the x-ms-permissions header response.
	Permissions *string

	// Properties contains the information returned from the x-ms-properties header response.
	Properties *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// ResourceType contains the information returned from the x-ms-resource-type header response.
	ResourceType *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientGetPropertiesResponse contains the response from method PathClient.GetProperties.

type PathClientLeaseOptions 

type PathClientLeaseOptions struct {
	// Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is
	// not in the correct format. See Guid Constructor (String) for a list of valid GUID
	// string formats.
	ProposedLeaseID *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// 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.
	XMSLeaseBreakPeriod *int32
}

PathClientLeaseOptions contains the optional parameters for the PathClient.Lease method.

type PathClientLeaseResponse 

type PathClientLeaseResponse struct {
	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseID contains the information returned from the x-ms-lease-id header response.
	LeaseID *string

	// LeaseTime contains the information returned from the x-ms-lease-time header response.
	LeaseTime *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientLeaseResponse contains the response from method PathClient.Lease.

type PathClientReadOptions 

type PathClientReadOptions struct {
	// The HTTP Range request header specifies one or more byte ranges of the resource to be retrieved.
	Range *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// 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).
	XMSRangeGetContentMD5 *bool
}

PathClientReadOptions contains the optional parameters for the PathClient.Read method.

type PathClientReadResponse 

type PathClientReadResponse struct {
	// AcceptRanges contains the information returned from the Accept-Ranges header response.
	AcceptRanges *string

	// Body contains the streaming response.
	Body io.ReadCloser

	// CacheControl contains the information returned from the Cache-Control header response.
	CacheControl *string

	// ContentDisposition contains the information returned from the Content-Disposition header response.
	ContentDisposition *string

	// ContentEncoding contains the information returned from the Content-Encoding header response.
	ContentEncoding *string

	// ContentLanguage contains the information returned from the Content-Language header response.
	ContentLanguage *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 *string

	// ContentRange contains the information returned from the Content-Range header response.
	ContentRange *string

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// EncryptionKeySHA256 contains the information returned from the x-ms-encryption-key-sha256 header response.
	EncryptionKeySHA256 *string

	// IsServerEncrypted contains the information returned from the x-ms-request-server-encrypted header response.
	IsServerEncrypted *bool

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// LeaseDuration contains the information returned from the x-ms-lease-duration header response.
	LeaseDuration *string

	// LeaseState contains the information returned from the x-ms-lease-state header response.
	LeaseState *string

	// LeaseStatus contains the information returned from the x-ms-lease-status header response.
	LeaseStatus *string

	// Properties contains the information returned from the x-ms-properties header response.
	Properties *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// ResourceType contains the information returned from the x-ms-resource-type header response.
	ResourceType *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string

	// XMSContentMD5 contains the information returned from the x-ms-content-md5 header response.
	XMSContentMD5 *string
}

PathClientReadResponse contains the response from method PathClient.Read.

type PathClientSetAccessControlOptions 

type PathClientSetAccessControlOptions struct {
	// Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries.
	// 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]".
	ACL *string

	// Optional. The owning group of the blob or directory.
	Group *string

	// Optional. The owner of the blob or directory.
	Owner *string

	// 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.
	Permissions *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

PathClientSetAccessControlOptions contains the optional parameters for the PathClient.SetAccessControl method.

type PathClientSetAccessControlRecursiveOptions 

type PathClientSetAccessControlRecursiveOptions struct {
	// Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries.
	// 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]".
	ACL *string

	// 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.
	Continuation *string

	// Optional. Valid for "SetAccessControlRecursive" operation. If set to false, the operation will terminate quickly on encountering
	// user errors (4XX). If true, the operation will ignore user errors and
	// proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag
	// is true in case of user errors. If not set the default value is false for
	// this.
	ForceFlag *bool

	// Optional. It specifies the maximum number of files or directories on which the acl change will be applied. If omitted or
	// greater than 2,000, the request will process up to 2,000 items
	MaxRecords *int32

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

PathClientSetAccessControlRecursiveOptions contains the optional parameters for the PathClient.SetAccessControlRecursive method.

type PathClientSetAccessControlRecursiveResponse 

type PathClientSetAccessControlRecursiveResponse struct {
	SetAccessControlRecursiveResponse

	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Continuation contains the information returned from the x-ms-continuation header response.
	Continuation *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientSetAccessControlRecursiveResponse contains the response from method PathClient.SetAccessControlRecursive.

type PathClientSetAccessControlResponse 

type PathClientSetAccessControlResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientSetAccessControlResponse contains the response from method PathClient.SetAccessControl.

type PathClientSetExpiryOptions 

type PathClientSetExpiryOptions struct {
	// The time to set the blob to expiry
	ExpiresOn *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

PathClientSetExpiryOptions contains the optional parameters for the PathClient.SetExpiry method.

type PathClientSetExpiryResponse 

type PathClientSetExpiryResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientSetExpiryResponse contains the response from method PathClient.SetExpiry.

type PathClientUndeleteOptions 

type PathClientUndeleteOptions struct {
	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32

	// Only for hierarchical namespace enabled accounts. Optional. The path of the soft deleted blob to undelete.
	UndeleteSource *string
}

PathClientUndeleteOptions contains the optional parameters for the PathClient.Undelete method.

type PathClientUndeleteResponse 

type PathClientUndeleteResponse struct {
	// ClientRequestID contains the information returned from the x-ms-client-request-id header response.
	ClientRequestID *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// ResourceType contains the information returned from the x-ms-resource-type header response.
	ResourceType *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

PathClientUndeleteResponse contains the response from method PathClient.Undelete.

type PathClientUpdateOptions 

type PathClientUpdateOptions struct {
	// Sets POSIX access control rights on files and directories. The value is a comma-separated list of access control entries.
	// 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]".
	ACL *string

	// 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."
	Close *bool

	// 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".
	ContentLength *int64

	// Optional. The number of paths processed with each invocation is limited. If the number of paths to be processed 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 percent-encoded and specified in a
	// subsequent invocation of setAccessControlRecursive operation.
	Continuation *string

	// Optional. Valid for "SetAccessControlRecursive" operation. If set to false, the operation will terminate quickly on encountering
	// user errors (4XX). If true, the operation will ignore user errors and
	// proceed with the operation on other sub-entities of the directory. Continuation token will only be returned when forceFlag
	// is true in case of user errors. If not set the default value is false for
	// this.
	ForceFlag *bool

	// Optional. The owning group of the blob or directory.
	Group *string

	// Optional. Valid for "SetAccessControlRecursive" operation. It specifies the maximum number of files or directories on which
	// the acl change will be applied. If omitted or greater than 2,000, the
	// request will process up to 2,000 items
	MaxRecords *int32

	// Optional. The owner of the blob or directory.
	Owner *string

	// 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.
	Permissions *string

	// 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.
	Position *int64

	// 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.
	Properties *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// 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.
	RetainUncommittedData *bool

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

PathClientUpdateOptions contains the optional parameters for the PathClient.Update method.

type PathClientUpdateResponse 

type PathClientUpdateResponse struct {
	SetAccessControlRecursiveResponse

	// AcceptRanges contains the information returned from the Accept-Ranges header response.
	AcceptRanges *string

	// CacheControl contains the information returned from the Cache-Control header response.
	CacheControl *string

	// ContentDisposition contains the information returned from the Content-Disposition header response.
	ContentDisposition *string

	// ContentEncoding contains the information returned from the Content-Encoding header response.
	ContentEncoding *string

	// ContentLanguage contains the information returned from the Content-Language header response.
	ContentLanguage *string

	// ContentLength contains the information returned from the Content-Length header response.
	ContentLength *int64

	// ContentMD5 contains the information returned from the Content-MD5 header response.
	ContentMD5 *string

	// ContentRange contains the information returned from the Content-Range header response.
	ContentRange *string

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// ETag contains the information returned from the ETag header response.
	ETag *azcore.ETag

	// LastModified contains the information returned from the Last-Modified header response.
	LastModified *time.Time

	// Properties contains the information returned from the x-ms-properties header response.
	Properties *string

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string

	// XMSContinuation contains the information returned from the x-ms-continuation header response.
	XMSContinuation *string
}

PathClientUpdateResponse contains the response from method PathClient.Update.

type PathExpiryOptions 

type PathExpiryOptions string
const (
	PathExpiryOptionsAbsolute           PathExpiryOptions = "Absolute"
	PathExpiryOptionsNeverExpire        PathExpiryOptions = "NeverExpire"
	PathExpiryOptionsRelativeToCreation PathExpiryOptions = "RelativeToCreation"
	PathExpiryOptionsRelativeToNow      PathExpiryOptions = "RelativeToNow"
)

func PossiblePathExpiryOptionsValues 

func PossiblePathExpiryOptionsValues() []PathExpiryOptions

PossiblePathExpiryOptionsValues returns the possible values for the PathExpiryOptions const type.

type PathGetPropertiesAction 

type PathGetPropertiesAction string
const (
	PathGetPropertiesActionGetAccessControl PathGetPropertiesAction = "getAccessControl"
	PathGetPropertiesActionGetStatus        PathGetPropertiesAction = "getStatus"
)

func PossiblePathGetPropertiesActionValues 

func PossiblePathGetPropertiesActionValues() []PathGetPropertiesAction

PossiblePathGetPropertiesActionValues returns the possible values for the PathGetPropertiesAction const type.

type PathHTTPHeaders 

type PathHTTPHeaders struct {
	// Optional. Sets the blob's cache control. If specified, this property is stored with the blob and returned with a read request.
	CacheControl *string

	// Optional. Sets the blob's Content-Disposition header.
	ContentDisposition *string

	// Optional. Sets the blob's content encoding. If specified, this property is stored with the blob and returned with a read
	// request.
	ContentEncoding *string

	// Optional. Set the blob's content language. If specified, this property is stored with the blob and returned with a read
	// request.
	ContentLanguage *string

	// Specify the transactional md5 for the body, to be validated by the service.
	ContentMD5 []byte

	// Optional. Sets the blob's content type. If specified, this property is stored with the blob and returned with a read request.
	ContentType *string

	// Specify the transactional md5 for the body, to be validated by the service.
	TransactionalContentHash []byte
}

PathHTTPHeaders contains a group of parameters for the PathClient.Create method.

type PathHierarchyListSegment 

type PathHierarchyListSegment struct {
	// REQUIRED
	PathItems    []*PathItemInternal `xml:"Blob"`
	PathPrefixes []*PathPrefix       `xml:"PathPrefix"`
}

func (PathHierarchyListSegment) MarshalXML 

func (b PathHierarchyListSegment) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type PathHierarchyListSegment.

type PathItemInternal 

type PathItemInternal struct {
	// REQUIRED
	Deleted *bool `xml:"Deleted"`

	// REQUIRED
	Name *string `xml:"Name"`

	// REQUIRED; Properties of a blob
	Properties *PathPropertiesInternal `xml:"Properties"`

	// REQUIRED
	Snapshot         *string `xml:"Snapshot"`
	DeletionID       *string `xml:"DeletionId"`
	IsCurrentVersion *bool   `xml:"IsCurrentVersion"`
	VersionID        *string `xml:"VersionId"`
}

PathItemInternal - An Azure Storage blob

type PathLeaseAction 

type PathLeaseAction string
const (
	PathLeaseActionAcquire PathLeaseAction = "acquire"
	PathLeaseActionBreak   PathLeaseAction = "break"
	PathLeaseActionChange  PathLeaseAction = "change"
	PathLeaseActionRelease PathLeaseAction = "release"
	PathLeaseActionRenew   PathLeaseAction = "renew"
)

func PossiblePathLeaseActionValues 

func PossiblePathLeaseActionValues() []PathLeaseAction

PossiblePathLeaseActionValues returns the possible values for the PathLeaseAction const type.

type PathList 

type PathList struct {
	Paths []*Path
}

func (PathList) MarshalJSON 

func (p PathList) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type PathList.

func (*PathList) UnmarshalJSON 

func (p *PathList) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type PathList.

type PathPrefix 

type PathPrefix struct {
	// REQUIRED
	Name *string `xml:"Name"`
}

type PathPropertiesInternal 

type PathPropertiesInternal struct {
	// REQUIRED
	ETag *azcore.ETag `xml:"Etag"`

	// REQUIRED
	LastModified         *time.Time `xml:"Last-Modified"`
	AccessTierChangeTime *time.Time `xml:"AccessTierChangeTime"`
	AccessTierInferred   *bool      `xml:"AccessTierInferred"`
	BlobSequenceNumber   *int64     `xml:"x-ms-blob-sequence-number"`
	CacheControl         *string    `xml:"Cache-Control"`
	ContentDisposition   *string    `xml:"Content-Disposition"`
	ContentEncoding      *string    `xml:"Content-Encoding"`
	ContentLanguage      *string    `xml:"Content-Language"`

	// Size in bytes
	ContentLength             *int64     `xml:"Content-Length"`
	ContentMD5                []byte     `xml:"Content-MD5"`
	ContentType               *string    `xml:"Content-Type"`
	CopyCompletionTime        *time.Time `xml:"CopyCompletionTime"`
	CopyID                    *string    `xml:"CopyId"`
	CopyProgress              *string    `xml:"CopyProgress"`
	CopySource                *string    `xml:"CopySource"`
	CopyStatusDescription     *string    `xml:"CopyStatusDescription"`
	CreationTime              *time.Time `xml:"Creation-Time"`
	CustomerProvidedKeySHA256 *string    `xml:"CustomerProvidedKeySha256"`
	DeleteTime                *time.Time `xml:"DeleteTime"`
	DeletedTime               *time.Time `xml:"DeletedTime"`
	DestinationSnapshot       *string    `xml:"DestinationSnapshot"`

	// The name of the encryption scope under which the blob is encrypted.
	EncryptionScope        *string    `xml:"EncryptionScope"`
	ExpiresOn              *time.Time `xml:"Expiry-Time"`
	IncrementalCopy        *bool      `xml:"IncrementalCopy"`
	IsSealed               *bool      `xml:"Sealed"`
	LastAccessedOn         *time.Time `xml:"LastAccessTime"`
	RemainingRetentionDays *int32     `xml:"RemainingRetentionDays"`
	ServerEncrypted        *bool      `xml:"ServerEncrypted"`
	TagCount               *int32     `xml:"TagCount"`
}

PathPropertiesInternal - Properties of a blob

func (PathPropertiesInternal) MarshalXML 

func (b PathPropertiesInternal) MarshalXML(enc *xml.Encoder, start xml.StartElement) error

MarshalXML implements the xml.Marshaller interface for type PathPropertiesInternal.

func (*PathPropertiesInternal) UnmarshalXML 

func (b *PathPropertiesInternal) UnmarshalXML(dec *xml.Decoder, start xml.StartElement) error

UnmarshalXML implements the xml.Unmarshaller interface for type PathPropertiesInternal.

type PathRenameMode 

type PathRenameMode string
const (
	PathRenameModeLegacy PathRenameMode = "legacy"
	PathRenameModePosix  PathRenameMode = "posix"
)

func PossiblePathRenameModeValues 

func PossiblePathRenameModeValues() []PathRenameMode

PossiblePathRenameModeValues returns the possible values for the PathRenameMode const type.

type PathResourceType 

type PathResourceType string
const (
	PathResourceTypeDirectory PathResourceType = "directory"
	PathResourceTypeFile      PathResourceType = "file"
)

func PossiblePathResourceTypeValues 

func PossiblePathResourceTypeValues() []PathResourceType

PossiblePathResourceTypeValues returns the possible values for the PathResourceType const type.

type PathSetAccessControlRecursiveMode 

type PathSetAccessControlRecursiveMode string
const (
	PathSetAccessControlRecursiveModeModify PathSetAccessControlRecursiveMode = "modify"
	PathSetAccessControlRecursiveModeRemove PathSetAccessControlRecursiveMode = "remove"
	PathSetAccessControlRecursiveModeSet    PathSetAccessControlRecursiveMode = "set"
)

func PossiblePathSetAccessControlRecursiveModeValues 

func PossiblePathSetAccessControlRecursiveModeValues() []PathSetAccessControlRecursiveMode

PossiblePathSetAccessControlRecursiveModeValues returns the possible values for the PathSetAccessControlRecursiveMode const type.

type PathUpdateAction 

type PathUpdateAction string
const (
	PathUpdateActionAppend                    PathUpdateAction = "append"
	PathUpdateActionFlush                     PathUpdateAction = "flush"
	PathUpdateActionSetAccessControl          PathUpdateAction = "setAccessControl"
	PathUpdateActionSetAccessControlRecursive PathUpdateAction = "setAccessControlRecursive"
	PathUpdateActionSetProperties             PathUpdateAction = "setProperties"
)

func PossiblePathUpdateActionValues 

func PossiblePathUpdateActionValues() []PathUpdateAction

PossiblePathUpdateActionValues returns the possible values for the PathUpdateAction const type.

type ServiceClient 

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

ServiceClient contains the methods for the Service group. Don't use this type directly, use a constructor function instead.

func NewServiceClient 

func NewServiceClient(endpoint string, azClient *azcore.Client) *ServiceClient

NewServiceClient creates a new instance of ServiceClient with the specified values.

  • endpoint - The URL of the service account, share, directory or file that is the target of the desired operation.
  • azClient - azcore.Client is a basic HTTP client. It consists of a pipeline and tracing provider.

func (*ServiceClient) Endpoint 

func (client *ServiceClient) Endpoint() string

func (*ServiceClient) InternalClient 

func (client *ServiceClient) InternalClient() *azcore.Client

func (*ServiceClient) ListFileSystemsCreateRequest 

func (client *ServiceClient) ListFileSystemsCreateRequest(ctx context.Context, options *ServiceClientListFileSystemsOptions) (*policy.Request, error)

NewListFileSystemsPager - List filesystems and their properties in given account.

Generated from API version 2024-05-04

  • options - ServiceClientListFileSystemsOptions contains the optional parameters for the ServiceClient.NewListFileSystemsPager method.

ListFileSystemsCreateRequest creates the ListFileSystems request.

func (*ServiceClient) ListFileSystemsHandleResponse 

func (client *ServiceClient) ListFileSystemsHandleResponse(resp *http.Response) (ServiceClientListFileSystemsResponse, error)

listFileSystemsHandleResponse handles the ListFileSystems response.

type ServiceClientListFileSystemsOptions 

type ServiceClientListFileSystemsOptions struct {
	// 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.
	Continuation *string

	// 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.
	MaxResults *int32

	// Filters results to filesystems within the specified prefix.
	Prefix *string

	// Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage
	// analytics logging is enabled.
	RequestID *string

	// The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for Blob Service Operations.
	// [https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations]
	Timeout *int32
}

ServiceClientListFileSystemsOptions contains the optional parameters for the ServiceClient.NewListFileSystemsPager method.

type ServiceClientListFileSystemsResponse 

type ServiceClientListFileSystemsResponse struct {
	FileSystemList

	// ContentType contains the information returned from the Content-Type header response.
	ContentType *string

	// Continuation contains the information returned from the x-ms-continuation header response.
	Continuation *string

	// Date contains the information returned from the Date header response.
	Date *time.Time

	// RequestID contains the information returned from the x-ms-request-id header response.
	RequestID *string

	// Version contains the information returned from the x-ms-version header response.
	Version *string
}

ServiceClientListFileSystemsResponse contains the response from method ServiceClient.NewListFileSystemsPager.

type SetAccessControlRecursiveResponse 

type SetAccessControlRecursiveResponse struct {
	DirectoriesSuccessful *int32
	FailedEntries         []*ACLFailedEntry
	FailureCount          *int32
	FilesSuccessful       *int32
}

func (SetAccessControlRecursiveResponse) MarshalJSON 

func (s SetAccessControlRecursiveResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type SetAccessControlRecursiveResponse.

func (*SetAccessControlRecursiveResponse) UnmarshalJSON 

func (s *SetAccessControlRecursiveResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type SetAccessControlRecursiveResponse.

type SourceModifiedAccessConditions 

type SourceModifiedAccessConditions struct {
	// Specify an ETag value to operate only on blobs with a matching value.
	SourceIfMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has been modified since the specified date/time.
	SourceIfModifiedSince *time.Time

	// Specify an ETag value to operate only on blobs without a matching value.
	SourceIfNoneMatch *azcore.ETag

	// Specify this header value to operate only on a blob if it has not been modified since the specified date/time.
	SourceIfUnmodifiedSince *time.Time
}

SourceModifiedAccessConditions contains a group of parameters for the PathClient.Create method.

type StorageError 

type StorageError struct {
	// The service error response object.
	Error *StorageErrorError
}

func (StorageError) MarshalJSON 

func (s StorageError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageError.

func (*StorageError) UnmarshalJSON 

func (s *StorageError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageError.

type StorageErrorError 

type StorageErrorError struct {
	// The service error code.
	Code *string

	// The service error message.
	Message *string
}

StorageErrorError - The service error response object.

func (StorageErrorError) MarshalJSON 

func (s StorageErrorError) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaller interface for type StorageErrorError.

func (*StorageErrorError) UnmarshalJSON 

func (s *StorageErrorError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaller interface for type StorageErrorError.

type TransactionalContentSetter 

type TransactionalContentSetter interface {
	SetCRC64([]byte)
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

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