Class DataLakeDirectoryClient

Package version

Hierarchy

DataLakePathClient
- DataLakeDirectoryClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new DataLakeDirectoryClient(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options: StoragePipelineOptions): DataLakeDirectoryClient
new DataLakeDirectoryClient(url: string, pipeline: Pipeline): DataLakeDirectoryClient

Inherited from DataLakePathClient.constructor

Overrides StorageClient.constructor
- Defined in clients.ts:84
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns DataLakeDirectoryClient
Inherited from DataLakePathClient.constructor

Overrides StorageClient.constructor
- Defined in clients.ts:100
Parameters
- url: string
- pipeline: Pipeline
Returns DataLakeDirectoryClient

Properties

accountName

accountName: string

Protected blobEndpointUrl

blobEndpointUrl: string

credential

credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential

Protected dfsEndpointUrl

dfsEndpointUrl: string

Protected isHttps

isHttps: boolean

Protected storageClientContext

storageClientContext: StorageClientContext

url

url: string

Accessors

fileSystemName

fileSystemName:

name

name:

Methods

create

create(resourceType: PathResourceType, options: PathCreateOptions): Promise<PathCreateResponse>
create(options: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

Overrides DataLakePathClient.create
- Defined in clients.ts:619
Parameters
- resourceType: PathResourceType
- Optional options: PathCreateOptions
Returns Promise<PathCreateResponse>
Overrides DataLakePathClient.create
- Defined in clients.ts:633
Parameters
- Optional options: DirectoryCreateOptions
Returns Promise<DirectoryCreateResponse>

delete

delete(recursive: undefined | false | true, options?: PathDeleteOptions): Promise<PathDeleteResponse>

Inherited from DataLakePathClient.delete
- Defined in clients.ts:246
Parameters
- Optional recursive: undefined | false | true
- Default value options: PathDeleteOptions = {}
Returns Promise<PathDeleteResponse>

getAccessControl

getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>

Inherited from DataLakePathClient.getAccessControl
- Defined in clients.ts:289
Parameters
- Default value options: PathGetAccessControlOptions = {}
Returns Promise<PathGetAccessControlResponse>

getDataLakeLeaseClient

getDataLakeLeaseClient(proposeLeaseId: undefined | string): DataLakeLeaseClient

Inherited from DataLakePathClient.getDataLakeLeaseClient
- Defined in clients.ts:196
Parameters
- Optional proposeLeaseId: undefined | string
Returns DataLakeLeaseClient

getFileClient

getFileClient(fileName: string): DataLakeFileClient

- Defined in clients.ts:695
Parameters
- fileName: string
Returns DataLakeFileClient

getProperties

getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>

Inherited from DataLakePathClient.getProperties
- Defined in clients.ts:408
Parameters
- Default value options: PathGetPropertiesOptions = {}
Returns Promise<PathGetPropertiesResponse>

getSubdirectoryClient

getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClient

- Defined in clients.ts:681
Parameters
- subdirectoryName: string
Returns DataLakeDirectoryClient

move

move(destinationPath: string, options: PathMoveOptions): Promise<PathMoveResponse>
move(destinationFileSystem: string, destinationPath: string, options: PathMoveOptions): Promise<PathMoveResponse>

Inherited from DataLakePathClient.move
- Defined in clients.ts:527
Parameters
- destinationPath: string
- Optional options: PathMoveOptions
Returns Promise<PathMoveResponse>
Inherited from DataLakePathClient.move
- Defined in clients.ts:540
Parameters
- destinationFileSystem: string
- destinationPath: string
- Optional options: PathMoveOptions
Returns Promise<PathMoveResponse>

setAccessControl

setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>

Inherited from DataLakePathClient.setAccessControl
- Defined in clients.ts:327
Parameters
- acl: PathAccessControlItem[]
- Default value options: PathSetAccessControlOptions = {}
Returns Promise<PathSetAccessControlResponse>

setHttpHeaders

setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>

Inherited from DataLakePathClient.setHttpHeaders
- Defined in clients.ts:444
Parameters
- httpHeaders: PathHttpHeaders
- Default value options: PathSetHttpHeadersOptions = {}
Returns Promise<PathSetHttpHeadersResponse>

setMetadata

setMetadata(metadata: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>

Inherited from DataLakePathClient.setMetadata
- Defined in clients.ts:492
Parameters
- Optional metadata: Metadata
- Default value options: PathSetMetadataOptions = {}
Returns Promise<PathSetMetadataResponse>

setPermissions

setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>

Inherited from DataLakePathClient.setPermissions
- Defined in clients.ts:365
Parameters
- permissions: PathPermissions
- Default value options: PathSetPermissionsOptions = {}
Returns Promise<PathSetPermissionsResponse>

toDirectoryClient

toDirectoryClient(): DataLakeDirectoryClient

Inherited from DataLakePathClient.toDirectoryClient
- Defined in clients.ts:175
Returns DataLakeDirectoryClient

toFileClient

toFileClient(): DataLakeFileClient

Inherited from DataLakePathClient.toFileClient
- Defined in clients.ts:185
Returns DataLakeFileClient

Generated using TypeDoc