# pylint: disable=too-many-lines
# coding=utf-8
# --------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# Code generated by Microsoft (R) AutoRest Code Generator.
# Changes may cause incorrect behavior and will be lost if the code is regenerated.
# --------------------------------------------------------------------------
from typing import Any, Callable, Dict, Optional, TypeVar
from azure.core.exceptions import ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, map_error
from azure.core.pipeline import PipelineResponse
from azure.core.pipeline.transport import AsyncHttpResponse
from azure.core.rest import HttpRequest
from azure.core.tracing.decorator_async import distributed_trace_async
from azure.core.utils import case_insensitive_dict
from ... import models as _models
from ..._vendor import _convert_request
from ...operations._pipeline_run_operations import build_cancel_pipeline_run_request, build_get_pipeline_run_request, build_query_activity_runs_request, build_query_pipeline_runs_by_workspace_request
T = TypeVar('T')
ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]]
[docs]class PipelineRunOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.synapse.artifacts.aio.ArtifactsClient`'s
:attr:`pipeline_run` attribute.
"""
models = _models
def __init__(self, *args, **kwargs) -> None:
input_args = list(args)
self._client = input_args.pop(0) if input_args else kwargs.pop("client")
self._config = input_args.pop(0) if input_args else kwargs.pop("config")
self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer")
self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer")
[docs] @distributed_trace_async
async def query_pipeline_runs_by_workspace(
self,
filter_parameters: _models.RunFilterParameters,
**kwargs: Any
) -> _models.PipelineRunsQueryResponse:
"""Query pipeline runs in the workspace based on input filter conditions.
:param filter_parameters: Parameters to filter the pipeline run.
:type filter_parameters: ~azure.synapse.artifacts.models.RunFilterParameters
:keyword api_version: Api Version. Default value is "2020-12-01". Note that overriding this
default value may result in unsupported behavior.
:paramtype api_version: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: PipelineRunsQueryResponse, or the result of cls(response)
:rtype: ~azure.synapse.artifacts.models.PipelineRunsQueryResponse
:raises: ~azure.core.exceptions.HttpResponseError
"""
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop('api_version', _params.pop('api-version', "2020-12-01")) # type: str
content_type = kwargs.pop('content_type', _headers.pop('Content-Type', "application/json")) # type: Optional[str]
cls = kwargs.pop('cls', None) # type: ClsType[_models.PipelineRunsQueryResponse]
_json = self._serialize.body(filter_parameters, 'RunFilterParameters')
request = build_query_pipeline_runs_by_workspace_request(
api_version=api_version,
content_type=content_type,
json=_json,
template_url=self.query_pipeline_runs_by_workspace.metadata['url'],
headers=_headers,
params=_params,
)
request = _convert_request(request)
path_format_arguments = {
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request,
stream=False,
**kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.CloudError, pipeline_response)
raise HttpResponseError(response=response, model=error)
deserialized = self._deserialize('PipelineRunsQueryResponse', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
query_pipeline_runs_by_workspace.metadata = {'url': "/queryPipelineRuns"} # type: ignore
[docs] @distributed_trace_async
async def get_pipeline_run(
self,
run_id: str,
**kwargs: Any
) -> _models.PipelineRun:
"""Get a pipeline run by its run ID.
:param run_id: The pipeline run identifier.
:type run_id: str
:keyword api_version: Api Version. Default value is "2020-12-01". Note that overriding this
default value may result in unsupported behavior.
:paramtype api_version: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: PipelineRun, or the result of cls(response)
:rtype: ~azure.synapse.artifacts.models.PipelineRun
:raises: ~azure.core.exceptions.HttpResponseError
"""
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop('api_version', _params.pop('api-version', "2020-12-01")) # type: str
cls = kwargs.pop('cls', None) # type: ClsType[_models.PipelineRun]
request = build_get_pipeline_run_request(
run_id=run_id,
api_version=api_version,
template_url=self.get_pipeline_run.metadata['url'],
headers=_headers,
params=_params,
)
request = _convert_request(request)
path_format_arguments = {
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request,
stream=False,
**kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.CloudError, pipeline_response)
raise HttpResponseError(response=response, model=error)
deserialized = self._deserialize('PipelineRun', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get_pipeline_run.metadata = {'url': "/pipelineruns/{runId}"} # type: ignore
[docs] @distributed_trace_async
async def query_activity_runs(
self,
pipeline_name: str,
run_id: str,
filter_parameters: _models.RunFilterParameters,
**kwargs: Any
) -> _models.ActivityRunsQueryResponse:
"""Query activity runs based on input filter conditions.
:param pipeline_name: The pipeline name.
:type pipeline_name: str
:param run_id: The pipeline run identifier.
:type run_id: str
:param filter_parameters: Parameters to filter the activity runs.
:type filter_parameters: ~azure.synapse.artifacts.models.RunFilterParameters
:keyword api_version: Api Version. Default value is "2020-12-01". Note that overriding this
default value may result in unsupported behavior.
:paramtype api_version: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: ActivityRunsQueryResponse, or the result of cls(response)
:rtype: ~azure.synapse.artifacts.models.ActivityRunsQueryResponse
:raises: ~azure.core.exceptions.HttpResponseError
"""
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}) or {})
_headers = case_insensitive_dict(kwargs.pop("headers", {}) or {})
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop('api_version', _params.pop('api-version', "2020-12-01")) # type: str
content_type = kwargs.pop('content_type', _headers.pop('Content-Type', "application/json")) # type: Optional[str]
cls = kwargs.pop('cls', None) # type: ClsType[_models.ActivityRunsQueryResponse]
_json = self._serialize.body(filter_parameters, 'RunFilterParameters')
request = build_query_activity_runs_request(
pipeline_name=pipeline_name,
run_id=run_id,
api_version=api_version,
content_type=content_type,
json=_json,
template_url=self.query_activity_runs.metadata['url'],
headers=_headers,
params=_params,
)
request = _convert_request(request)
path_format_arguments = {
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request,
stream=False,
**kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.CloudError, pipeline_response)
raise HttpResponseError(response=response, model=error)
deserialized = self._deserialize('ActivityRunsQueryResponse', pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
query_activity_runs.metadata = {'url': "/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns"} # type: ignore
[docs] @distributed_trace_async
async def cancel_pipeline_run( # pylint: disable=inconsistent-return-statements
self,
run_id: str,
is_recursive: Optional[bool] = None,
**kwargs: Any
) -> None:
"""Cancel a pipeline run by its run ID.
:param run_id: The pipeline run identifier.
:type run_id: str
:param is_recursive: If true, cancel all the Child pipelines that are triggered by the current
pipeline. Default value is None.
:type is_recursive: bool
:keyword api_version: Api Version. Default value is "2020-12-01". Note that overriding this
default value may result in unsupported behavior.
:paramtype api_version: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: None, or the result of cls(response)
:rtype: None
:raises: ~azure.core.exceptions.HttpResponseError
"""
error_map = {
401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError
}
error_map.update(kwargs.pop('error_map', {}) or {})
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop('api_version', _params.pop('api-version', "2020-12-01")) # type: str
cls = kwargs.pop('cls', None) # type: ClsType[None]
request = build_cancel_pipeline_run_request(
run_id=run_id,
api_version=api_version,
is_recursive=is_recursive,
template_url=self.cancel_pipeline_run.metadata['url'],
headers=_headers,
params=_params,
)
request = _convert_request(request)
path_format_arguments = {
"endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, 'str', skip_quote=True),
}
request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore
pipeline_response = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access
request,
stream=False,
**kwargs
)
response = pipeline_response.http_response
if response.status_code not in [200]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
error = self._deserialize.failsafe_deserialize(_models.CloudError, pipeline_response)
raise HttpResponseError(response=response, model=error)
if cls:
return cls(pipeline_response, None, {})
cancel_pipeline_run.metadata = {'url': "/pipelineruns/{runId}/cancel"} # type: ignore