Source code for azure.batch.operations.job_schedule_operations

# 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 msrest.pipeline import ClientRawResponse
import uuid

from .. import models


[docs]class JobScheduleOperations(object): """JobScheduleOperations operations. :param client: Client for service requests. :param config: Configuration of service client. :param serializer: An object model serializer. :param deserializer: An objec model deserializer. """ def __init__(self, client, config, serializer, deserializer): self._client = client self._serialize = serializer self._deserialize = deserializer self.config = config
[docs] def exists( self, job_schedule_id, job_schedule_exists_options=None, custom_headers=None, raw=False, **operation_config): """Checks the specified job schedule exists. :param job_schedule_id: The id of the job schedule which you want to check. :type job_schedule_id: str :param job_schedule_exists_options: Additional parameters for the operation :type job_schedule_exists_options: :class:`JobScheduleExistsOptions <azure.batch.models.JobScheduleExistsOptions>` :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>`. :rtype: bool :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_exists_options is not None: timeout = job_schedule_exists_options.timeout client_request_id = None if job_schedule_exists_options is not None: client_request_id = job_schedule_exists_options.client_request_id return_client_request_id = None if job_schedule_exists_options is not None: return_client_request_id = job_schedule_exists_options.return_client_request_id ocp_date = None if job_schedule_exists_options is not None: ocp_date = job_schedule_exists_options.ocp_date if_match = None if job_schedule_exists_options is not None: if_match = job_schedule_exists_options.if_match if_none_match = None if job_schedule_exists_options is not None: if_none_match = job_schedule_exists_options.if_none_match if_modified_since = None if job_schedule_exists_options is not None: if_modified_since = job_schedule_exists_options.if_modified_since if_unmodified_since = None if job_schedule_exists_options is not None: if_unmodified_since = job_schedule_exists_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct and send request request = self._client.head(url, query_parameters) response = self._client.send(request, header_parameters, **operation_config) if response.status_code not in [200, 404]: raise models.BatchErrorException(self._deserialize, response) deserialized = (response.status_code == 200) if raw: client_raw_response = ClientRawResponse(deserialized, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', }) return client_raw_response return deserialized
[docs] def delete( self, job_schedule_id, job_schedule_delete_options=None, custom_headers=None, raw=False, **operation_config): """Deletes a job schedule from the specified account. :param job_schedule_id: The id of the job schedule to delete. :type job_schedule_id: str :param job_schedule_delete_options: Additional parameters for the operation :type job_schedule_delete_options: :class:`JobScheduleDeleteOptions <azure.batch.models.JobScheduleDeleteOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_delete_options is not None: timeout = job_schedule_delete_options.timeout client_request_id = None if job_schedule_delete_options is not None: client_request_id = job_schedule_delete_options.client_request_id return_client_request_id = None if job_schedule_delete_options is not None: return_client_request_id = job_schedule_delete_options.return_client_request_id ocp_date = None if job_schedule_delete_options is not None: ocp_date = job_schedule_delete_options.ocp_date if_match = None if job_schedule_delete_options is not None: if_match = job_schedule_delete_options.if_match if_none_match = None if job_schedule_delete_options is not None: if_none_match = job_schedule_delete_options.if_none_match if_modified_since = None if job_schedule_delete_options is not None: if_modified_since = job_schedule_delete_options.if_modified_since if_unmodified_since = None if job_schedule_delete_options is not None: if_unmodified_since = job_schedule_delete_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct and send request request = self._client.delete(url, query_parameters) response = self._client.send(request, header_parameters, **operation_config) if response.status_code not in [202]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', }) return client_raw_response
[docs] def get( self, job_schedule_id, job_schedule_get_options=None, custom_headers=None, raw=False, **operation_config): """Gets information about the specified job schedule. :param job_schedule_id: The id of the job schedule to get. :type job_schedule_id: str :param job_schedule_get_options: Additional parameters for the operation :type job_schedule_get_options: :class:`JobScheduleGetOptions <azure.batch.models.JobScheduleGetOptions>` :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>`. :rtype: :class:`CloudJobSchedule <azure.batch.models.CloudJobSchedule>` :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ select = None if job_schedule_get_options is not None: select = job_schedule_get_options.select expand = None if job_schedule_get_options is not None: expand = job_schedule_get_options.expand timeout = None if job_schedule_get_options is not None: timeout = job_schedule_get_options.timeout client_request_id = None if job_schedule_get_options is not None: client_request_id = job_schedule_get_options.client_request_id return_client_request_id = None if job_schedule_get_options is not None: return_client_request_id = job_schedule_get_options.return_client_request_id ocp_date = None if job_schedule_get_options is not None: ocp_date = job_schedule_get_options.ocp_date if_match = None if job_schedule_get_options is not None: if_match = job_schedule_get_options.if_match if_none_match = None if job_schedule_get_options is not None: if_none_match = job_schedule_get_options.if_none_match if_modified_since = None if job_schedule_get_options is not None: if_modified_since = job_schedule_get_options.if_modified_since if_unmodified_since = None if job_schedule_get_options is not None: if_unmodified_since = job_schedule_get_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if select is not None: query_parameters['$select'] = self._serialize.query("select", select, 'str') if expand is not None: query_parameters['$expand'] = self._serialize.query("expand", expand, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct and send request request = self._client.get(url, query_parameters) response = self._client.send(request, header_parameters, **operation_config) if response.status_code not in [200]: raise models.BatchErrorException(self._deserialize, response) deserialized = None header_dict = {} if response.status_code == 200: deserialized = self._deserialize('CloudJobSchedule', response) header_dict = { 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', } if raw: client_raw_response = ClientRawResponse(deserialized, response) client_raw_response.add_headers(header_dict) return client_raw_response return deserialized
[docs] def patch( self, job_schedule_id, job_schedule_patch_parameter, job_schedule_patch_options=None, custom_headers=None, raw=False, **operation_config): """Updates the properties of the specified job schedule. :param job_schedule_id: The id of the job schedule to update. :type job_schedule_id: str :param job_schedule_patch_parameter: The parameters for the request. :type job_schedule_patch_parameter: :class:`JobSchedulePatchParameter <azure.batch.models.JobSchedulePatchParameter>` :param job_schedule_patch_options: Additional parameters for the operation :type job_schedule_patch_options: :class:`JobSchedulePatchOptions <azure.batch.models.JobSchedulePatchOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_patch_options is not None: timeout = job_schedule_patch_options.timeout client_request_id = None if job_schedule_patch_options is not None: client_request_id = job_schedule_patch_options.client_request_id return_client_request_id = None if job_schedule_patch_options is not None: return_client_request_id = job_schedule_patch_options.return_client_request_id ocp_date = None if job_schedule_patch_options is not None: ocp_date = job_schedule_patch_options.ocp_date if_match = None if job_schedule_patch_options is not None: if_match = job_schedule_patch_options.if_match if_none_match = None if job_schedule_patch_options is not None: if_none_match = job_schedule_patch_options.if_none_match if_modified_since = None if job_schedule_patch_options is not None: if_modified_since = job_schedule_patch_options.if_modified_since if_unmodified_since = None if job_schedule_patch_options is not None: if_unmodified_since = job_schedule_patch_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct body body_content = self._serialize.body(job_schedule_patch_parameter, 'JobSchedulePatchParameter') # Construct and send request request = self._client.patch(url, query_parameters) response = self._client.send( request, header_parameters, body_content, **operation_config) if response.status_code not in [200]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', 'DataServiceId': 'str', }) return client_raw_response
[docs] def update( self, job_schedule_id, job_schedule_update_parameter, job_schedule_update_options=None, custom_headers=None, raw=False, **operation_config): """Updates the properties of the specified job schedule. :param job_schedule_id: The id of the job schedule to update. :type job_schedule_id: str :param job_schedule_update_parameter: The parameters for the request. :type job_schedule_update_parameter: :class:`JobScheduleUpdateParameter <azure.batch.models.JobScheduleUpdateParameter>` :param job_schedule_update_options: Additional parameters for the operation :type job_schedule_update_options: :class:`JobScheduleUpdateOptions <azure.batch.models.JobScheduleUpdateOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_update_options is not None: timeout = job_schedule_update_options.timeout client_request_id = None if job_schedule_update_options is not None: client_request_id = job_schedule_update_options.client_request_id return_client_request_id = None if job_schedule_update_options is not None: return_client_request_id = job_schedule_update_options.return_client_request_id ocp_date = None if job_schedule_update_options is not None: ocp_date = job_schedule_update_options.ocp_date if_match = None if job_schedule_update_options is not None: if_match = job_schedule_update_options.if_match if_none_match = None if job_schedule_update_options is not None: if_none_match = job_schedule_update_options.if_none_match if_modified_since = None if job_schedule_update_options is not None: if_modified_since = job_schedule_update_options.if_modified_since if_unmodified_since = None if job_schedule_update_options is not None: if_unmodified_since = job_schedule_update_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct body body_content = self._serialize.body(job_schedule_update_parameter, 'JobScheduleUpdateParameter') # Construct and send request request = self._client.put(url, query_parameters) response = self._client.send( request, header_parameters, body_content, **operation_config) if response.status_code not in [200]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', 'DataServiceId': 'str', }) return client_raw_response
[docs] def disable( self, job_schedule_id, job_schedule_disable_options=None, custom_headers=None, raw=False, **operation_config): """Disables a job schedule. :param job_schedule_id: The id of the job schedule to disable. :type job_schedule_id: str :param job_schedule_disable_options: Additional parameters for the operation :type job_schedule_disable_options: :class:`JobScheduleDisableOptions <azure.batch.models.JobScheduleDisableOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_disable_options is not None: timeout = job_schedule_disable_options.timeout client_request_id = None if job_schedule_disable_options is not None: client_request_id = job_schedule_disable_options.client_request_id return_client_request_id = None if job_schedule_disable_options is not None: return_client_request_id = job_schedule_disable_options.return_client_request_id ocp_date = None if job_schedule_disable_options is not None: ocp_date = job_schedule_disable_options.ocp_date if_match = None if job_schedule_disable_options is not None: if_match = job_schedule_disable_options.if_match if_none_match = None if job_schedule_disable_options is not None: if_none_match = job_schedule_disable_options.if_none_match if_modified_since = None if job_schedule_disable_options is not None: if_modified_since = job_schedule_disable_options.if_modified_since if_unmodified_since = None if job_schedule_disable_options is not None: if_unmodified_since = job_schedule_disable_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}/disable' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct and send request request = self._client.post(url, query_parameters) response = self._client.send(request, header_parameters, **operation_config) if response.status_code not in [204]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', 'DataServiceId': 'str', }) return client_raw_response
[docs] def enable( self, job_schedule_id, job_schedule_enable_options=None, custom_headers=None, raw=False, **operation_config): """Enables a job schedule. :param job_schedule_id: The id of the job schedule to enable. :type job_schedule_id: str :param job_schedule_enable_options: Additional parameters for the operation :type job_schedule_enable_options: :class:`JobScheduleEnableOptions <azure.batch.models.JobScheduleEnableOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_enable_options is not None: timeout = job_schedule_enable_options.timeout client_request_id = None if job_schedule_enable_options is not None: client_request_id = job_schedule_enable_options.client_request_id return_client_request_id = None if job_schedule_enable_options is not None: return_client_request_id = job_schedule_enable_options.return_client_request_id ocp_date = None if job_schedule_enable_options is not None: ocp_date = job_schedule_enable_options.ocp_date if_match = None if job_schedule_enable_options is not None: if_match = job_schedule_enable_options.if_match if_none_match = None if job_schedule_enable_options is not None: if_none_match = job_schedule_enable_options.if_none_match if_modified_since = None if job_schedule_enable_options is not None: if_modified_since = job_schedule_enable_options.if_modified_since if_unmodified_since = None if job_schedule_enable_options is not None: if_unmodified_since = job_schedule_enable_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}/enable' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct and send request request = self._client.post(url, query_parameters) response = self._client.send(request, header_parameters, **operation_config) if response.status_code not in [204]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', 'DataServiceId': 'str', }) return client_raw_response
[docs] def terminate( self, job_schedule_id, job_schedule_terminate_options=None, custom_headers=None, raw=False, **operation_config): """Terminates a job schedule. :param job_schedule_id: The id of the job schedule to terminates. :type job_schedule_id: str :param job_schedule_terminate_options: Additional parameters for the operation :type job_schedule_terminate_options: :class:`JobScheduleTerminateOptions <azure.batch.models.JobScheduleTerminateOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_terminate_options is not None: timeout = job_schedule_terminate_options.timeout client_request_id = None if job_schedule_terminate_options is not None: client_request_id = job_schedule_terminate_options.client_request_id return_client_request_id = None if job_schedule_terminate_options is not None: return_client_request_id = job_schedule_terminate_options.return_client_request_id ocp_date = None if job_schedule_terminate_options is not None: ocp_date = job_schedule_terminate_options.ocp_date if_match = None if job_schedule_terminate_options is not None: if_match = job_schedule_terminate_options.if_match if_none_match = None if job_schedule_terminate_options is not None: if_none_match = job_schedule_terminate_options.if_none_match if_modified_since = None if job_schedule_terminate_options is not None: if_modified_since = job_schedule_terminate_options.if_modified_since if_unmodified_since = None if job_schedule_terminate_options is not None: if_unmodified_since = job_schedule_terminate_options.if_unmodified_since # Construct URL url = '/jobschedules/{jobScheduleId}/terminate' path_format_arguments = { 'jobScheduleId': self._serialize.url("job_schedule_id", job_schedule_id, 'str') } url = self._client.format_url(url, **path_format_arguments) # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') if if_match is not None: header_parameters['If-Match'] = self._serialize.header("if_match", if_match, 'str') if if_none_match is not None: header_parameters['If-None-Match'] = self._serialize.header("if_none_match", if_none_match, 'str') if if_modified_since is not None: header_parameters['If-Modified-Since'] = self._serialize.header("if_modified_since", if_modified_since, 'rfc-1123') if if_unmodified_since is not None: header_parameters['If-Unmodified-Since'] = self._serialize.header("if_unmodified_since", if_unmodified_since, 'rfc-1123') # Construct and send request request = self._client.post(url, query_parameters) response = self._client.send(request, header_parameters, **operation_config) if response.status_code not in [202]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', 'DataServiceId': 'str', }) return client_raw_response
[docs] def add( self, cloud_job_schedule, job_schedule_add_options=None, custom_headers=None, raw=False, **operation_config): """Adds a job schedule to the specified account. :param cloud_job_schedule: The job schedule to be added. :type cloud_job_schedule: :class:`JobScheduleAddParameter <azure.batch.models.JobScheduleAddParameter>` :param job_schedule_add_options: Additional parameters for the operation :type job_schedule_add_options: :class:`JobScheduleAddOptions <azure.batch.models.JobScheduleAddOptions>` :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>`. :rtype: None :rtype: :class:`ClientRawResponse<msrest.pipeline.ClientRawResponse>` if raw=true """ timeout = None if job_schedule_add_options is not None: timeout = job_schedule_add_options.timeout client_request_id = None if job_schedule_add_options is not None: client_request_id = job_schedule_add_options.client_request_id return_client_request_id = None if job_schedule_add_options is not None: return_client_request_id = job_schedule_add_options.return_client_request_id ocp_date = None if job_schedule_add_options is not None: ocp_date = job_schedule_add_options.ocp_date # Construct URL url = '/jobschedules' # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') # Construct body body_content = self._serialize.body(cloud_job_schedule, 'JobScheduleAddParameter') # Construct and send request request = self._client.post(url, query_parameters) response = self._client.send( request, header_parameters, body_content, **operation_config) if response.status_code not in [201]: raise models.BatchErrorException(self._deserialize, response) if raw: client_raw_response = ClientRawResponse(None, response) client_raw_response.add_headers({ 'client-request-id': 'str', 'request-id': 'str', 'ETag': 'str', 'Last-Modified': 'rfc-1123', 'DataServiceId': 'str', }) return client_raw_response
[docs] def list( self, job_schedule_list_options=None, custom_headers=None, raw=False, **operation_config): """Lists all of the job schedules in the specified account. :param job_schedule_list_options: Additional parameters for the operation :type job_schedule_list_options: :class:`JobScheduleListOptions <azure.batch.models.JobScheduleListOptions>` :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>`. :rtype: :class:`CloudJobSchedulePaged <azure.batch.models.CloudJobSchedulePaged>` """ filter = None if job_schedule_list_options is not None: filter = job_schedule_list_options.filter select = None if job_schedule_list_options is not None: select = job_schedule_list_options.select expand = None if job_schedule_list_options is not None: expand = job_schedule_list_options.expand max_results = None if job_schedule_list_options is not None: max_results = job_schedule_list_options.max_results timeout = None if job_schedule_list_options is not None: timeout = job_schedule_list_options.timeout client_request_id = None if job_schedule_list_options is not None: client_request_id = job_schedule_list_options.client_request_id return_client_request_id = None if job_schedule_list_options is not None: return_client_request_id = job_schedule_list_options.return_client_request_id ocp_date = None if job_schedule_list_options is not None: ocp_date = job_schedule_list_options.ocp_date def internal_paging(next_link=None, raw=False): if not next_link: # Construct URL url = '/jobschedules' # Construct parameters query_parameters = {} query_parameters['api-version'] = self._serialize.query("self.config.api_version", self.config.api_version, 'str') if filter is not None: query_parameters['$filter'] = self._serialize.query("filter", filter, 'str') if select is not None: query_parameters['$select'] = self._serialize.query("select", select, 'str') if expand is not None: query_parameters['$expand'] = self._serialize.query("expand", expand, 'str') if max_results is not None: query_parameters['maxresults'] = self._serialize.query("max_results", max_results, 'int') if timeout is not None: query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int') else: url = next_link query_parameters = {} # Construct headers header_parameters = {} header_parameters['Content-Type'] = 'application/json; odata=minimalmetadata; charset=utf-8' if self.config.generate_client_request_id: header_parameters['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 client_request_id is not None: header_parameters['client-request-id'] = self._serialize.header("client_request_id", client_request_id, 'str') if return_client_request_id is not None: header_parameters['return-client-request-id'] = self._serialize.header("return_client_request_id", return_client_request_id, 'bool') if ocp_date is not None: header_parameters['ocp-date'] = self._serialize.header("ocp_date", ocp_date, 'rfc-1123') # Construct and send request request = self._client.get(url, query_parameters) response = self._client.send( request, header_parameters, **operation_config) if response.status_code not in [200]: raise models.BatchErrorException(self._deserialize, response) return response # Deserialize response deserialized = models.CloudJobSchedulePaged(internal_paging, self._deserialize.dependencies) if raw: header_dict = {} client_raw_response = models.CloudJobSchedulePaged(internal_paging, self._deserialize.dependencies, header_dict) return client_raw_response return deserialized