def cancel()

in azext_iot/sdk/digitaltwins/dataplane/operations/import_jobs_operations.py [0:0]

• 43 lines of code
• 12 McCabe index (conditional complexity)

    def cancel(
            self, id, import_jobs_cancel_options=None, custom_headers=None, raw=False, **operation_config):
        """Cancels an import job that is currently running. Service will stop any
        import operations triggered by the current import job that are in
        progress, and go to a cancelled state. Please note that this will leave
        your instance in an unknown state as there won't be any rollback
        operation.
        Status codes:
        * 200 Request Accepted
        * 400 Bad Request
        * ValidationFailed - The import job request is not valid.

        :param id: The id for the import job. The id is unique within the
         service and case sensitive.
        :type id: str
        :param import_jobs_cancel_options: Additional parameters for the
         operation
        :type import_jobs_cancel_options:
         ~dataplane.models.ImportJobsCancelOptions
        :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: ImportJob or ClientRawResponse if raw=true
        :rtype: ~dataplane.models.ImportJob or
         ~msrest.pipeline.ClientRawResponse
        :raises:
         :class:`ErrorResponseException<dataplane.models.ErrorResponseException>`
        """
        traceparent = None
        if import_jobs_cancel_options is not None:
            traceparent = import_jobs_cancel_options.traceparent
        tracestate = None
        if import_jobs_cancel_options is not None:
            tracestate = import_jobs_cancel_options.tracestate

        # Construct URL
        url = self.cancel.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.post(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('ImportJob', 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