PlumsailClient Class

Definition

Namespace:: Azure.Connectors.Sdk.Plumsail

Assembly:: Azure.Connectors.Sdk.dll

Package:: Azure.Connectors.Sdk v0.13.0-preview.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Typed client for plumsail connector.

public class PlumsailClient : Azure.Connectors.Sdk.ConnectorClientBase

type PlumsailClient = class
    inherit ConnectorClientBase

Public Class PlumsailClient
Inherits ConnectorClientBase

Inheritance: Object

ConnectorClientBase
PlumsailClient

Constructors

Name	Description
PlumsailClient()
PlumsailClient(String)	Creates a new PlumsailClient with the specified connection runtime URL string. Uses ManagedIdentityCredential by default.
PlumsailClient(Uri, TokenCredential, ConnectorClientOptions)	Creates a new PlumsailClient with the specified connection runtime URL and credential.
PlumsailClient(Uri, TokenCredential)	Creates a new PlumsailClient with the specified connection runtime URL and credential.
PlumsailClient(Uri)	Creates a new PlumsailClient with the specified connection runtime URL. Uses ManagedIdentityCredential by default.

Properties

Name	Description
ConnectorName
Pipeline	Gets the HTTP pipeline for making connector requests. (Inherited from ConnectorClientBase)

Methods

Name	Description
CallConnectorAsync(HttpMethod, String, Object, CancellationToken)	Sends a connector API request with no response body. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
CallConnectorAsync<TResponse>(HttpMethod, String, Object, CancellationToken)	Sends a connector API request and deserializes the JSON response. Uses the Azure.Core HttpPipeline for retry, authentication, and diagnostics. (Inherited from ConnectorClientBase)
Dispose()	(Inherited from ConnectorClientBase)
Dispose(Boolean)	Disposes the connector client resources. (Inherited from ConnectorClientBase)
FlowV1DocumentsFlowSchemaAddWatermarkToPdfAsync(String, CancellationToken)	AddWatermarkToPdfSchema
FlowV1DocumentsFlowSchemaParseCsvAsync(String, CancellationToken)	ParseCsv
FlowV1DocumentsFlowSchemaRegExpMatchAsync(String, CancellationToken)	RegexMatchSchema
FlowV1DocumentsFlowSchemaSplitPdfAsync(String, CancellationToken)	SplitPdfSchema
FlowV1DocumentsJobsAddWatermarkToPdfAsync(FlowV1DocumentsJobsAddWatermarkToPdfInput, String, CancellationToken)	Add a watermark to PDF
FlowV1DocumentsJobsAny2PdfV2Async(Any2PdfRequest, CancellationToken)	Convert to PDF
FlowV1DocumentsJobsApplyDocxAsync(MergeFieldsTemplateRequest, CancellationToken)	Fill merge fields in DOCX document
FlowV1DocumentsJobsApplyDocxTemplateAsync(ApplyDocxTemplateRequest, CancellationToken)	Create document from DOCX template
FlowV1DocumentsJobsApplyHtmlAsync(ApplyHtmlFlowTemplateRequest, CancellationToken)	Create HTML from template
FlowV1DocumentsJobsApplyPptxAsync(ApplyPptxTemplateRequest, CancellationToken)	Create document from PPTX template
FlowV1DocumentsJobsApplyXlsxTemplateAsync(ApplyXlsxTemplateRequest, CancellationToken)	Create document from XLSX template
FlowV1DocumentsJobsCompressPdfAsync(CompressPdfRequest, CancellationToken)	Compress PDF document
FlowV1DocumentsJobsCreateArchiveAsync(CreateArchiveRequest, CancellationToken)	Create Archive
FlowV1DocumentsJobsCsv2XlsxAsync(Csv2XlsxRequest, CancellationToken)	Convert CSV to Excel
FlowV1DocumentsJobsDoc2DocxAsync(Doc2DocxRequest, CancellationToken)	Convert DOC to DOCX
FlowV1DocumentsJobsDocx2PdfAsync(Docx2PdfRequest, CancellationToken)	Convert DOCX to PDF
FlowV1DocumentsJobsEmail2PdfAsync(Email2PdfRequest, CancellationToken)	Convert Email to PDF
FlowV1DocumentsJobsExtractArchiveAsync(ExtractArchiveRequest, CancellationToken)	Extract Archive
FlowV1DocumentsJobsExtractTextFromPdfAsync(Pdf2TextRequest, CancellationToken)	Extract text from PDF document
FlowV1DocumentsJobsFillInPdfFormAsync(FillInPdfFormRequest, CancellationToken)	Fill in PDF Form
FlowV1DocumentsJobsGetPdfFormAsync(GetPdfFormRequest, CancellationToken)	Get Form from PDF
FlowV1DocumentsJobsGetPdfProtectionInfoAsync(PdfProtectionInfoRequest, CancellationToken)	Get information about PDF protection
FlowV1DocumentsJobsHtml2DocxAsync(Html2DocxFlowRequest, CancellationToken)	Convert HTML to DOCX
FlowV1DocumentsJobsHtml2PdfAsync(Html2PdfFlowRequest, CancellationToken)	Convert HTML to PDF
FlowV1DocumentsJobsImage2PdfAsync(Image2PdfRequest, CancellationToken)	Convert Images to PDF
FlowV1DocumentsJobsJson2CsvAsync(Json2CsvRequest, CancellationToken)	Convert JSON to CSV
FlowV1DocumentsJobsJson2XlsxAsync(Json2XlsxRequest, CancellationToken)	Convert JSON to Excel
FlowV1DocumentsJobsMergeAnyToPdfV2Async(MergeAny2PdfRequest, CancellationToken)	Merge any files into PDF
FlowV1DocumentsJobsMergeDocxAsync(MergeDocxRequest, CancellationToken)	Merge DOCX files
FlowV1DocumentsJobsMergeXlsxAsync(MergeXlsxRequest, CancellationToken)	Merge XLSX files
FlowV1DocumentsJobsParseCsvAsync(ParseCsvFlowRequest, CancellationToken)	Parse CSV
FlowV1DocumentsJobsPdf2ImageV2Async(Pdf2ImageRequest, CancellationToken)	Convert PDF to Image
FlowV1DocumentsJobsPpt2PptxAsync(Ppt2PptxRequest, CancellationToken)	Convert PPT to PPTX
FlowV1DocumentsJobsPptx2PdfAsync(Pptx2PdfRequest, CancellationToken)	Convert PPTX to PDF
FlowV1DocumentsJobsProtectPdfAsync(ProtectPdfRequest, CancellationToken)	Protect PDF document
FlowV1DocumentsJobsRegExpMatchAsync(RegExpMatchRequest, CancellationToken)	Regular Expression Match
FlowV1DocumentsJobsRegExpReplaceAsync(RegExpReplaceRequest, CancellationToken)	Regular Expression Replace
FlowV1DocumentsJobsRegExpTestAsync(RegExpTestRequest, CancellationToken)	Regular Expression Test
FlowV1DocumentsJobsSplitPdfV2Async(FlowV1DocumentsJobsSplitPdfV2Input, String, CancellationToken)	Split PDF
FlowV1DocumentsJobsXls2XlsxAsync(Xls2XlsxRequest, CancellationToken)	Convert XLS to XLSX
FlowV1DocumentsJobsXslx2PdfAsync(Xlsx2PdfRequest, CancellationToken)	Convert XLSX to PDF
FlowV1ProcessesFlowJobsExecuteProcessAsync(FlowV1ProcessesFlowJobsExecuteProcessInput, String, CancellationToken)	Start document generation process with json
FlowV1ProcessesFlowJobsExecuteProcessWithGeneratedDataAsync(ProcessJsonData, String, CancellationToken)	Start document generation process
FlowV1ProcessesFlowSchemaGetJsonDataAsync(String, CancellationToken)	GetJsonSchema
FlowV1ProcessesFlowSchemaGetProcessesAsync(CancellationToken)	GetProcessesSchema
FlowV1ProcessesFlowTriggersByProcessIdSchemaGetAsync(String, CancellationToken)	Get schema of a process
ProfilesMeGetAsync(CancellationToken)	Get Profile Info
ResolveUrl(String)	Resolves a relative path or validates an absolute URL against the connection runtime URL. When the NextLink host matches the connection URL, it's used as-is. When it doesn't match (codeless connectors like ARM return nextLink pointing to the backend host e.g. management.azure.com), the path+query is extracted and routed through the APIM proxy. This is safe because the request still goes through the connection runtime URL with API Hub auth. (Inherited from ConnectorClientBase)

Applies to

Feedback

Was this page helpful?