get-by-path

Description

Gets information about an artifact with a specified artifactPath and version.

Usage

oci artifacts generic artifact get-by-path [OPTIONS]

Required Parameters

--artifact-path [text]

A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.

Example:

project01/my-web-app/artifact-abc
--artifact-version [text]

The generic artifact version.

Example:

1.1.2
--repository-id [text]

The OCID of the repository.

Example:

ocid1.artifactrepository.oc1..exampleuniqueID

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

Example using required parameter

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/artifacts/repository/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/container/repository/create.html#cmdoption-display-name
    export is_immutable=<substitute-value-of-is_immutable> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/repository/create.html#cmdoption-is-immutable
    export repository_type=<substitute-value-of-repository_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/repository/create.html#cmdoption-repository-type
    export artifact_path=<substitute-value-of-artifact_path> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/generic/artifact/get-by-path.html#cmdoption-artifact-path
    export artifact_version=<substitute-value-of-artifact_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/artifacts/generic/artifact/get-by-path.html#cmdoption-artifact-version

    repository_id=$(oci artifacts container repository create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)
    repository_id=$(oci artifacts repository create --compartment-id $compartment_id --is-immutable $is_immutable --repository-type $repository_type --query data.id --raw-output)

    oci artifacts generic artifact get-by-path --artifact-path $artifact_path --artifact-version $artifact_version --repository-id $repository_id