Source code for azure.mgmt.datafactory.operations._integration_runtime_object_metadata_operations
# 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, IO, Optional, TypeVar, Union, cast, overload
from azure.core.exceptions import (
ClientAuthenticationError,
HttpResponseError,
ResourceExistsError,
ResourceNotFoundError,
map_error,
)
from azure.core.pipeline import PipelineResponse
from azure.core.pipeline.transport import HttpResponse
from azure.core.polling import LROPoller, NoPolling, PollingMethod
from azure.core.rest import HttpRequest
from azure.core.tracing.decorator import distributed_trace
from azure.core.utils import case_insensitive_dict
from azure.mgmt.core.exceptions import ARMErrorFormat
from azure.mgmt.core.polling.arm_polling import ARMPolling
from .. import models as _models
from .._serialization import Serializer
from .._vendor import _convert_request, _format_url_section
T = TypeVar("T")
ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]]
_SERIALIZER = Serializer()
_SERIALIZER.client_side_validation = False
def build_refresh_request(
resource_group_name: str, factory_name: str, integration_runtime_name: str, subscription_id: str, **kwargs: Any
) -> HttpRequest:
_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", "2018-06-01")) # type: str
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
def build_get_request(
resource_group_name: str, factory_name: str, integration_runtime_name: str, subscription_id: str, **kwargs: Any
) -> HttpRequest:
_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", "2018-06-01")) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
accept = _headers.pop("Accept", "application/json")
# Construct URL
_url = kwargs.pop(
"template_url",
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata",
) # pylint: disable=line-too-long
path_format_arguments = {
"subscriptionId": _SERIALIZER.url("subscription_id", subscription_id, "str"),
"resourceGroupName": _SERIALIZER.url(
"resource_group_name", resource_group_name, "str", max_length=90, min_length=1, pattern=r"^[-\w\._\(\)]+$"
),
"factoryName": _SERIALIZER.url(
"factory_name",
factory_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
"integrationRuntimeName": _SERIALIZER.url(
"integration_runtime_name",
integration_runtime_name,
"str",
max_length=63,
min_length=3,
pattern=r"^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$",
),
}
_url = _format_url_section(_url, **path_format_arguments)
# Construct parameters
_params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
# Construct headers
if content_type is not None:
_headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str")
_headers["Accept"] = _SERIALIZER.header("accept", accept, "str")
return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs)
[docs]class IntegrationRuntimeObjectMetadataOperations:
"""
.. warning::
**DO NOT** instantiate this class directly.
Instead, you should access the following operations through
:class:`~azure.mgmt.datafactory.DataFactoryManagementClient`'s
:attr:`integration_runtime_object_metadata` attribute.
"""
models = _models
def __init__(self, *args, **kwargs):
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")
def _refresh_initial(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> Optional[_models.SsisObjectMetadataStatusResponse]:
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", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[Optional[_models.SsisObjectMetadataStatusResponse]]
request = build_refresh_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
template_url=self._refresh_initial.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = 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, 202]:
map_error(status_code=response.status_code, response=response, error_map=error_map)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = None
if response.status_code == 200:
deserialized = self._deserialize("SsisObjectMetadataStatusResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
_refresh_initial.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata"} # type: ignore
[docs] @distributed_trace
def begin_refresh(
self, resource_group_name: str, factory_name: str, integration_runtime_name: str, **kwargs: Any
) -> LROPoller[_models.SsisObjectMetadataStatusResponse]:
"""Refresh a SSIS integration runtime object metadata.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:keyword callable cls: A custom type or function that will be passed the direct response
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:keyword polling: By default, your polling method will be ARMPolling. Pass in False for this
operation to not poll, or pass in your own initialized polling object for a personal polling
strategy.
:paramtype polling: bool or ~azure.core.polling.PollingMethod
:keyword int polling_interval: Default waiting time between two polls for LRO operations if no
Retry-After header is present.
:return: An instance of LROPoller that returns either SsisObjectMetadataStatusResponse or the
result of cls(response)
:rtype:
~azure.core.polling.LROPoller[~azure.mgmt.datafactory.models.SsisObjectMetadataStatusResponse]
:raises ~azure.core.exceptions.HttpResponseError:
"""
_headers = kwargs.pop("headers", {}) or {}
_params = case_insensitive_dict(kwargs.pop("params", {}) or {})
api_version = kwargs.pop("api_version", _params.pop("api-version", self._config.api_version)) # type: str
cls = kwargs.pop("cls", None) # type: ClsType[_models.SsisObjectMetadataStatusResponse]
polling = kwargs.pop("polling", True) # type: Union[bool, PollingMethod]
lro_delay = kwargs.pop("polling_interval", self._config.polling_interval)
cont_token = kwargs.pop("continuation_token", None) # type: Optional[str]
if cont_token is None:
raw_result = self._refresh_initial( # type: ignore
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
api_version=api_version,
cls=lambda x, y, z: x,
headers=_headers,
params=_params,
**kwargs
)
kwargs.pop("error_map", None)
def get_long_running_output(pipeline_response):
deserialized = self._deserialize("SsisObjectMetadataStatusResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
if polling is True:
polling_method = cast(PollingMethod, ARMPolling(lro_delay, **kwargs)) # type: PollingMethod
elif polling is False:
polling_method = cast(PollingMethod, NoPolling())
else:
polling_method = polling
if cont_token:
return LROPoller.from_continuation_token(
polling_method=polling_method,
continuation_token=cont_token,
client=self._client,
deserialization_callback=get_long_running_output,
)
return LROPoller(self._client, raw_result, get_long_running_output, polling_method)
begin_refresh.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/refreshObjectMetadata"} # type: ignore
@overload
def get(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
get_metadata_request: Optional[_models.GetSsisObjectMetadataRequest] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.SsisObjectMetadataListResponse:
"""Get a SSIS integration runtime object metadata by specified path. The return is pageable
metadata list.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param get_metadata_request: The parameters for getting a SSIS object metadata. Default value
is None.
:type get_metadata_request: ~azure.mgmt.datafactory.models.GetSsisObjectMetadataRequest
:keyword content_type: Body Parameter content-type. Content type parameter for JSON body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SsisObjectMetadataListResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.SsisObjectMetadataListResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
@overload
def get(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
get_metadata_request: Optional[IO] = None,
*,
content_type: str = "application/json",
**kwargs: Any
) -> _models.SsisObjectMetadataListResponse:
"""Get a SSIS integration runtime object metadata by specified path. The return is pageable
metadata list.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param get_metadata_request: The parameters for getting a SSIS object metadata. Default value
is None.
:type get_metadata_request: IO
:keyword content_type: Body Parameter content-type. Content type parameter for binary body.
Default value is "application/json".
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SsisObjectMetadataListResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.SsisObjectMetadataListResponse
:raises ~azure.core.exceptions.HttpResponseError:
"""
[docs] @distributed_trace
def get(
self,
resource_group_name: str,
factory_name: str,
integration_runtime_name: str,
get_metadata_request: Optional[Union[_models.GetSsisObjectMetadataRequest, IO]] = None,
**kwargs: Any
) -> _models.SsisObjectMetadataListResponse:
"""Get a SSIS integration runtime object metadata by specified path. The return is pageable
metadata list.
:param resource_group_name: The resource group name. Required.
:type resource_group_name: str
:param factory_name: The factory name. Required.
:type factory_name: str
:param integration_runtime_name: The integration runtime name. Required.
:type integration_runtime_name: str
:param get_metadata_request: The parameters for getting a SSIS object metadata. Is either a
model type or a IO type. Default value is None.
:type get_metadata_request: ~azure.mgmt.datafactory.models.GetSsisObjectMetadataRequest or IO
:keyword content_type: Body Parameter content-type. Known values are: 'application/json'.
Default value is None.
:paramtype content_type: str
:keyword callable cls: A custom type or function that will be passed the direct response
:return: SsisObjectMetadataListResponse or the result of cls(response)
:rtype: ~azure.mgmt.datafactory.models.SsisObjectMetadataListResponse
: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", self._config.api_version)) # type: str
content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str]
cls = kwargs.pop("cls", None) # type: ClsType[_models.SsisObjectMetadataListResponse]
content_type = content_type or "application/json"
_json = None
_content = None
if isinstance(get_metadata_request, (IO, bytes)):
_content = get_metadata_request
else:
if get_metadata_request is not None:
_json = self._serialize.body(get_metadata_request, "GetSsisObjectMetadataRequest")
else:
_json = None
request = build_get_request(
resource_group_name=resource_group_name,
factory_name=factory_name,
integration_runtime_name=integration_runtime_name,
subscription_id=self._config.subscription_id,
api_version=api_version,
content_type=content_type,
json=_json,
content=_content,
template_url=self.get.metadata["url"],
headers=_headers,
params=_params,
)
request = _convert_request(request)
request.url = self._client.format_url(request.url) # type: ignore
pipeline_response = 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)
raise HttpResponseError(response=response, error_format=ARMErrorFormat)
deserialized = self._deserialize("SsisObjectMetadataListResponse", pipeline_response)
if cls:
return cls(pipeline_response, deserialized, {})
return deserialized
get.metadata = {"url": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/getObjectMetadata"} # type: ignore