paths

Documentation

Index

• type Client
  • func NewWithBaseUri(baseUri string) (*Client, error)
  • func (c Client) Create(ctx context.Context, fileSystemName string, path string, input CreateInput) (resp CreateResponse, err error)
  • func (c Client) Delete(ctx context.Context, fileSystemName string, path string) (resp DeleteResponse, err error)
  • func (c Client) GetProperties(ctx context.Context, fileSystemName string, path string, ...) (resp GetPropertiesResponse, err error)
  • func (c Client) SetAccessControl(ctx context.Context, fileSystemName string, path string, ...) (resp SetPropertiesResponse, err error)
• type CreateInput
  • func (c CreateInput) ToHeaders() *client.Headers
  • func (c CreateInput) ToOData() *odata.Query
  • func (c CreateInput) ToQuery() *client.QueryParams
• type CreateResponse
• type DeleteResponse
• type GetPropertiesAction
• type GetPropertiesInput
• type GetPropertiesResponse
• type PathId
  • func NewPathID(accountId accounts.AccountId, fileSystemName, path string) PathId
  • func ParsePathID(input, domainSuffix string) (*PathId, error)
  • func (b PathId) ID() string
  • func (b PathId) String() string
• type PathResource
• type SetAccessControlInput
• type SetPropertiesResponse

Types

type Client

type Client struct {
	Client *storage.Client
}

Client is the base client for Data Lake Storage Path

func NewWithBaseUri

func NewWithBaseUri(baseUri string) (*Client, error)

func (Client) Create

func (c Client) Create(ctx context.Context, fileSystemName string, path string, input CreateInput) (resp CreateResponse, err error)

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

func (Client) Delete

func (c Client) Delete(ctx context.Context, fileSystemName string, path string) (resp DeleteResponse, err error)

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

func (Client) GetProperties

func (c Client) GetProperties(ctx context.Context, fileSystemName string, path string, input GetPropertiesInput) (resp GetPropertiesResponse, err error)

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

func (Client) SetAccessControl

func (c Client) SetAccessControl(ctx context.Context, fileSystemName string, path string, input SetAccessControlInput) (resp SetPropertiesResponse, err error)

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

type CreateInput

type CreateInput struct {
	Resource PathResource
}

func (CreateInput) ToHeaders

func (c CreateInput) ToHeaders() *client.Headers

func (CreateInput) ToOData

func (c CreateInput) ToOData() *odata.Query

func (CreateInput) ToQuery

func (c CreateInput) ToQuery() *client.QueryParams

type CreateResponse

type CreateResponse struct {
	HttpResponse *client.Response
}

type DeleteResponse

type DeleteResponse struct {
	HttpResponse *client.Response
}

type GetPropertiesAction

type GetPropertiesAction string

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

type GetPropertiesInput

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

type GetPropertiesResponse

type GetPropertiesResponse struct {
	HttpResponse *client.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 PathId

type PathId struct {
	// AccountId specifies the ID of the Storage Account where this path exists.
	AccountId accounts.AccountId

	// FileSystemName specifies the name of the Data Lake FileSystem where this Path exists.
	FileSystemName string

	// Path specifies the path in question.
	Path string
}

func NewPathID

func NewPathID(accountId accounts.AccountId, fileSystemName, path string) PathId

func ParsePathID

func ParsePathID(input, domainSuffix string) (*PathId, error)

ParsePathID parses `input` into a Path ID using a known `domainSuffix`

func (PathId) ID

func (b PathId) ID() string

func (PathId) String

func (b PathId) String() string

type PathResource

type PathResource string

const PathResourceDirectory PathResource = "directory"

const PathResourceFile PathResource = "file"

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
}

type SetPropertiesResponse

type SetPropertiesResponse struct {
	HttpResponse *client.Response
}