# 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 .. import models
[docs]class FileOperations(object):
"""FileOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
: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: Client API Version. Constant value: "2020-03-01.11.0".
"""
models = models
def __init__(self, client, config, serializer, deserializer):
self._client = client
self._serialize = serializer
self._deserialize = deserializer
self.api_version = "2020-03-01.11.0"
self.config = config
[docs] def delete_from_task(
self, job_id, task_id, file_path, recursive=None, file_delete_from_task_options=None, custom_headers=None, raw=False, **operation_config):
"""Deletes the specified Task file from the Compute Node where the Task
ran.
:param job_id: The ID of the Job that contains the Task.
:type job_id: str
:param task_id: The ID of the Task whose file you want to delete.
:type task_id: str
:param file_path: The path to the Task file or directory that you want
to delete.
:type file_path: str
:param recursive: Whether to delete children of a directory. If the
filePath parameter represents a directory instead of a file, you can
set recursive to true to delete the directory and all of the files and
subdirectories in it. If recursive is false then the directory must be
empty or deletion will fail.
:type recursive: bool
:param file_delete_from_task_options: Additional parameters for the
operation
:type file_delete_from_task_options:
~azure.batch.models.FileDeleteFromTaskOptions
: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: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if file_delete_from_task_options is not None:
timeout = file_delete_from_task_options.timeout
client_request_id = None
if file_delete_from_task_options is not None:
client_request_id = file_delete_from_task_options.client_request_id
return_client_request_id = None
if file_delete_from_task_options is not None:
return_client_request_id = file_delete_from_task_options.return_client_request_id
ocp_date = None
if file_delete_from_task_options is not None:
ocp_date = file_delete_from_task_options.ocp_date
# Construct URL
url = self.delete_from_task.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'jobId': self._serialize.url("job_id", job_id, 'str'),
'taskId': self._serialize.url("task_id", task_id, 'str'),
'filePath': self._serialize.url("file_path", file_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if recursive is not None:
query_parameters['recursive'] = self._serialize.query("recursive", recursive, 'bool')
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
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.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **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',
})
return client_raw_response
delete_from_task.metadata = {'url': '/jobs/{jobId}/tasks/{taskId}/files/{filePath}'}
[docs] def get_from_task(
self, job_id, task_id, file_path, file_get_from_task_options=None, custom_headers=None, raw=False, callback=None, **operation_config):
"""Returns the content of the specified Task file.
:param job_id: The ID of the Job that contains the Task.
:type job_id: str
:param task_id: The ID of the Task whose file you want to retrieve.
:type task_id: str
:param file_path: The path to the Task file that you want to get the
content of.
:type file_path: str
:param file_get_from_task_options: Additional parameters for the
operation
:type file_get_from_task_options:
~azure.batch.models.FileGetFromTaskOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: object or ClientRawResponse if raw=true
:rtype: Generator or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if file_get_from_task_options is not None:
timeout = file_get_from_task_options.timeout
client_request_id = None
if file_get_from_task_options is not None:
client_request_id = file_get_from_task_options.client_request_id
return_client_request_id = None
if file_get_from_task_options is not None:
return_client_request_id = file_get_from_task_options.return_client_request_id
ocp_date = None
if file_get_from_task_options is not None:
ocp_date = file_get_from_task_options.ocp_date
ocp_range = None
if file_get_from_task_options is not None:
ocp_range = file_get_from_task_options.ocp_range
if_modified_since = None
if file_get_from_task_options is not None:
if_modified_since = file_get_from_task_options.if_modified_since
if_unmodified_since = None
if file_get_from_task_options is not None:
if_unmodified_since = file_get_from_task_options.if_unmodified_since
# Construct URL
url = self.get_from_task.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'jobId': self._serialize.url("job_id", job_id, 'str'),
'taskId': self._serialize.url("task_id", task_id, 'str'),
'filePath': self._serialize.url("file_path", file_path, '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')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
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 ocp_range is not None:
header_parameters['ocp-range'] = self._serialize.header("ocp_range", ocp_range, '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, header_parameters)
response = self._client.send(request, stream=True, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
header_dict = {}
deserialized = self._client.stream_download(response, callback)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized
get_from_task.metadata = {'url': '/jobs/{jobId}/tasks/{taskId}/files/{filePath}'}
[docs] def get_properties_from_task(
self, job_id, task_id, file_path, file_get_properties_from_task_options=None, custom_headers=None, raw=False, **operation_config):
"""Gets the properties of the specified Task file.
:param job_id: The ID of the Job that contains the Task.
:type job_id: str
:param task_id: The ID of the Task whose file you want to get the
properties of.
:type task_id: str
:param file_path: The path to the Task file that you want to get the
properties of.
:type file_path: str
:param file_get_properties_from_task_options: Additional parameters
for the operation
:type file_get_properties_from_task_options:
~azure.batch.models.FileGetPropertiesFromTaskOptions
: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: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if file_get_properties_from_task_options is not None:
timeout = file_get_properties_from_task_options.timeout
client_request_id = None
if file_get_properties_from_task_options is not None:
client_request_id = file_get_properties_from_task_options.client_request_id
return_client_request_id = None
if file_get_properties_from_task_options is not None:
return_client_request_id = file_get_properties_from_task_options.return_client_request_id
ocp_date = None
if file_get_properties_from_task_options is not None:
ocp_date = file_get_properties_from_task_options.ocp_date
if_modified_since = None
if file_get_properties_from_task_options is not None:
if_modified_since = file_get_properties_from_task_options.if_modified_since
if_unmodified_since = None
if file_get_properties_from_task_options is not None:
if_unmodified_since = file_get_properties_from_task_options.if_unmodified_since
# Construct URL
url = self.get_properties_from_task.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'jobId': self._serialize.url("job_id", job_id, 'str'),
'taskId': self._serialize.url("task_id", task_id, 'str'),
'filePath': self._serialize.url("file_path", file_path, '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')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
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_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, header_parameters)
response = self._client.send(request, stream=False, **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',
'ocp-creation-time': 'rfc-1123',
'ocp-batch-file-isdirectory': 'bool',
'ocp-batch-file-url': 'str',
'ocp-batch-file-mode': 'str',
'Content-Type': 'str',
'Content-Length': 'long',
})
return client_raw_response
get_properties_from_task.metadata = {'url': '/jobs/{jobId}/tasks/{taskId}/files/{filePath}'}
[docs] def delete_from_compute_node(
self, pool_id, node_id, file_path, recursive=None, file_delete_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config):
"""Deletes the specified file from the Compute Node.
:param pool_id: The ID of the Pool that contains the Compute Node.
:type pool_id: str
:param node_id: The ID of the Compute Node from which you want to
delete the file.
:type node_id: str
:param file_path: The path to the file or directory that you want to
delete.
:type file_path: str
:param recursive: Whether to delete children of a directory. If the
filePath parameter represents a directory instead of a file, you can
set recursive to true to delete the directory and all of the files and
subdirectories in it. If recursive is false then the directory must be
empty or deletion will fail.
:type recursive: bool
:param file_delete_from_compute_node_options: Additional parameters
for the operation
:type file_delete_from_compute_node_options:
~azure.batch.models.FileDeleteFromComputeNodeOptions
: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: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if file_delete_from_compute_node_options is not None:
timeout = file_delete_from_compute_node_options.timeout
client_request_id = None
if file_delete_from_compute_node_options is not None:
client_request_id = file_delete_from_compute_node_options.client_request_id
return_client_request_id = None
if file_delete_from_compute_node_options is not None:
return_client_request_id = file_delete_from_compute_node_options.return_client_request_id
ocp_date = None
if file_delete_from_compute_node_options is not None:
ocp_date = file_delete_from_compute_node_options.ocp_date
# Construct URL
url = self.delete_from_compute_node.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str'),
'filePath': self._serialize.url("file_path", file_path, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if recursive is not None:
query_parameters['recursive'] = self._serialize.query("recursive", recursive, 'bool')
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
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.delete(url, query_parameters, header_parameters)
response = self._client.send(request, stream=False, **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',
})
return client_raw_response
delete_from_compute_node.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/files/{filePath}'}
[docs] def get_from_compute_node(
self, pool_id, node_id, file_path, file_get_from_compute_node_options=None, custom_headers=None, raw=False, callback=None, **operation_config):
"""Returns the content of the specified Compute Node file.
:param pool_id: The ID of the Pool that contains the Compute Node.
:type pool_id: str
:param node_id: The ID of the Compute Node that contains the file.
:type node_id: str
:param file_path: The path to the Compute Node file that you want to
get the content of.
:type file_path: str
:param file_get_from_compute_node_options: Additional parameters for
the operation
:type file_get_from_compute_node_options:
~azure.batch.models.FileGetFromComputeNodeOptions
:param dict custom_headers: headers that will be added to the request
:param bool raw: returns the direct response alongside the
deserialized response
:param callback: When specified, will be called with each chunk of
data that is streamed. The callback should take two arguments, the
bytes of the current chunk of data and the response object. If the
data is uploading, response will be None.
:type callback: Callable[Bytes, response=None]
:param operation_config: :ref:`Operation configuration
overrides<msrest:optionsforoperations>`.
:return: object or ClientRawResponse if raw=true
:rtype: Generator or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if file_get_from_compute_node_options is not None:
timeout = file_get_from_compute_node_options.timeout
client_request_id = None
if file_get_from_compute_node_options is not None:
client_request_id = file_get_from_compute_node_options.client_request_id
return_client_request_id = None
if file_get_from_compute_node_options is not None:
return_client_request_id = file_get_from_compute_node_options.return_client_request_id
ocp_date = None
if file_get_from_compute_node_options is not None:
ocp_date = file_get_from_compute_node_options.ocp_date
ocp_range = None
if file_get_from_compute_node_options is not None:
ocp_range = file_get_from_compute_node_options.ocp_range
if_modified_since = None
if file_get_from_compute_node_options is not None:
if_modified_since = file_get_from_compute_node_options.if_modified_since
if_unmodified_since = None
if file_get_from_compute_node_options is not None:
if_unmodified_since = file_get_from_compute_node_options.if_unmodified_since
# Construct URL
url = self.get_from_compute_node.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str'),
'filePath': self._serialize.url("file_path", file_path, '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')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
header_parameters['Accept'] = 'application/json'
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 ocp_range is not None:
header_parameters['ocp-range'] = self._serialize.header("ocp_range", ocp_range, '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, header_parameters)
response = self._client.send(request, stream=True, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
header_dict = {}
deserialized = self._client.stream_download(response, callback)
if raw:
client_raw_response = ClientRawResponse(deserialized, response)
client_raw_response.add_headers(header_dict)
return client_raw_response
return deserialized
get_from_compute_node.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/files/{filePath}'}
[docs] def get_properties_from_compute_node(
self, pool_id, node_id, file_path, file_get_properties_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config):
"""Gets the properties of the specified Compute Node file.
:param pool_id: The ID of the Pool that contains the Compute Node.
:type pool_id: str
:param node_id: The ID of the Compute Node that contains the file.
:type node_id: str
:param file_path: The path to the Compute Node file that you want to
get the properties of.
:type file_path: str
:param file_get_properties_from_compute_node_options: Additional
parameters for the operation
:type file_get_properties_from_compute_node_options:
~azure.batch.models.FileGetPropertiesFromComputeNodeOptions
: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: None or ClientRawResponse if raw=true
:rtype: None or ~msrest.pipeline.ClientRawResponse
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
timeout = None
if file_get_properties_from_compute_node_options is not None:
timeout = file_get_properties_from_compute_node_options.timeout
client_request_id = None
if file_get_properties_from_compute_node_options is not None:
client_request_id = file_get_properties_from_compute_node_options.client_request_id
return_client_request_id = None
if file_get_properties_from_compute_node_options is not None:
return_client_request_id = file_get_properties_from_compute_node_options.return_client_request_id
ocp_date = None
if file_get_properties_from_compute_node_options is not None:
ocp_date = file_get_properties_from_compute_node_options.ocp_date
if_modified_since = None
if file_get_properties_from_compute_node_options is not None:
if_modified_since = file_get_properties_from_compute_node_options.if_modified_since
if_unmodified_since = None
if file_get_properties_from_compute_node_options is not None:
if_unmodified_since = file_get_properties_from_compute_node_options.if_unmodified_since
# Construct URL
url = self.get_properties_from_compute_node.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str'),
'filePath': self._serialize.url("file_path", file_path, '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')
if timeout is not None:
query_parameters['timeout'] = self._serialize.query("timeout", timeout, 'int')
# Construct headers
header_parameters = {}
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_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, header_parameters)
response = self._client.send(request, stream=False, **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',
'ocp-creation-time': 'rfc-1123',
'ocp-batch-file-isdirectory': 'bool',
'ocp-batch-file-url': 'str',
'ocp-batch-file-mode': 'str',
'Content-Type': 'str',
'Content-Length': 'long',
})
return client_raw_response
get_properties_from_compute_node.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/files/{filePath}'}
[docs] def list_from_task(
self, job_id, task_id, recursive=None, file_list_from_task_options=None, custom_headers=None, raw=False, **operation_config):
"""Lists the files in a Task's directory on its Compute Node.
:param job_id: The ID of the Job that contains the Task.
:type job_id: str
:param task_id: The ID of the Task whose files you want to list.
:type task_id: str
:param recursive: Whether to list children of the Task directory. This
parameter can be used in combination with the filter parameter to list
specific type of files.
:type recursive: bool
:param file_list_from_task_options: Additional parameters for the
operation
:type file_list_from_task_options:
~azure.batch.models.FileListFromTaskOptions
: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 NodeFile
:rtype:
~azure.batch.models.NodeFilePaged[~azure.batch.models.NodeFile]
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
filter = None
if file_list_from_task_options is not None:
filter = file_list_from_task_options.filter
max_results = None
if file_list_from_task_options is not None:
max_results = file_list_from_task_options.max_results
timeout = None
if file_list_from_task_options is not None:
timeout = file_list_from_task_options.timeout
client_request_id = None
if file_list_from_task_options is not None:
client_request_id = file_list_from_task_options.client_request_id
return_client_request_id = None
if file_list_from_task_options is not None:
return_client_request_id = file_list_from_task_options.return_client_request_id
ocp_date = None
if file_list_from_task_options is not None:
ocp_date = file_list_from_task_options.ocp_date
def prepare_request(next_link=None):
if not next_link:
# Construct URL
url = self.list_from_task.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'jobId': self._serialize.url("job_id", job_id, 'str'),
'taskId': self._serialize.url("task_id", task_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if recursive is not None:
query_parameters['recursive'] = self._serialize.query("recursive", recursive, 'bool')
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if filter is not None:
query_parameters['$filter'] = self._serialize.query("filter", filter, 'str')
if max_results is not None:
query_parameters['maxresults'] = self._serialize.query("max_results", max_results, 'int', maximum=1000, minimum=1)
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['Accept'] = 'application/json'
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, header_parameters)
return request
def internal_paging(next_link=None):
request = prepare_request(next_link)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
return response
# Deserialize response
header_dict = None
if raw:
header_dict = {}
deserialized = models.NodeFilePaged(internal_paging, self._deserialize.dependencies, header_dict)
return deserialized
list_from_task.metadata = {'url': '/jobs/{jobId}/tasks/{taskId}/files'}
[docs] def list_from_compute_node(
self, pool_id, node_id, recursive=None, file_list_from_compute_node_options=None, custom_headers=None, raw=False, **operation_config):
"""Lists all of the files in Task directories on the specified Compute
Node.
:param pool_id: The ID of the Pool that contains the Compute Node.
:type pool_id: str
:param node_id: The ID of the Compute Node whose files you want to
list.
:type node_id: str
:param recursive: Whether to list children of a directory.
:type recursive: bool
:param file_list_from_compute_node_options: Additional parameters for
the operation
:type file_list_from_compute_node_options:
~azure.batch.models.FileListFromComputeNodeOptions
: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 NodeFile
:rtype:
~azure.batch.models.NodeFilePaged[~azure.batch.models.NodeFile]
:raises:
:class:`BatchErrorException<azure.batch.models.BatchErrorException>`
"""
filter = None
if file_list_from_compute_node_options is not None:
filter = file_list_from_compute_node_options.filter
max_results = None
if file_list_from_compute_node_options is not None:
max_results = file_list_from_compute_node_options.max_results
timeout = None
if file_list_from_compute_node_options is not None:
timeout = file_list_from_compute_node_options.timeout
client_request_id = None
if file_list_from_compute_node_options is not None:
client_request_id = file_list_from_compute_node_options.client_request_id
return_client_request_id = None
if file_list_from_compute_node_options is not None:
return_client_request_id = file_list_from_compute_node_options.return_client_request_id
ocp_date = None
if file_list_from_compute_node_options is not None:
ocp_date = file_list_from_compute_node_options.ocp_date
def prepare_request(next_link=None):
if not next_link:
# Construct URL
url = self.list_from_compute_node.metadata['url']
path_format_arguments = {
'batchUrl': self._serialize.url("self.config.batch_url", self.config.batch_url, 'str', skip_quote=True),
'poolId': self._serialize.url("pool_id", pool_id, 'str'),
'nodeId': self._serialize.url("node_id", node_id, 'str')
}
url = self._client.format_url(url, **path_format_arguments)
# Construct parameters
query_parameters = {}
if recursive is not None:
query_parameters['recursive'] = self._serialize.query("recursive", recursive, 'bool')
query_parameters['api-version'] = self._serialize.query("self.api_version", self.api_version, 'str')
if filter is not None:
query_parameters['$filter'] = self._serialize.query("filter", filter, 'str')
if max_results is not None:
query_parameters['maxresults'] = self._serialize.query("max_results", max_results, 'int', maximum=1000, minimum=1)
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['Accept'] = 'application/json'
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, header_parameters)
return request
def internal_paging(next_link=None):
request = prepare_request(next_link)
response = self._client.send(request, stream=False, **operation_config)
if response.status_code not in [200]:
raise models.BatchErrorException(self._deserialize, response)
return response
# Deserialize response
header_dict = None
if raw:
header_dict = {}
deserialized = models.NodeFilePaged(internal_paging, self._deserialize.dependencies, header_dict)
return deserialized
list_from_compute_node.metadata = {'url': '/pools/{poolId}/nodes/{nodeId}/files'}