LibraryImpl | @azure/synapse-artifacts

Class containing Library operations.

Hierarchy

LibraryImpl

Implements

Library

Index

Constructors

constructor

Methods

Constructors

constructor

new LibraryImpl(client: ArtifactsClient): LibraryImpl

- Defined in operations/library.ts:39
Initialize a new instance of the class Library class.

Parameters
- client: ArtifactsClient
  
  Reference to the service client
Returns LibraryImpl

Methods

append

append(libraryName: string, content: coreRestPipeline.RequestBodyType, options?: LibraryAppendOptionalParams): Promise<void>

Implementation of Library.append
- Defined in operations/library.ts:446
Append the content to the library resource created using the create operation. The maximum content size is 4MiB. Content larger than 4MiB must be appended in 4MiB chunks

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- content: coreRestPipeline.RequestBodyType
  
  Library file chunk.
- Optional options: LibraryAppendOptionalParams
  
  The options parameters.
Returns Promise<void>

beginCreate

beginCreate(libraryName: string, options?: LibraryCreateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Library.beginCreate
- Defined in operations/library.ts:356
Creates a library with the library name.

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryCreateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCreateAndWait

beginCreateAndWait(libraryName: string, options?: LibraryCreateOptionalParams): Promise<void>

Implementation of Library.beginCreateAndWait
- Defined in operations/library.ts:430
Creates a library with the library name.

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryCreateOptionalParams
  
  The options parameters.
Returns Promise<void>

beginDelete

beginDelete(libraryName: string, options?: LibraryDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Library.beginDelete
- Defined in operations/library.ts:240
Delete Library

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(libraryName: string, options?: LibraryDeleteOptionalParams): Promise<void>

Implementation of Library.beginDeleteAndWait
- Defined in operations/library.ts:314
Delete Library

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginFlush

beginFlush(libraryName: string, options?: LibraryFlushOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of Library.beginFlush
- Defined in operations/library.ts:122
Flush Library

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryFlushOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginFlushAndWait

beginFlushAndWait(libraryName: string, options?: LibraryFlushOptionalParams): Promise<void>

Implementation of Library.beginFlushAndWait
- Defined in operations/library.ts:196
Flush Library

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryFlushOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(libraryName: string, options?: LibraryGetOptionalParams): Promise<LibraryGetResponse>

Implementation of Library.get
- Defined in operations/library.ts:328
Get Library

Parameters
- libraryName: string
  
  file name to upload. Minimum length of the filename should be 1 excluding the extension length.
- Optional options: LibraryGetOptionalParams
  
  The options parameters.
Returns Promise<LibraryGetResponse>

getOperationResult

getOperationResult(operationId: string, options?: LibraryGetOperationResultOptionalParams): Promise<LibraryGetOperationResultResponse>

Implementation of Library.getOperationResult
- Defined in operations/library.ts:209
Get Operation result for Library

Parameters
- operationId: string
  
  operation id for which status is requested
- Optional options: LibraryGetOperationResultOptionalParams
  
  The options parameters.
Returns Promise<LibraryGetOperationResultResponse>

list

list(options?: LibraryListOptionalParams): PagedAsyncIterableIterator<LibraryResource>

Implementation of Library.list
- Defined in operations/library.ts:53
Lists Library.

Parameters
- Optional options: LibraryListOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<LibraryResource>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ArtifactsClient

Returns LibraryImpl

Methods

append

Parameters

libraryName: string

content: coreRestPipeline.RequestBodyType

Optional options: LibraryAppendOptionalParams

Returns Promise<void>

beginCreate

Parameters

libraryName: string

Optional options: LibraryCreateOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginCreateAndWait

Parameters

libraryName: string

Optional options: LibraryCreateOptionalParams

Returns Promise<void>

beginDelete

Parameters

libraryName: string

Optional options: LibraryDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

libraryName: string

Optional options: LibraryDeleteOptionalParams

Returns Promise<void>

beginFlush

Parameters

libraryName: string

Optional options: LibraryFlushOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginFlushAndWait

Parameters

libraryName: string

Optional options: LibraryFlushOptionalParams

Returns Promise<void>

get

Parameters

libraryName: string

Optional options: LibraryGetOptionalParams

Returns Promise<LibraryGetResponse>

getOperationResult

Parameters

operationId: string

Optional options: LibraryGetOperationResultOptionalParams

Returns Promise<LibraryGetOperationResultResponse>

list

Parameters

Optional options: LibraryListOptionalParams

Returns PagedAsyncIterableIterator<LibraryResource>