Skip to main content

CommunicationServicesClient

Namespace: Meshmakers.Octo.Sdk.ServiceClient.CommunicationControllerServices

Implementation of the client proxy for communication controller services. Accepts plain runtime object IDs and constructs composite RtEntityId strings where the server requires them.

public class CommunicationServicesClient : ServiceClient, IServiceClient, ICommunicationServicesClient

Inheritance Object → ServiceClient → CommunicationServicesClient
Implements IServiceClient, ICommunicationServicesClient

Properties​

Options​

Returns the options for configuration of the client proxy.

public ServiceClientOptions Options { get; }

Property Value​

ServiceClientOptions

AccessToken​

public IServiceClientAccessToken AccessToken { get; }

Property Value​

IServiceClientAccessToken

ServiceUri​

public Uri ServiceUri { get; }

Property Value​

Uri

Constructors​

CommunicationServicesClient(IOptions<CommunicationServiceClientOptions>, ICommunicationServiceClientAccessToken)​

Constructor.

public CommunicationServicesClient(IOptions<CommunicationServiceClientOptions> serviceClientOptions, ICommunicationServiceClientAccessToken accessToken)

Parameters​

serviceClientOptions IOptions<CommunicationServiceClientOptions>
Options for configuration of the client proxy.

accessToken ICommunicationServiceClientAccessToken
The access token management object

CommunicationServicesClient(CommunicationServiceClientOptions, ICommunicationServiceClientAccessToken)​

Constructor.

public CommunicationServicesClient(CommunicationServiceClientOptions serviceClientOptions, ICommunicationServiceClientAccessToken accessToken)

Parameters​

serviceClientOptions CommunicationServiceClientOptions
Options for configuration of the client proxy.

accessToken ICommunicationServiceClientAccessToken
The access token management object

Methods​

BuildServiceUri()​

protected Uri BuildServiceUri()

Returns​

Uri

EnableAsync(String)​

public Task EnableAsync(string tenantId)

Parameters​

tenantId String

Returns​

Task

DisableAsync(String)​

public Task DisableAsync(string tenantId)

Parameters​

tenantId String

Returns​

Task

ReconfigureLogLevelAsync(String, LogLevelDto, LogLevelDto)​

public Task ReconfigureLogLevelAsync(string loggerName, LogLevelDto minLogLevel, LogLevelDto maxLogLevel)

Parameters​

loggerName String

minLogLevel LogLevelDto

maxLogLevel LogLevelDto

Returns​

Task

GetLifecycleAsync()​

public Task<CommunicationLifecycleDto> GetLifecycleAsync()

Returns​

Task<CommunicationLifecycleDto>

SetLifecycleAsync(CommunicationLifecycleDto)​

public Task<CommunicationLifecycleDto> SetLifecycleAsync(CommunicationLifecycleDto lifecycle)

Parameters​

lifecycle CommunicationLifecycleDto

Returns​

Task<CommunicationLifecycleDto>

GetAdaptersAsync()​

public Task<IReadOnlyList<AdapterSummaryDto>> GetAdaptersAsync()

Returns​

Task<IReadOnlyList<AdapterSummaryDto>>

GetAdapterConfigurationAsync(String)​

public Task<AdapterConfigurationDto> GetAdapterConfigurationAsync(string adapterRtId)

Parameters​

adapterRtId String

Returns​

Task<AdapterConfigurationDto>

GetAdapterNodesAsync()​

public Task<string> GetAdapterNodesAsync()

Returns​

Task<String>

GetPipelineSchemaAsync(String)​

public Task<string> GetPipelineSchemaAsync(string adapterRtId)

Parameters​

adapterRtId String

Returns​

Task<String>

RotateServiceAccountSecretAsync(String)​

public Task<RotateServiceAccountSecretResultDto> RotateServiceAccountSecretAsync(string adapterRtId)

Parameters​

adapterRtId String

Returns​

Task<RotateServiceAccountSecretResultDto>

GetPipelineDeploymentStateAsync(String)​

public Task<DeploymentResultDto> GetPipelineDeploymentStateAsync(string pipelineRtId)

Parameters​

pipelineRtId String

Returns​

Task<DeploymentResultDto>

DeployPipelineAsync(String, String, String)​

public Task DeployPipelineAsync(string adapterRtId, string pipelineRtId, string pipelineDefinition)

Parameters​

adapterRtId String

pipelineRtId String

pipelineDefinition String

Returns​

Task

ExecutePipelineAsync(String, String, Boolean)​

public Task<string> ExecutePipelineAsync(string pipelineRtId, string pipelineInput, bool isDryRun)

Parameters​

pipelineRtId String

pipelineInput String

isDryRun Boolean

Returns​

Task<String>

GetPipelineExecutionsAsync(String)​

public Task<IEnumerable<PipelineExecutionDataDto>> GetPipelineExecutionsAsync(string pipelineRtId)

Parameters​

pipelineRtId String

Returns​

Task<IEnumerable<PipelineExecutionDataDto>>

GetLatestPipelineExecutionAsync(String)​

public Task<PipelineExecutionDataDto> GetLatestPipelineExecutionAsync(string pipelineRtId)

Parameters​

pipelineRtId String

Returns​

Task<PipelineExecutionDataDto>

GetPipelineExecutionDebugPointsAsync(String, Guid)​

public Task<string> GetPipelineExecutionDebugPointsAsync(string pipelineRtId, Guid executionId)

Parameters​

pipelineRtId String

executionId Guid

Returns​

Task<String>

GetDebugPointAsync(String, Guid, String)​

public Task<DebugPointDataDto> GetDebugPointAsync(string pipelineRtId, Guid executionId, string nodeId)

Parameters​

pipelineRtId String

executionId Guid

nodeId String

Returns​

Task<DebugPointDataDto>

DeployTriggersAsync()​

public Task DeployTriggersAsync()

Returns​

Task

UndeployTriggersAsync()​

public Task UndeployTriggersAsync()

Returns​

Task

GetDeploymentSitesAsync()​

public Task<IReadOnlyList<DeploymentSiteSummaryDto>> GetDeploymentSitesAsync()

Returns​

Task<IReadOnlyList<DeploymentSiteSummaryDto>>

DeployDeploymentSiteAsync(String)​

public Task DeployDeploymentSiteAsync(string deploymentSiteRtId)

Parameters​

deploymentSiteRtId String

Returns​

Task

UndeployDeploymentSiteAsync(String)​

public Task UndeployDeploymentSiteAsync(string deploymentSiteRtId)

Parameters​

deploymentSiteRtId String

Returns​

Task

GetAdapterPoolQueueAsync(String)​

public Task<IReadOnlyList<AdapterPoolQueueEntryDto>> GetAdapterPoolQueueAsync(string adapterPoolRtId)

Parameters​

adapterPoolRtId String

Returns​

Task<IReadOnlyList<AdapterPoolQueueEntryDto>>

CancelQueuedExecutionAsync(String, String)​

public Task<AdapterPoolQueueCancellationResultDto> CancelQueuedExecutionAsync(string adapterPoolRtId, string executionId)

Parameters​

adapterPoolRtId String

executionId String

Returns​

Task<AdapterPoolQueueCancellationResultDto>

DeployDataFlowAsync(String)​

public Task DeployDataFlowAsync(string dataFlowRtId)

Parameters​

dataFlowRtId String

Returns​

Task

SetPipelineDebuggingAsync(String, Boolean)​

public Task<SetPipelineDebugResultDto> SetPipelineDebuggingAsync(string pipelineRtId, bool enabled)

Parameters​

pipelineRtId String

enabled Boolean

Returns​

Task<SetPipelineDebugResultDto>

GetPipelineDebuggingAsync(String)​

public Task<PipelineDebugStateDto> GetPipelineDebuggingAsync(string pipelineRtId)

Parameters​

pipelineRtId String

Returns​

Task<PipelineDebugStateDto>

UndeployDataFlowAsync(String)​

public Task UndeployDataFlowAsync(string dataFlowRtId)

Parameters​

dataFlowRtId String

Returns​

Task

GetDataFlowStatusAsync(String)​

public Task<DataFlowStatusDto> GetDataFlowStatusAsync(string dataFlowRtId)

Parameters​

dataFlowRtId String

Returns​

Task<DataFlowStatusDto>

GetWorkloadsByChartAsync(String)​

public Task<IReadOnlyList<WorkloadSummaryDto>> GetWorkloadsByChartAsync(string chartName)

Parameters​

chartName String

Returns​

Task<IReadOnlyList<WorkloadSummaryDto>>

UpdateWorkloadChartVersionAsync(String, String)​

public Task UpdateWorkloadChartVersionAsync(string workloadRtId, string chartVersion)

Parameters​

workloadRtId String

chartVersion String

Returns​

Task

DeployWorkloadAsync(String)​

public Task DeployWorkloadAsync(string workloadRtId)

Parameters​

workloadRtId String

Returns​

Task

UndeployWorkloadAsync(String)​

public Task UndeployWorkloadAsync(string workloadRtId)

Parameters​

workloadRtId String

Returns​

Task

MovePipelinesToAdapterAsync(MovePipelinesToAdapterRequestDto)​

public Task<MovePipelinesToAdapterResponseDto> MovePipelinesToAdapterAsync(MovePipelinesToAdapterRequestDto requestDto)

Parameters​

requestDto MovePipelinesToAdapterRequestDto

Returns​

Task<MovePipelinesToAdapterResponseDto>