LibraryClient Class

Package:

com.azure.analytics.synapse.artifacts

Maven Artifact:

com.azure:azure-analytics-synapse-artifacts:1.0.0-beta.15

• java.lang.Object
• • com.azure.analytics.synapse.artifacts.LibraryClient

public final class LibraryClient

Initializes a new instance of the synchronous ArtifactsClient type.

Method Summary

Modifier and Type	Method and Description
void	append(String libraryName, BinaryData content, long contentLength) Append the content to the library resource created using the create operation.
void	append(String libraryName, BinaryData content, long contentLength, Long blobConditionAppendPosition) Append the content to the library resource created using the create operation.
void	append(String libraryName, Flux<ByteBuffer> content, long contentLength) Append the content to the library resource created using the create operation.
void	append(String libraryName, Flux<ByteBuffer> content, long contentLength, Long blobConditionAppendPosition) Append the content to the library resource created using the create operation.
Response<Void>	appendWithResponse(String libraryName, BinaryData content, long contentLength, Long blobConditionAppendPosition, Context context) Append the content to the library resource created using the create operation.
Response<Void>	appendWithResponse(String libraryName, Flux<ByteBuffer> content, long contentLength, Long blobConditionAppendPosition, Context context) Append the content to the library resource created using the create operation.
LibraryResourceInfo	create(String libraryName) Creates a library with the library name.
Response<LibraryResourceInfo>	createWithResponse(String libraryName, Context context) Creates a library with the library name.
LibraryResourceInfo	delete(String libraryName) Delete Library.
Response<LibraryResourceInfo>	deleteWithResponse(String libraryName, Context context) Delete Library.
LibraryResourceInfo	flush(String libraryName) Flush Library.
Response<LibraryResourceInfo>	flushWithResponse(String libraryName, Context context) Flush Library.
LibraryResource	get(String libraryName) Get Library.
LibraryResource	getOperationResult(String operationId) Get Operation result for Library.
Response<LibraryResource>	getOperationResultWithResponse(String operationId, Context context) Get Operation result for Library.
Response<LibraryResource>	getWithResponse(String libraryName, Context context) Get Library.
PagedIterable<LibraryResource>	list() Lists Library.
PagedIterable<LibraryResource>	list(Context context) Lists Library.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

append

public void append(String libraryName, BinaryData content, long contentLength)

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 - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content - Library file chunk.

contentLength - The Content-Length header for the request.

append

public void append(String libraryName, BinaryData content, long contentLength, Long blobConditionAppendPosition)

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 - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content - Library file chunk.

contentLength - The Content-Length header for the request.

blobConditionAppendPosition - Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 \u2013 Precondition Failed).

append

public void append(String libraryName, Flux content, long contentLength)

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 - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content - Library file chunk.

contentLength - The Content-Length header for the request.

append

public void append(String libraryName, Flux content, long contentLength, Long blobConditionAppendPosition)

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 - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content - Library file chunk.

contentLength - The Content-Length header for the request.

blobConditionAppendPosition - Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 \u2013 Precondition Failed).

appendWithResponse

public Response appendWithResponse(String libraryName, BinaryData content, long contentLength, Long blobConditionAppendPosition, Context context)

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 - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content - Library file chunk.

contentLength - The Content-Length header for the request.

blobConditionAppendPosition - Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 \u2013 Precondition Failed).

context - The context to associate with this operation.

Returns:

the Response<T>.

appendWithResponse

public Response appendWithResponse(String libraryName, Flux content, long contentLength, Long blobConditionAppendPosition, Context context)

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 - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

content - Library file chunk.

contentLength - The Content-Length header for the request.

blobConditionAppendPosition - Set this header to a byte offset at which the block is expected to be appended. The request succeeds only if the current offset matches this value. Otherwise, the request fails with the AppendPositionConditionNotMet error (HTTP status code 412 \u2013 Precondition Failed).

context - The context to associate with this operation.

Returns:

the Response<T>.

create

public LibraryResourceInfo create(String libraryName)

Creates a library with the library name.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Returns:

the response.

createWithResponse

public Response createWithResponse(String libraryName, Context context)

Creates a library with the library name.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

delete

public LibraryResourceInfo delete(String libraryName)

Delete Library.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Returns:

the response.

deleteWithResponse

public Response deleteWithResponse(String libraryName, Context context)

Delete Library.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

flush

public LibraryResourceInfo flush(String libraryName)

Flush Library.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Returns:

the response.

flushWithResponse

public Response flushWithResponse(String libraryName, Context context)

Flush Library.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

context - The context to associate with this operation.

Returns:

the response body along with Response<T>.

get

public LibraryResource get(String libraryName)

Get Library.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

Returns:

library.

getOperationResult

public LibraryResource getOperationResult(String operationId)

Get Operation result for Library.

Parameters:

operationId - operation id for which status is requested.

Returns:

operation result for Library.

getOperationResultWithResponse

public Response getOperationResultWithResponse(String operationId, Context context)

Get Operation result for Library.

Parameters:

operationId - operation id for which status is requested.

context - The context to associate with this operation.

Returns:

operation result for Library along with Response<T>.

getWithResponse

public Response getWithResponse(String libraryName, Context context)

Get Library.

Parameters:

libraryName - file name to upload. Minimum length of the filename should be 1 excluding the extension length.

context - The context to associate with this operation.

Returns:

library along with Response<T>.

list

public PagedIterable list()

Lists Library.

Returns:

a list of Library resources as paginated response with PagedIterable<T>.

list

public PagedIterable list(Context context)

Lists Library.

Parameters:

context - The context to associate with this operation.

Returns:

a list of Library resources as paginated response with PagedIterable<T>.