azext_iot/sdk/digitaltwins/dataplane/operations/delete_jobs_operations.py

# 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.
# --------------------------------------------------------------------------

import uuid
from msrest.pipeline import ClientRawResponse
from msrest.polling import LROPoller, NoPolling
from msrestazure.polling.arm_polling import ARMPolling

from .. import models


class DeleteJobsOperations(object):
    """DeleteJobsOperations operations.

    :param client: Client for service requests.
    :param config: Configuration of service client.
    :param serializer: An object model serializer.
    :param deserializer: An object model deserializer.
    :ivar api_version: The requested API version. Constant value: "2023-10-31".
    """

    models = models

    def __init__(self, client, config, serializer, deserializer):

        self._client = client
        self._serialize = serializer
        self._deserialize = deserializer
        self.api_version = "2023-10-31"

        self.config = config


    def _add_initial(
            self, delete_jobs_add_options=None, custom_headers=None, raw=False, **operation_config):
        traceparent = None
        if delete_jobs_add_options is not None:
            traceparent = delete_jobs_add_options.traceparent
        tracestate = None
        if delete_jobs_add_options is not None:
            tracestate = delete_jobs_add_options.tracestate

        # Construct URL
        url = self.add.metadata['url']

        # Construct parameters
        query_parameters = {}
        query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str', min_length=1)
        if self.config.timeout_in_minutes is not None:
            query_parameters['timeoutInMinutes'] = self._serialize.query("self.config.timeout_in_minutes", self.config.timeout_in_minutes, 'int')

        # Construct headers
        header_parameters = {}
        header_parameters['Content-Type'] = 'application/json; charset=utf-8'
        if self.config.generate_client_request_id:
            header_parameters['x-ms-client-request-id'] = str(uuid.uuid1())
        if custom_headers:
            header_parameters.update(custom_headers)
        if self.config.operation_id is not None:
            header_parameters['operation-id'] = self._serialize.header("self.config.operation_id", self.config.operation_id, 'str')
        if self.config.accept_language is not None:
            header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
        if traceparent is not None:
            header_parameters['traceparent'] = self._serialize.header("traceparent", traceparent, 'str')
        if tracestate is not None:
            header_parameters['tracestate'] = self._serialize.header("tracestate", tracestate, 'str')

        # Construct and send request
        request = self._client.post(url, query_parameters)
        response = self._client.send(request, header_parameters, stream=False, **operation_config)

        if response.status_code not in [202]:
            raise models.ErrorResponseException(self._deserialize, response)

        deserialized = None
        header_dict = {}

        if response.status_code == 202:
            deserialized = self._deserialize('DeleteJob', response)
            header_dict = {
                'Operation-Location': 'str',
                'x-ms-error-code': 'str',
            }

        if raw:
            client_raw_response = ClientRawResponse(deserialized, response)
            client_raw_response.add_headers(header_dict)
            return client_raw_response

        return deserialized

    def add(
            self, delete_jobs_add_options=None, custom_headers=None, raw=False, polling=True, **operation_config):
        """Initiates a job which deletes all models, twins, and relationships on
        the instance. Does not delete any other types of entities.
        Status codes:
        * 202 Created
        * 400 Bad Request
        * JobLimitReached - The maximum number of delete jobs allowed has been
        reached.
        * ValidationFailed - Operation-Id already exists.

        :param delete_jobs_add_options: Additional parameters for the
         operation
        :type delete_jobs_add_options: ~dataplane.models.DeleteJobsAddOptions
        :param dict custom_headers: headers that will be added to the request
        :param bool raw: The poller return type is ClientRawResponse, the
         direct response alongside the deserialized response
        :param polling: True for ARMPolling, False for no polling, or a
         polling object for personal polling strategy
        :return: An instance of LROPoller that returns DeleteJob or
         ClientRawResponse<DeleteJob> if raw==True
        :rtype:
         ~msrestazure.azure_operation.AzureOperationPoller[~dataplane.models.DeleteJob]
         or
         ~msrestazure.azure_operation.AzureOperationPoller[~msrest.pipeline.ClientRawResponse[~dataplane.models.DeleteJob]]
        :raises:
         :class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
        """
        raw_result = self._add_initial(
            delete_jobs_add_options=delete_jobs_add_options,
            custom_headers=custom_headers,
            raw=True,
            **operation_config
        )

        def get_long_running_output(response):
            header_dict = {
                'Operation-Location': 'str',
                'x-ms-error-code': 'str',
            }
            deserialized = self._deserialize('DeleteJob', response)

            if raw:
                client_raw_response = ClientRawResponse(deserialized, response)
                client_raw_response.add_headers(header_dict)
                return client_raw_response

            return deserialized

        lro_delay = operation_config.get(
            'long_running_operation_timeout',
            self.config.long_running_operation_timeout)
        if polling is True: polling_method = ARMPolling(lro_delay, **operation_config)
        elif polling is False: polling_method = NoPolling()
        else: polling_method = polling
        return LROPoller(self._client, raw_result, get_long_running_output, polling_method)
    add.metadata = {'url': '/jobs/deletions'}

    def list(
            self, delete_jobs_list_options=None, custom_headers=None, raw=False, **operation_config):
        """Retrieves all deletion jobs. This may be useful to find a delete job
        that was previously requested, or to view a history of delete jobs that
        have run or are currently running on the instance.
        Status codes:
        * 200 OK.

        :param delete_jobs_list_options: Additional parameters for the
         operation
        :type delete_jobs_list_options:
         ~dataplane.models.DeleteJobsListOptions
        :param dict custom_headers: headers that will be added to the request
        :param bool raw: returns the direct response alongside the
         deserialized response
        :param operation_config: :ref:`Operation configuration
         overrides<msrest:optionsforoperations>`.
        :return: An iterator like instance of DeleteJob
        :rtype: ~dataplane.models.DeleteJobPaged[~dataplane.models.DeleteJob]
        :raises:
         :class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
        """
        max_items_per_page = None
        if delete_jobs_list_options is not None:
            max_items_per_page = delete_jobs_list_options.max_items_per_page
        traceparent = None
        if delete_jobs_list_options is not None:
            traceparent = delete_jobs_list_options.traceparent
        tracestate = None
        if delete_jobs_list_options is not None:
            tracestate = delete_jobs_list_options.tracestate

        def internal_paging(next_link=None, raw=False):

            if not next_link:
                # Construct URL
                url = self.list.metadata['url']

                # Construct parameters
                query_parameters = {}
                query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str', min_length=1)

            else:
                url = next_link
                query_parameters = {}

            # Construct headers
            header_parameters = {}
            header_parameters['Content-Type'] = 'application/json; charset=utf-8'
            if self.config.generate_client_request_id:
                header_parameters['x-ms-client-request-id'] = str(uuid.uuid1())
            if custom_headers:
                header_parameters.update(custom_headers)
            if self.config.accept_language is not None:
                header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
            if max_items_per_page is not None:
                header_parameters['max-items-per-page'] = self._serialize.header("max_items_per_page", max_items_per_page, 'int')
            if traceparent is not None:
                header_parameters['traceparent'] = self._serialize.header("traceparent", traceparent, 'str')
            if tracestate is not None:
                header_parameters['tracestate'] = self._serialize.header("tracestate", tracestate, 'str')

            # Construct and send request
            request = self._client.get(url, query_parameters)
            response = self._client.send(
                request, header_parameters, stream=False, **operation_config)

            if response.status_code not in [200]:
                raise models.ErrorResponseException(self._deserialize, response)

            return response

        # Deserialize response
        deserialized = models.DeleteJobPaged(internal_paging, self._deserialize.dependencies)

        if raw:
            header_dict = {}
            client_raw_response = models.DeleteJobPaged(internal_paging, self._deserialize.dependencies, header_dict)
            return client_raw_response

        return deserialized
    list.metadata = {'url': '/jobs/deletions'}

    def get_by_id(
            self, id, delete_jobs_get_by_id_options=None, custom_headers=None, raw=False, **operation_config):
        """Retrieves a delete job.
        Status codes:
        * 200 OK
        * 404 Not Found
        * DeleteJobNotFound - The delete job was not found.

        :param id: The id for the delete job. The id is unique within the
         service and case sensitive.
        :type id: str
        :param delete_jobs_get_by_id_options: Additional parameters for the
         operation
        :type delete_jobs_get_by_id_options:
         ~dataplane.models.DeleteJobsGetByIdOptions
        :param dict custom_headers: headers that will be added to the request
        :param bool raw: returns the direct response alongside the
         deserialized response
        :param operation_config: :ref:`Operation configuration
         overrides<msrest:optionsforoperations>`.
        :return: DeleteJob or ClientRawResponse if raw=true
        :rtype: ~dataplane.models.DeleteJob or
         ~msrest.pipeline.ClientRawResponse
        :raises:
         :class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
        """
        traceparent = None
        if delete_jobs_get_by_id_options is not None:
            traceparent = delete_jobs_get_by_id_options.traceparent
        tracestate = None
        if delete_jobs_get_by_id_options is not None:
            tracestate = delete_jobs_get_by_id_options.tracestate

        # Construct URL
        url = self.get_by_id.metadata['url']
        path_format_arguments = {
            'id': self._serialize.url("id", id, 'str')
        }
        url = self._client.format_url(url, **path_format_arguments)

        # Construct parameters
        query_parameters = {}
        query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str', min_length=1)

        # Construct headers
        header_parameters = {}
        header_parameters['Content-Type'] = 'application/json; charset=utf-8'
        if self.config.generate_client_request_id:
            header_parameters['x-ms-client-request-id'] = str(uuid.uuid1())
        if custom_headers:
            header_parameters.update(custom_headers)
        if self.config.accept_language is not None:
            header_parameters['accept-language'] = self._serialize.header("self.config.accept_language", self.config.accept_language, 'str')
        if traceparent is not None:
            header_parameters['traceparent'] = self._serialize.header("traceparent", traceparent, 'str')
        if tracestate is not None:
            header_parameters['tracestate'] = self._serialize.header("tracestate", tracestate, 'str')

        # Construct and send request
        request = self._client.get(url, query_parameters)
        response = self._client.send(request, header_parameters, stream=False, **operation_config)

        if response.status_code not in [200]:
            raise models.ErrorResponseException(self._deserialize, response)

        deserialized = None
        header_dict = {}

        if response.status_code == 200:
            deserialized = self._deserialize('DeleteJob', response)
            header_dict = {
                'x-ms-error-code': 'str',
            }

        if raw:
            client_raw_response = ClientRawResponse(deserialized, response)
            client_raw_response.add_headers(header_dict)
            return client_raw_response

        return deserialized
    get_by_id.metadata = {'url': '/jobs/deletions/{id}'}