paths

Documentation

Index

• Constants
• func UserAgent() string
• type Client
  • func New() Client
  • func NewWithEnvironment(environment azure.Environment) Client
  • func (client Client) Create(ctx context.Context, accountName string, fileSystemName string, path string, ...) (result autorest.Response, err error)
  • func (client Client) CreatePreparer(ctx context.Context, accountName string, fileSystemName string, path string, ...) (*http.Request, error)
  • func (client Client) CreateResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client Client) CreateSender(req *http.Request) (*http.Response, error)
  • func (client Client) Delete(ctx context.Context, accountName string, fileSystemName string, path string) (result autorest.Response, err error)
  • func (client Client) DeletePreparer(ctx context.Context, accountName string, fileSystemName string, path string) (*http.Request, error)
  • func (client Client) DeleteResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client Client) DeleteSender(req *http.Request) (*http.Response, error)
  • func (client Client) GetProperties(ctx context.Context, accountName string, fileSystemName string, path string, ...) (result GetPropertiesResponse, err error)
  • func (client Client) GetPropertiesPreparer(ctx context.Context, accountName string, fileSystemName string, path string, ...) (*http.Request, error)
  • func (client Client) GetPropertiesResponder(resp *http.Response) (result GetPropertiesResponse, err error)
  • func (client Client) GetPropertiesSender(req *http.Request) (*http.Response, error)
  • func (client Client) GetResourceID(accountName, fileSystemName, path string) string
  • func (client Client) SetAccessControl(ctx context.Context, accountName string, fileSystemName string, path string, ...) (result autorest.Response, err error)
  • func (client Client) SetAccessControlPreparer(ctx context.Context, accountName string, fileSystemName string, path string, ...) (*http.Request, error)
  • func (client Client) SetAccessControlResponder(resp *http.Response) (result autorest.Response, err error)
  • func (client Client) SetAccessControlSender(req *http.Request) (*http.Response, error)
• type CreateInput
• type GetPropertiesAction
• type GetPropertiesResponse
• type PathResource
• type ResourceID
  • func ParseResourceID(id string) (*ResourceID, error)
• type SetAccessControlInput

Constants

const APIVersion = "2018-11-09"

APIVersion is the version of the API used for all Storage API Operations

Functions

func UserAgent

func UserAgent() string

Types

type Client

type Client struct {
	autorest.Client
	BaseURI string
}

Client is the base client for Data Lake Storage Path

func New

func New() Client

New creates an instance of the Data Lake Storage Path client.

func NewWithEnvironment

func NewWithEnvironment(environment azure.Environment) Client

NewWithEnvironment creates an instance of the Data Lake Storage Path client.

func (Client) Create

func (client Client) Create(ctx context.Context, accountName string, fileSystemName string, path string, input CreateInput) (result autorest.Response, err error)

Create creates a Data Lake Store Gen2 Path within a Storage Account

func (Client) CreatePreparer

func (client Client) CreatePreparer(ctx context.Context, accountName string, fileSystemName string, path string, input CreateInput) (*http.Request, error)

CreatePreparer prepares the Create request.

func (Client) CreateResponder

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

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

func (Client) CreateSender

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

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

func (Client) Delete

func (client Client) Delete(ctx context.Context, accountName string, fileSystemName string, path string) (result autorest.Response, err error)

Delete deletes a Data Lake Store Gen2 FileSystem within a Storage Account

func (Client) DeletePreparer

func (client Client) DeletePreparer(ctx context.Context, accountName string, fileSystemName string, path string) (*http.Request, error)

DeletePreparer prepares the Delete request.

func (Client) DeleteResponder

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

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

func (Client) DeleteSender

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

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

func (Client) GetProperties

func (client Client) GetProperties(ctx context.Context, accountName string, fileSystemName string, path string, action GetPropertiesAction) (result GetPropertiesResponse, err error)

GetProperties gets the properties for a Data Lake Store Gen2 Path in a FileSystem within a Storage Account

func (Client) GetPropertiesPreparer

func (client Client) GetPropertiesPreparer(ctx context.Context, accountName string, fileSystemName string, path string, action GetPropertiesAction) (*http.Request, error)

GetPropertiesPreparer prepares the GetProperties request.

func (Client) GetPropertiesResponder

func (client Client) GetPropertiesResponder(resp *http.Response) (result GetPropertiesResponse, err error)

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

func (Client) GetPropertiesSender

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

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

func (Client) GetResourceID

func (client Client) GetResourceID(accountName, fileSystemName, path string) string

GetResourceID returns the Resource ID for the given Data Lake Storage FileSystem This can be useful when, for example, you're using this as a unique identifier

func (Client) SetAccessControl

func (client Client) SetAccessControl(ctx context.Context, accountName string, fileSystemName string, path string, input SetAccessControlInput) (result autorest.Response, err error)

SetProperties sets the access control properties for a Data Lake Store Gen2 Path within a Storage Account File System

func (Client) SetAccessControlPreparer

func (client Client) SetAccessControlPreparer(ctx context.Context, accountName string, fileSystemName string, path string, input SetAccessControlInput) (*http.Request, error)

SetAccessControlPreparer prepares the SetAccessControl request.

func (Client) SetAccessControlResponder

func (client Client) SetAccessControlResponder(resp *http.Response) (result autorest.Response, err error)

SetAccessControlResponder handles the response to the SetAccessControl request. The method always closes the http.Response Body.

func (Client) SetAccessControlSender

func (client Client) SetAccessControlSender(req *http.Request) (*http.Response, error)

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

type CreateInput

type CreateInput struct {
	Resource PathResource
}

type GetPropertiesAction

type GetPropertiesAction string

const (
	GetPropertiesActionGetStatus        GetPropertiesAction = "getStatus"
	GetPropertiesActionGetAccessControl GetPropertiesAction = "getAccessControl"
)

type GetPropertiesResponse

type GetPropertiesResponse struct {
	autorest.Response

	ETag         string
	LastModified time.Time
	// ResourceType is only returned for GetPropertiesActionGetStatus requests
	ResourceType PathResource
	Owner        string
	Group        string
	// ACL is only returned for GetPropertiesActionGetAccessControl requests
	ACL string
}

type PathResource

type PathResource string

const PathResourceDirectory PathResource = "directory"

const PathResourceFile PathResource = "file"

type ResourceID

type ResourceID struct {
	AccountName    string
	FileSystemName string
	Path           string
}

func ParseResourceID

func ParseResourceID(id string) (*ResourceID, error)

ParseResourceID parses the specified Resource ID and returns an object which can be used to interact with the Data Lake Storage FileSystem API's

type SetAccessControlInput

type SetAccessControlInput struct {
	Owner *string
	Group *string
	ACL   *string

	// Optional - A date and time value.
	// Specify this header to perform the operation only if the resource has been modified since the specified date and time.
	IfModifiedSince *string

	// Optional - A date and time value.
	// Specify this header to perform the operation only if the resource has not been modified since the specified date and time.
	IfUnmodifiedSince *string
}