# unpack_archive_to_bucket
Unpack archive(s) to a target location within a Google Storage bucket

## Inputs

### Required inputs
<p name="unpack_archive_to_bucket.input_archive_files">
        <b>unpack_archive_to_bucket.input_archive_files</b><br />
        <i>Array[File] &mdash; Default: None</i><br />
        List of input archive files to unpack.
</p>

### Other inputs
<details>
<summary> Show/Hide </summary>
<p name="unpack_archive_to_bucket.bucket_path_prefix">
        <b>unpack_archive_to_bucket.bucket_path_prefix</b><br />
        <i>String? &mdash; Default: None</i><br />
        Path within the Google Storage bucket to unpack the archive files. If not provided, the root of the bucket will be used.
</p>
<p name="unpack_archive_to_bucket.check_terra_env.docker">
        <b>unpack_archive_to_bucket.check_terra_env.docker</b><br />
        <i>String &mdash; Default: "ghcr.io/broadinstitute/viral-ngs:3.0.4-core"</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.gcloud_access_token">
        <b>unpack_archive_to_bucket.gcloud_access_token</b><br />
        <i>String? &mdash; Default: None</i><br />
        Access token for the Google Cloud Storage bucket, for account authorized to write to the bucket specified by 'bucket_path_prefix'. If not provided, the gcloud auth configuration of the execution environment will be obtained via 'gcloud auth print-access-token' for the active authenticated user (on Terra, the service worker/'pet' account).
</p>
<p name="unpack_archive_to_bucket.out_dir_name">
        <b>unpack_archive_to_bucket.out_dir_name</b><br />
        <i>String? &mdash; Default: None</i><br />
        Name of the (sub-)directory to unpack the archive contents to within the bucket prefix specified. If not provided, the contents will be unpacked to the bucket prefix.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.archive_wrapper_directories_to_strip">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.archive_wrapper_directories_to_strip</b><br />
        <i>Int? &mdash; Default: None</i><br />
        (tar) If specified, tar extraction excludes this many top-level directories. (i.e. if all files of a tarball are containined within a top-level subdirectory, and archive_wrapper_directories_to_strip=1, the files files will be extracted without being placed into a corresponding output sub-directory. Equivalent to the parameter '--strip-components' of GNU tar.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.bypass_disk_and_unpack_directly_to_bucket">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.bypass_disk_and_unpack_directly_to_bucket</b><br />
        <i>Boolean &mdash; Default: false</i><br />
        (tar) If true, unpack the archive(s) and pipe the contents directly to the gcloud storage upload process, without writing to the disk between extraction and upload. If enabled, minimal disk space will be used beyond storage needed to localize the specified input archive(s), but the task may take significantly longer as each file is uploaded using an independent gcloud storage invocation.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.clobber_existing">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.clobber_existing</b><br />
        <i>Boolean &mdash; Default: false</i><br />
        (gcloud storage cp) If true, overwrite files in the target directory of the bucket if they already exist.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.disk_size">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.disk_size</b><br />
        <i>Int &mdash; Default: ceil((3.0 * size(input_archive_files[0],"GB"))) + 50</i><br />
        Size of the disk to allocate for the task, in GB. Note that if multiple files are provided to 'input_archive_files', and extracted data is written to the disk (bypass_disk_and_unpack_directly_to_bucket=false), the extracted data from one archive will be removed before extracting and uploading data from the next input archive.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.docker">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.docker</b><br />
        <i>String &mdash; Default: "ghcr.io/broadinstitute/viral-ngs:3.0.4-core"</i><br />
        Docker image to use for the task. For this task, the image must provide GNU tar and the google-cloud-cli ('gcloud' command)
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.gcloud_storage_cp_opts">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.gcloud_storage_cp_opts</b><br />
        <i>String &mdash; Default: ""</i><br />
        (gcloud storage cp) Additional options to pass to the 'gcloud storage cp' command at the time of upload.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.machine_mem_gb">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.machine_mem_gb</b><br />
        <i>Int &mdash; Default: 8</i><br />
        Memory to allocate for the task, in GB.
</p>
<p name="unpack_archive_to_bucket.unpack_archive_to_bucket_path.tar_opts">
        <b>unpack_archive_to_bucket.unpack_archive_to_bucket_path.tar_opts</b><br />
        <i>String &mdash; Default: "-v --ignore-zeros --no-ignore-command-error"</i><br />
        (tar) Options to pass to GNU tar during extraction. By default includes: '-v --ignore-zeros --no-ignore-command-error'
</p>
</details>

## Outputs
<p name="unpack_archive_to_bucket.check_terra_env.env_info">
        <b>unpack_archive_to_bucket.check_terra_env.env_info</b><br />
        <i>File</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.gcloud_config_info">
        <b>unpack_archive_to_bucket.check_terra_env.gcloud_config_info</b><br />
        <i>File</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.gcp_instance_metadata">
        <b>unpack_archive_to_bucket.check_terra_env.gcp_instance_metadata</b><br />
        <i>File</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.google_project_id">
        <b>unpack_archive_to_bucket.check_terra_env.google_project_id</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.input_row_id">
        <b>unpack_archive_to_bucket.check_terra_env.input_row_id</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.input_table_name">
        <b>unpack_archive_to_bucket.check_terra_env.input_table_name</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.is_backed_by_gcp">
        <b>unpack_archive_to_bucket.check_terra_env.is_backed_by_gcp</b><br />
        <i>Boolean</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.is_running_on_terra">
        <b>unpack_archive_to_bucket.check_terra_env.is_running_on_terra</b><br />
        <i>Boolean</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.is_running_via_gcp_batch">
        <b>unpack_archive_to_bucket.check_terra_env.is_running_via_gcp_batch</b><br />
        <i>Boolean</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.is_running_via_gcp_papiv2">
        <b>unpack_archive_to_bucket.check_terra_env.is_running_via_gcp_papiv2</b><br />
        <i>Boolean</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.max_ram_gb">
        <b>unpack_archive_to_bucket.check_terra_env.max_ram_gb</b><br />
        <i>Int</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.method_path">
        <b>unpack_archive_to_bucket.check_terra_env.method_path</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.method_source">
        <b>unpack_archive_to_bucket.check_terra_env.method_source</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.method_version">
        <b>unpack_archive_to_bucket.check_terra_env.method_version</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.top_level_submission_id">
        <b>unpack_archive_to_bucket.check_terra_env.top_level_submission_id</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.user_email">
        <b>unpack_archive_to_bucket.check_terra_env.user_email</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.workspace_bucket_path">
        <b>unpack_archive_to_bucket.check_terra_env.workspace_bucket_path</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.workspace_name">
        <b>unpack_archive_to_bucket.check_terra_env.workspace_name</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.workspace_namespace">
        <b>unpack_archive_to_bucket.check_terra_env.workspace_namespace</b><br />
        <i>String</i><br />
        ???
</p>
<p name="unpack_archive_to_bucket.check_terra_env.workspace_uuid">
        <b>unpack_archive_to_bucket.check_terra_env.workspace_uuid</b><br />
        <i>String</i><br />
        ???
</p>

<hr />

> Generated using WDL AID (1.0.0)