describePipeline method

Future<DescribePipelineResponse> describePipeline({
  1. required String pipelineName,
  2. required String workspaceName,
  3. String? pipelineVersion,
})

Retrieves detailed information about a specific pipeline in a workspace.

May throw AccessDeniedException. May throw InternalFailureException. May throw InvalidRequestException. May throw ResourceNotFoundException. May throw ThrottlingException.

Parameter pipelineName : The name of the pipeline.

Parameter workspaceName : The name of the workspace.

Parameter pipelineVersion : The version number of the pipeline to retrieve. If not specified, returns the latest version.

Implementation

Future<DescribePipelineResponse> describePipeline({
  required String pipelineName,
  required String workspaceName,
  String? pipelineVersion,
}) async {
  final $query = <String, List<String>>{
    if (pipelineVersion != null) 'version': [pipelineVersion],
  };
  final response = await _protocol.send(
    payload: null,
    method: 'GET',
    requestUri:
        '/workspaces/${Uri.encodeComponent(workspaceName)}/pipelines/${Uri.encodeComponent(pipelineName)}',
    queryParams: $query,
    hostPrefix: 'api.',
    exceptionFnMap: _exceptionFns,
  );
  return DescribePipelineResponse.fromJson(response);
}