IPipelineRegistryService

Namespace: Meshmakers.Octo.Sdk.Common.Services

Interface for the pipeline registry

public interface IPipelineRegistryService

Methods

RegisterPipelineAsync(String, PipelineConfigurationDto)

Register a pipeline configuration

Task RegisterPipelineAsync(string tenantId, PipelineConfigurationDto pipelineConfiguration)

Parameters

tenantId String
TenantId of pipeline

pipelineConfiguration PipelineConfigurationDto
Pipeline configuration with transformation list

Returns

Task

RegisterPipelinesAsync(String, ICollection<PipelineConfigurationDto>, List<DeploymentUpdateErrorMessageDto>)

Registers multiple pipeline configurations

Task<bool> RegisterPipelinesAsync(string tenantId, ICollection<PipelineConfigurationDto> pipelineConfigurations, List<DeploymentUpdateErrorMessageDto> deploymentErrorMessages)

Parameters

tenantId String
TenantId of the pipeline

pipelineConfigurations ICollection<PipelineConfigurationDto>
List of pipeline configurations

deploymentErrorMessages List<DeploymentUpdateErrorMessageDto>
Error messages that occurred during the register operation

Returns

Task<Boolean>

UnregisterPipelineAsync(String, RtEntityId)

Unregister a pipeline configuration

Task UnregisterPipelineAsync(string tenantId, RtEntityId pipelineRtEntityId)

Parameters

tenantId String
TenantId of pipeline

pipelineRtEntityId RtEntityId
Pipeline runtime id

Returns

Task

UnregisterAllPipelinesAsync(String)

Unregister all pipelines

Task UnregisterAllPipelinesAsync(string tenantId)

Parameters

tenantId String

Returns

Task

IsRegistered(String, RtEntityId)

Returns if a pipeline is registered

bool IsRegistered(string tenantId, RtEntityId pipelineRtEntityId)

Parameters

tenantId String
TenantId of pipeline

pipelineRtEntityId RtEntityId
Pipeline runtime id

Returns

Boolean

TryGetPipelineRegistration(String, RtEntityId, out PipelineRegistration)

Returns the pipeline registration if it exists

bool TryGetPipelineRegistration(string tenantId, RtEntityId pipelineRtEntityId, out PipelineRegistration pipelineRegistration)

Parameters

tenantId String
TenantId of pipeline

pipelineRtEntityId RtEntityId
Pipeline runtime id

pipelineRegistration PipelineRegistration
Pipeline registration

Returns

Boolean
The pipeline registration if it exists

GetRegisteredPipelines(String)

Gets all registered pipeline RtEntityIds for a tenant.

IEnumerable<RtEntityId> GetRegisteredPipelines(string tenantId)

Parameters

tenantId String
TenantId to get pipelines for

Returns

IEnumerable<RtEntityId>
Collection of registered pipeline RtEntityIds

UpdatePipelinesAsync(String, ICollection<PipelineConfigurationDto>, List<DeploymentUpdateErrorMessageDto>)

Selectively updates pipeline registrations by comparing against the currently registered pipelines. Only pipelines that have changed, been added, or been removed are affected. Unchanged pipelines continue running without interruption.

Task<bool> UpdatePipelinesAsync(string tenantId, ICollection<PipelineConfigurationDto> pipelineConfigurations, List<DeploymentUpdateErrorMessageDto> deploymentErrorMessages)

Parameters

tenantId String
TenantId of the pipelines

pipelineConfigurations ICollection<PipelineConfigurationDto>
The new complete set of pipeline configurations

deploymentErrorMessages List<DeploymentUpdateErrorMessageDto>
Error messages that occurred during the update

Returns

Task<Boolean>
True if all pipeline registrations succeeded