AzDatalake APIView

sdk/storage/azdatalake/common.go

@@ -0,0 +1,31 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package azdatalake
+
+import (
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/generated"
+)
+
+// ClientOptions contains the optional parameters when creating a Client.
+type ClientOptions struct {
+	azcore.ClientOptions
+}
+
+const SnapshotTimeFormat = "2006-01-02T15:04:05.0000000Z07:00"
+
+// AccessConditions identifies container-specific access conditions which you optionally set.
+type AccessConditions struct {
+	ModifiedAccessConditions *ModifiedAccessConditions
+	LeaseAccessConditions    *LeaseAccessConditions
+}
+
+// LeaseAccessConditions contains optional parameters to access leased entity.
+type LeaseAccessConditions = generated.LeaseAccessConditions
+
+// ModifiedAccessConditions contains a group of parameters for specifying access conditions.
+type ModifiedAccessConditions = generated.ModifiedAccessConditions

sdk/storage/azdatalake/directory/client.go

@@ -0,0 +1,73 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package directory
+
+import (
+	"context"
+	"github.com/Azure/azure-sdk-for-go/sdk/azcore"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/exported"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/path"
+)
+
+// Client represents a URL to the Azure Datalake Storage service allowing you to manipulate datalake directories.
+type Client struct {
+	path.Client
+}
+
+// NewClient creates an instance of Client with the specified values.
+//   - serviceURL - the URL of the storage account e.g. https://<account>.dfs.core.windows.net/
+//   - cred - an Azure AD credential, typically obtained via the azidentity module
+//   - options - client options; pass nil to accept the default values
+func NewClient(serviceURL string, cred azcore.TokenCredential, options *azdatalake.ClientOptions) (*Client, error) {
+	return nil, nil
+}
+
+// NewClientWithNoCredential creates an instance of Client with the specified values.
+// This is used to anonymously access a storage account or with a shared access signature (SAS) token.
+//   - serviceURL - the URL of the storage account e.g. https://<account>.dfs.core.windows.net/?<sas token>
+//   - options - client options; pass nil to accept the default values
+func NewClientWithNoCredential(serviceURL string, options *azdatalake.ClientOptions) (*Client, error) {
+	return nil, nil
+}
+
+// NewClientWithSharedKeyCredential creates an instance of Client with the specified values.
+//   - serviceURL - the URL of the storage account e.g. https://<account>.dfs.core.windows.net/
+//   - cred - a SharedKeyCredential created with the matching storage account and access key
+//   - options - client options; pass nil to accept the default values
+func NewClientWithSharedKeyCredential(serviceURL string, cred *exported.SharedKeyCredential, options *azdatalake.ClientOptions) (*Client, error) {
+	return nil, nil
+}
+
+// NewClientFromConnectionString creates an instance of Client with the specified values.
+//   - connectionString - a connection string for the desired storage account
+//   - options - client options; pass nil to accept the default values
+func NewClientFromConnectionString(connectionString string, options *azdatalake.ClientOptions) (*Client, error) {
+	return nil, nil
+}
+
+// Create creates a new directory (dfs1).
+func (d *Client) Create(ctx context.Context, options *CreateOptions) (CreateResponse, error) {
+	return CreateResponse{}, nil
+}
+
+// Delete removes the directory (dfs1).
+func (d *Client) Delete(ctx context.Context, options *DeleteOptions) (DeleteResponse, error) {
+	//TODO: pass recursive = true
+	return DeleteResponse{}, nil
+}
+
+// GetProperties returns the properties of the directory (blob3). #TODO: we may just move this method to path client
+func (d *Client) GetProperties(ctx context.Context, options *GetPropertiesOptions) (GetPropertiesResponse, error) {
+	// TODO: format blob response to path response
+	return GetPropertiesResponse{}, nil
+}
+
+// Rename renames the directory (dfs1).
+func (d *Client) Rename(ctx context.Context, newName string, options *RenameOptions) (RenameResponse, error) {
+	return RenameResponse{}, nil
+}

sdk/storage/azdatalake/directory/constants.go

@@ -0,0 +1,35 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package directory
+
+import (
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/path"
+)
+
+// RenameMode defines the rename mode for RenameDirectory
+type RenameMode = path.RenameMode
+
+const (
+	RenameModeLegacy RenameMode = path.RenameModeLegacy
+	RenameModePosix  RenameMode = path.RenameModePosix
+)
+
+// SetAccessControlRecursiveMode defines the set access control recursive mode for SetAccessControlRecursive
+type SetAccessControlRecursiveMode = path.SetAccessControlRecursiveMode
+
+const (
+	SetAccessControlRecursiveModeSet    SetAccessControlRecursiveMode = path.SetAccessControlRecursiveModeSet
+	SetAccessControlRecursiveModeModify SetAccessControlRecursiveMode = path.SetAccessControlRecursiveModeModify
+	SetAccessControlRecursiveModeRemove SetAccessControlRecursiveMode = path.SetAccessControlRecursiveModeRemove
+)
+
+type EncryptionAlgorithmType = path.EncryptionAlgorithmType
+
+const (
+	EncryptionAlgorithmTypeNone   EncryptionAlgorithmType = path.EncryptionAlgorithmTypeNone
+	EncryptionAlgorithmTypeAES256 EncryptionAlgorithmType = path.EncryptionAlgorithmTypeAES256
+)

sdk/storage/azdatalake/directory/models.go

@@ -0,0 +1,132 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package directory
+
+import (
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob/blob"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/generated"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/path"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/shared"
+	"time"
+)
+
+// CreateOptions contains the optional parameters when calling the Create operation. dfs endpoint
+type CreateOptions struct {
+	// AccessConditions contains parameters for accessing the file.
+	AccessConditions *azdatalake.AccessConditions
+	// Metadata is a map of name-value pairs to associate with the file storage object.
+	Metadata map[string]*string
+	// CPKInfo contains a group of parameters for client provided encryption key.
+	CPKInfo *CPKInfo
+	// HTTPHeaders contains the HTTP headers for path operations.
+	HTTPHeaders *HTTPHeaders
+	//PathExpiryOptions *ExpiryOptions
+	// LeaseDuration specifies the duration of the lease.
+	LeaseDuration *time.Duration
+	// ProposedLeaseID specifies the proposed lease ID for the file.
+	ProposedLeaseID *string
+	// Permissions is the octal representation of the permissions for user, group and mask.
+	Permissions *string
+	// Umask is the umask for the file.
+	Umask *string
+	// Owner is the owner of the file.
+	Owner *string
+	// Group is the owning group of the file.
+	Group *string
+	// ACL is the access control list for the file.
+	ACL *string
+}
+
+func (o *CreateOptions) format() (*generated.LeaseAccessConditions, *generated.ModifiedAccessConditions, *generated.PathHTTPHeaders, error) {
+	// TODO: add all other required options for the create operation, we don't need sourceModAccCond since this is not rename
+	leaseAccessConditions, modifiedAccessConditions := shared.FormatPathAccessConditions(o.AccessConditions)
+	httpHeaders := &generated.PathHTTPHeaders{
+		CacheControl:             o.HTTPHeaders.CacheControl,
+		ContentDisposition:       o.HTTPHeaders.ContentDisposition,
+		ContentEncoding:          o.HTTPHeaders.ContentEncoding,
+		ContentLanguage:          o.HTTPHeaders.ContentLanguage,
+		ContentMD5:               o.HTTPHeaders.ContentMD5,
+		ContentType:              o.HTTPHeaders.ContentType,
+		TransactionalContentHash: o.HTTPHeaders.ContentMD5,
+	}
+	return leaseAccessConditions, modifiedAccessConditions, httpHeaders, nil
+}
+
+// DeleteOptions contains the optional parameters when calling the Delete operation. dfs endpoint
+type DeleteOptions struct {
+	// AccessConditions specifies parameters for accessing the directory
+	AccessConditions *azdatalake.AccessConditions
+}
+
+func (o *DeleteOptions) format() (*generated.LeaseAccessConditions, *generated.ModifiedAccessConditions, error) {
+	leaseAccessConditions, modifiedAccessConditions := shared.FormatPathAccessConditions(o.AccessConditions)
+	return leaseAccessConditions, modifiedAccessConditions, nil
+}
+
+type RenameOptions struct {
+	// SourceModifiedAccessConditions specifies parameters for accessing the source directory
+	SourceModifiedAccessConditions *SourceModifiedAccessConditions
+	// AccessConditions specifies parameters for accessing the destination directory
+	AccessConditions *azdatalake.AccessConditions
+}
+
+// GetPropertiesOptions contains the optional parameters for the Client.GetProperties method
+type GetPropertiesOptions struct {
+	AccessConditions *azdatalake.AccessConditions
+	CPKInfo          *CPKInfo
+}
+
+func (o *GetPropertiesOptions) format() *blob.GetPropertiesOptions {
+	if o == nil {
+		return nil
+	}
+	accessConditions := shared.FormatBlobAccessConditions(o.AccessConditions)
+	return &blob.GetPropertiesOptions{
+		AccessConditions: accessConditions,
+		CPKInfo: &blob.CPKInfo{
+			EncryptionKey:       o.CPKInfo.EncryptionKey,
+			EncryptionAlgorithm: o.CPKInfo.EncryptionAlgorithm,
+			EncryptionKeySHA256: o.CPKInfo.EncryptionKeySHA256,
+		},
+	}
+}
+
+// ===================================== PATH IMPORTS ===========================================
+
+// CPKInfo contains a group of parameters for client provided encryption key.
+type CPKInfo = path.CPKInfo
+
+// CPKScopeInfo contains a group of parameters for client provided encryption scope.
+type CPKScopeInfo = path.CPKScopeInfo
+
+// HTTPHeaders contains the HTTP headers for path operations.
+type HTTPHeaders = path.HTTPHeaders
+
+// SourceModifiedAccessConditions identifies the source path access conditions.
+type SourceModifiedAccessConditions = path.SourceModifiedAccessConditions
+
+// SetAccessControlOptions contains the optional parameters when calling the SetAccessControl operation.
+type SetAccessControlOptions = path.SetAccessControlOptions
+
+// GetAccessControlOptions contains the optional parameters when calling the GetAccessControl operation.
+type GetAccessControlOptions = path.GetAccessControlOptions
+
+// SetAccessControlRecursiveOptions contains the optional parameters when calling the SetAccessControlRecursive operation.
+type SetAccessControlRecursiveOptions = path.SetAccessControlRecursiveOptions
+
+// SetMetadataOptions contains the optional parameters when calling the SetMetadata operation.
+type SetMetadataOptions = path.SetMetadataOptions
+
+// SetHTTPHeadersOptions contains the optional parameters when calling the SetHTTPHeaders operation.
+type SetHTTPHeadersOptions = path.SetHTTPHeadersOptions
+
+// RemoveAccessControlRecursiveOptions contains the optional parameters when calling the RemoveAccessControlRecursive operation.
+type RemoveAccessControlRecursiveOptions = path.RemoveAccessControlRecursiveOptions
+
+// UpdateAccessControlRecursiveOptions contains the optional parameters when calling the UpdateAccessControlRecursive operation.
+type UpdateAccessControlRecursiveOptions = path.UpdateAccessControlRecursiveOptions

sdk/storage/azdatalake/directory/responses.go

@@ -0,0 +1,45 @@
+//go:build go1.18
+// +build go1.18
+
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package directory
+
+import (
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/generated"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/path"
+)
+
+// CreateResponse contains the response fields for the Create operation.
+type CreateResponse = generated.PathClientCreateResponse
+
+// DeleteResponse contains the response fields for the Delete operation.
+type DeleteResponse = generated.PathClientDeleteResponse
+
+// SetAccessControlResponse contains the response fields for the SetAccessControl operation.
+type SetAccessControlResponse = path.SetAccessControlResponse
+
+// SetAccessControlRecursiveResponse contains the response fields for the SetAccessControlRecursive operation.
+type SetAccessControlRecursiveResponse = path.SetAccessControlRecursiveResponse
+
+// UpdateAccessControlRecursiveResponse contains the response fields for the UpdateAccessControlRecursive operation.
+type UpdateAccessControlRecursiveResponse = path.SetAccessControlRecursiveResponse
+
+// RemoveAccessControlRecursiveResponse contains the response fields for the RemoveAccessControlRecursive operation.
+type RemoveAccessControlRecursiveResponse = path.SetAccessControlRecursiveResponse
+
+// GetPropertiesResponse contains the response fields for the GetProperties operation.
+type GetPropertiesResponse = path.GetPropertiesResponse
+
+// SetMetadataResponse contains the response fields for the SetMetadata operation.
+type SetMetadataResponse = path.SetMetadataResponse
+
+// SetHTTPHeadersResponse contains the response fields for the SetHTTPHeaders operation.
+type SetHTTPHeadersResponse = path.SetHTTPHeadersResponse
+
+// RenameResponse contains the response fields for the Rename operation.
+type RenameResponse = path.CreateResponse
+
+// GetAccessControlResponse contains the response fields for the GetAccessControl operation.
+type GetAccessControlResponse = path.GetAccessControlResponse