aztk/spark/client/cluster/operations.py
def download(
            self,
            id: str,
            source_path: str,
            destination_path: str = None,
            host: bool = False,
            internal: bool = False,
            timeout: int = None,
    ):
        """Download a file from every node in a cluster.

        Args:
            id (:obj:`str`): the id of the cluster to copy files with.
            source_path (:obj:`str`): the path of the file to copy from.
            destination_path (:obj:`str`, optional): the local directory path where the output should be written.
                If None, a SpooledTemporaryFile will be returned in the NodeOutput object, else the file will be
                written to this path. Defaults to None.
            container_name (:obj:`str`, optional): the name of the container to copy to or from.
                If None, the copy operation will occur on the host VM, Defaults to None.
            internal (:obj:`bool`, optional): if True, this will connect to the node using its internal IP.
                Only use this if running within the same VNET as the cluster. Defaults to False.
            timeout (:obj:`int`, optional): The timeout in seconds for establishing a connection to the node.
                Defaults to None.

        Returns:
            :obj:`List[aztk.spark.models.NodeOutput]`:
                A list of NodeOutput objects representing the output of the copy command.
        """
        return download.cluster_download(self._core_cluster_operations, id, source_path, destination_path, host,
                                         internal, timeout)
Download a file from every node in a cluster.

        Args:
            id (:obj:`str`): the id of the cluster to copy files with.
            source_path (:obj:`str`): the path of the file to copy from.
            destination_path (:obj:`str`, optional): the local directory path where the output should be written.
                If None, a SpooledTemporaryFile will be returned in the NodeOutput object, else the file will be
                written to this path. Defaults to None.
            container_name (:obj:`str`, optional): the name of the container to copy to or from.
                If None, the copy operation will occur on the host VM, Defaults to None.
            internal (:obj:`bool`, optional): if True, this will connect to the node using its internal IP.
                Only use this if running within the same VNET as the cluster. Defaults to False.
            timeout (:obj:`int`, optional): The timeout in seconds for establishing a connection to the node.
                Defaults to None.

        Returns:
            :obj:`List[aztk.spark.models.NodeOutput]`:
                A list of NodeOutput objects representing the output of the copy command.
        
Download a file from every node in a cluster.
Download a file from every node in a cluster .
def download(
            self,
            id: str,
            source_path: str,
            destination_path: str = None,
            host: bool = False,
            internal: bool = False,
            timeout: int = None,
    ):
        return download.cluster_download(self._core_cluster_operations, id, source_path, destination_path, host,
                                         internal, timeout)
def download ( self , id : str , source_path : str , destination_path : str = None , host : bool = False , internal : bool = False , timeout : int = None , ) : return download . cluster_download ( self . _core_cluster_operations , id , source_path , destination_path , host , internal , timeout )
Download a file from every node in a cluster.
Download a file from every node in a cluster .
"""Download a file from every node in a cluster.

        Args:
            id (:obj:`str`): the id of the cluster to copy files with.
            source_path (:obj:`str`): the path of the file to copy from.
            destination_path (:obj:`str`, optional): the local directory path where the output should be written.
                If None, a SpooledTemporaryFile will be returned in the NodeOutput object, else the file will be
                written to this path. Defaults to None.
            container_name (:obj:`str`, optional): the name of the container to copy to or from.
                If None, the copy operation will occur on the host VM, Defaults to None.
            internal (:obj:`bool`, optional): if True, this will connect to the node using its internal IP.
                Only use this if running within the same VNET as the cluster. Defaults to False.
            timeout (:obj:`int`, optional): The timeout in seconds for establishing a connection to the node.
                Defaults to None.

        Returns:
            :obj:`List[aztk.spark.models.NodeOutput]`:
                A list of NodeOutput objects representing the output of the copy command.
        """
:obj:`List[aztk.spark.models.NodeOutput]`:
A list of NodeOutput objects representing the output of the copy command.
: obj : ` List [ aztk . spark . models . NodeOutput ] ` : A list of NodeOutput objects representing the output of the copy command .
self
id
str
source_path
str
destination_path
str
host
bool
internal
bool
timeout
int
id (
`str`): the id of the cluster to copy files with.
` str ` ) : the id of the cluster to copy files with .
source_path (
`str`): the path of the file to copy from.
` str ` ) : the path of the file to copy from .
destination_path (
`str`, optional): the local directory path where the output should be written.
If None, a SpooledTemporaryFile will be returned in the NodeOutput object, else the file will be
written to this path. Defaults to None.
` str ` optional ) : the local directory path where the output should be written . If None a SpooledTemporaryFile will be returned in the NodeOutput object else the file will be written to this path . Defaults to None .
container_name (
`str`, optional): the name of the container to copy to or from.
If None, the copy operation will occur on the host VM, Defaults to None.
` str ` optional ) : the name of the container to copy to or from . If None the copy operation will occur on the host VM Defaults to None .
internal (
`bool`, optional): if True, this will connect to the node using its internal IP.
Only use this if running within the same VNET as the cluster. Defaults to False.
` bool ` optional ) : if True this will connect to the node using its internal IP . Only use this if running within the same VNET as the cluster . Defaults to False .
timeout (
`int`, optional): The timeout in seconds for establishing a connection to the node.
Defaults to None.
` int ` optional ) : The timeout in seconds for establishing a connection to the node . Defaults to None .