Class GitlabPipelineApiConnector

Namespace

MES.MQC.DataSourceLibrary.Adapters.Apis

Assembly

MES.MQC.DataSourceLibrary.dll

public abstract class GitlabPipelineApiConnector : GitlabApiConnector, IFormProvider

Inheritance

object

AdapterBase

ApiConnector

GitlabApiConnector

GitlabPipelineApiConnector

Implements

IFormProvider

Derived

GitlabPipelineArtifactsApiConnector

GitlabPipelineJUnitApiConnector

Inherited Members

GitlabApiConnector.GetClient(ApiConnectorContext, bool)

GitlabApiConnector.GetClient(GitlabApiConnector.GitlabConfiguration, out List<FormError>, bool)

GitlabApiConnector.Request<T>(RestClient, RestRequest)

GitlabApiConnector.Request<T>(RestClient, RestRequest, out RestResponse, int, int?)

GitlabApiConnector.ConfigureForm(IForm, string[])

ApiConnector.DataSource

ApiConnector.Read(ApiConnectorContext)

ApiConnector.Download(ApiConnectorContext)

ApiConnector.Execute(ApiConnectorContext)

AdapterBase.Name

AdapterBase.Description

AdapterBase.Options

AdapterBase.TransformStringToValue(string)

AdapterBase.TransformStringToDateTime(string)

AdapterBase.TransformStringToDateTime(AdapterContext, string)

AdapterBase.ThrowWarningForEmptyDataProperty(AdapterDataBase, AdapterContextBase, string, string)

AdapterBase.ReadFilePathsInZipFile(string)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

CheckAvailable(ApiConnectorContext)

CheckAvailable must be implemented by the Api Adapter class. This method is called to show a warning for configured but unavailable data sources in the UI.

public override bool CheckAvailable(ApiConnectorContext context)

Parameters

context ApiConnectorContext

ApiConnectorContext

Returns

bool

boolean (is the api available/accessible)

CheckModified(ApiConnectorContext)

CheckModified must be implemented by the Api Adapter class. This method is called by the local and server side monitoring, to check if the data sources should be updated.

public override bool CheckModified(ApiConnectorContext context)

Parameters

context ApiConnectorContext

ApiConnectorContext

Returns

bool

boolean (are there any changes)

LoadJobs(GitlabPipelineConfiguration, RestClient, GitlabPipeline)

protected GitlabPipelineApiConnector.GitlabJob[] LoadJobs(GitlabPipelineApiConnector.GitlabPipelineConfiguration configuration, RestClient client, GitlabPipelineApiConnector.GitlabPipeline pipeline)

Parameters

configuration GitlabPipelineApiConnector.GitlabPipelineConfiguration

client RestClient

pipeline GitlabPipelineApiConnector.GitlabPipeline

Returns

GitlabJob[]

LoadPipelines(ApiConnectorContext, GitlabPipelineConfiguration, RestClient, out DateTime, int?)

protected GitlabPipelineApiConnector.GitlabPipeline[] LoadPipelines(ApiConnectorContext context, GitlabPipelineApiConnector.GitlabPipelineConfiguration configuration, RestClient client, out DateTime responseDateTime, int? limit = null)

Parameters

context ApiConnectorContext

configuration GitlabPipelineApiConnector.GitlabPipelineConfiguration

client RestClient

responseDateTime DateTime

limit int?

Returns

GitlabPipeline[]

LoadPipelines(GitlabPipelineConfiguration, RestClient, ProjectBranch, out DateTime, out int, int?, DateTime?, DateTime?, DateTime?)

protected GitlabPipelineApiConnector.GitlabPipeline[] LoadPipelines(GitlabPipelineApiConnector.GitlabPipelineConfiguration configuration, RestClient client, GitlabApiConnector.ProjectBranch projectBranch, out DateTime responseDateTime, out int totalCount, int? limit = null, DateTime? lastImportDate = null, DateTime? projectStartDate = null, DateTime? projectEndDate = null)

Parameters

configuration GitlabPipelineApiConnector.GitlabPipelineConfiguration

client RestClient

projectBranch GitlabApiConnector.ProjectBranch

responseDateTime DateTime

totalCount int

limit int?

lastImportDate DateTime?

projectStartDate DateTime?

projectEndDate DateTime?

Returns

GitlabPipeline[]

PreviewForm(IForm, string, out int)

PreviewForm can be implemented by an API Connector. It is used to load the Preview, if one was defined in the AdapterConfiguration. Based on the focused form field, the Preview is shown in the Dialog and provides the ability to load by clicking on a button. This button click calls this method. Based on the configuration and the preview type, the api should load the relevant data, limited to ~100 for better performance, and a array of FormPreview should be returned.

public override FormPreview[] PreviewForm(IForm form, string preview, out int totalCount)

Parameters

form IForm

IForm, the AdapterConfiguration

preview string

The preview type (string)

totalCount int

Output of totalCount, if 0 shown as ? in the preview dialog

Returns

FormPreview[]

Array of FormPreview, to show Title and optionally Description and DateTime