Class DataLakeFileClient

Package version

Hierarchy

DataLakePathClient
- DataLakeFileClient

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

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

Overrides DataLakePathClient.constructor
- Defined in clients.ts:727
Parameters
- url: string
- Optional credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential
- Optional options: StoragePipelineOptions
Returns DataLakeFileClient
Overrides DataLakePathClient.constructor
- Defined in clients.ts:743
Parameters
- url: string
- pipeline: Pipeline
Returns DataLakeFileClient

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

append

append(body: HttpRequestBody, offset: number, length: number, options?: FileAppendOptions): Promise<FileAppendResponse>

- Defined in clients.ts:949
Parameters
- body: HttpRequestBody
- offset: number
- length: number
- Default value options: FileAppendOptions = {}
Returns Promise<FileAppendResponse>

create

create(resourceType: PathResourceType, options: PathCreateOptions): Promise<PathCreateResponse>
create(options: FileCreateOptions): Promise<FileCreateResponse>

Overrides DataLakePathClient.create
- Defined in clients.ts:794
Parameters
- resourceType: PathResourceType
- Optional options: PathCreateOptions
Returns Promise<PathCreateResponse>
Overrides DataLakePathClient.create
- Defined in clients.ts:808
Parameters
- Optional options: FileCreateOptions
Returns Promise<FileCreateResponse>

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>

flush

flush(position: number, options?: FileFlushOptions): Promise<FileFlushResponse>

- Defined in clients.ts:993
Parameters
- position: number
- Default value options: FileFlushOptions = {}
Returns Promise<FileFlushResponse>

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

getProperties

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

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

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>

read

read(offset?: number, count: undefined | number, options?: FileReadOptions): Promise<FileReadResponse>

- Defined in clients.ts:902
Parameters
- Default value offset: number = 0
- Optional count: undefined | number
- Default value options: FileReadOptions = {}
Returns Promise<FileReadResponse>

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