get-step-artifact-content
¶
Description¶
Download the artifact for a step in the pipeline.
Required Parameters¶
-
--file
[filename]
¶
The name of the file that will receive the response data, or ‘-‘ to write to STDOUT.
-
--pipeline-id
[text]
¶
The OCID of the pipeline.
-
--step-name
[text]
¶
Unique Step identifier in a pipeline.
Optional Parameters¶
-
--from-json
[text]
¶
Provide input to this command as a JSON document from a file using the file://path-to/file syntax.
The --generate-full-command-json-input
option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.
Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.
For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions
-
--range
[text]
¶
Optional byte range to fetch, as described in RFC 7233, section 2.1. Note that only a single range of bytes is supported.
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-auto-prompt
, --cli-rc-file
, --config-file
, --connection-timeout
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --max-retries
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --proxy
, --query
, --raw-output
, --read-timeout
, --realm-specific-endpoint
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -i
, -v
Example using required parameter¶
Copy and paste the following example into a JSON file, replacing the example parameters with your own.
oci data-science pipeline create --generate-param-json-input step-details > step-details.json
Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.
Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.
export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/project/create.html#cmdoption-compartment-id
export step_name=<substitute-value-of-step_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-science/pipeline/get-step-artifact-content.html#cmdoption-step-name
project_id=$(oci data-science project create --compartment-id $compartment_id --query data.id --raw-output)
pipeline_id=$(oci data-science pipeline create --compartment-id $compartment_id --project-id $project_id --step-details file://step-details.json --query data.id --raw-output)
oci data-science pipeline get-step-artifact-content --file $file --pipeline-id $pipeline_id --step-name $step_name