``list``
========
.. contents:: :local:
 :depth: 1
Description
------------
Returns a list of job metrics. 


Usage
-----
.. code-block:: none

  oci data-catalog job-metric list [OPTIONS]

Required Parameters
--------------------
.. option:: --catalog-id [text]

Unique catalog identifier.

.. option:: --job-execution-key [text]

The key of the job execution.

.. option:: --job-key [text]

Unique job key.


Optional Parameters
--------------------
.. option:: --all

Fetches all pages of results. If you provide this option, then you cannot provide the ``--limit`` option.

.. option:: --batch-key [text]

Batch key for grouping, may be null.

.. option:: --category [text]

Category of this metric.

.. option:: --created-by-id [text]

OCID of the user who created the resource.

.. option:: --display-name [text]

A filter to return only resources that match the entire display name given. The match is not case sensitive.

.. option:: --display-name-contains [text]

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

.. option:: --fields [text]

Specifies the fields to return in a job metric summary response.

Accepted values are:

.. code-block:: py

    batchKey, category, description, displayName, jobExecutionKey, key, subCategory, timeCreated, timeInserted, unit, uri, value

.. option:: --from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The :option:`--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

.. option:: --limit [integer]

The maximum number of items to return.

.. option:: --page [text]

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

.. option:: --page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with ``--all`` or ``--limit``, and ignored otherwise.

.. option:: --sort-by [text]

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Accepted values are:

.. code-block:: py

    DISPLAYNAME, TIMECREATED

.. option:: --sort-order [text]

The sort order to use, either 'asc' or 'desc'.

Accepted values are:

.. code-block:: py

    ASC, DESC

.. option:: --sub-category [text]

Sub category of this metric under the category. Used for aggregating values. May be null.

.. option:: --time-created [datetime]

Time that the resource was created. An `RFC3339 <https://tools.ietf.org/html/rfc3339>`__ formatted datetime string.

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
    Example: 2017-09-15T20:30:00.123456Z

    UTC with milliseconds
    ***********************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ss.sssTZD
        Example: 2017-09-15T20:30:00.123Z

    UTC without milliseconds
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T20:30:00Z

    UTC with minute precision
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T20:30Z

Timezone with microseconds
***************************
.. code::

    Format: YYYY-MM-DDTHH:mm:ssTZD
    Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800

    Timezone with milliseconds
    ***************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

    Timezone without milliseconds
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

    Timezone with minute precision
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

    Short date and time
    ********************
    The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

    .. code::

        Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    Date Only
    **********
    This date will be taken as midnight UTC of that day

    .. code::

        Format: YYYY-MM-DD
        Example: 2017-09-15

    Epoch seconds
    **************
    .. code::

        Example: 1412195400
    

.. option:: --time-inserted [datetime]

The time the metric was logged or captured in the system where the job executed. An `RFC3339 <https://tools.ietf.org/html/rfc3339>`__ formatted datetime string.

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
    Example: 2017-09-15T20:30:00.123456Z

    UTC with milliseconds
    ***********************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ss.sssTZD
        Example: 2017-09-15T20:30:00.123Z

    UTC without milliseconds
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T20:30:00Z

    UTC with minute precision
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T20:30Z

Timezone with microseconds
***************************
.. code::

    Format: YYYY-MM-DDTHH:mm:ssTZD
    Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800

    Timezone with milliseconds
    ***************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

    Timezone without milliseconds
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

    Timezone with minute precision
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

    Short date and time
    ********************
    The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

    .. code::

        Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    Date Only
    **********
    This date will be taken as midnight UTC of that day

    .. code::

        Format: YYYY-MM-DD
        Example: 2017-09-15

    Epoch seconds
    **************
    .. code::

        Example: 1412195400
    

.. option:: --time-updated [datetime]

Time that the resource was updated. An `RFC3339 <https://tools.ietf.org/html/rfc3339>`__ formatted datetime string.

    The following datetime formats are supported:

UTC with microseconds
***********************
.. code::

    Format: YYYY-MM-DDTHH:mm:ss.ssssssTZD
    Example: 2017-09-15T20:30:00.123456Z

    UTC with milliseconds
    ***********************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ss.sssTZD
        Example: 2017-09-15T20:30:00.123Z

    UTC without milliseconds
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T20:30:00Z

    UTC with minute precision
    **************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T20:30Z

Timezone with microseconds
***************************
.. code::

    Format: YYYY-MM-DDTHH:mm:ssTZD
    Example: 2017-09-15T12:30:00.456789-08:00, 2017-09-15T12:30:00.456789-0800

    Timezone with milliseconds
    ***************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800

    Timezone without milliseconds
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mm:ssTZD
        Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800

    Timezone with minute precision
    *******************************
    .. code::

        Format: YYYY-MM-DDTHH:mmTZD
        Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

    Short date and time
    ********************
    The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

    .. code::

        Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
        Example: '2017-09-15 17:25'

    Date Only
    **********
    This date will be taken as midnight UTC of that day

    .. code::

        Format: YYYY-MM-DD
        Example: 2017-09-15

    Epoch seconds
    **************
    .. code::

        Example: 1412195400
    

.. option:: --unit [text]

Unit of this metric.

.. option:: --updated-by-id [text]

OCID of the user who updated the resource.

.. option:: --value [text]

Value of this metric.



Global Parameters
------------------
Use ``oci --help`` for help on global parameters.

:option:`--auth-purpose`, :option:`--auth`, :option:`--cert-bundle`, :option:`--cli-auto-prompt`, :option:`--cli-rc-file`, :option:`--config-file`, :option:`--connection-timeout`, :option:`--debug`, :option:`--defaults-file`, :option:`--endpoint`, :option:`--generate-full-command-json-input`, :option:`--generate-param-json-input`, :option:`--help`, :option:`--latest-version`, :option:`--max-retries`, :option:`--no-retry`, :option:`--opc-client-request-id`, :option:`--opc-request-id`, :option:`--output`, :option:`--profile`, :option:`--proxy`, :option:`--query`, :option:`--raw-output`, :option:`--read-timeout`, :option:`--realm-specific-endpoint`, :option:`--region`, :option:`--release-info`, :option:`--request-id`, :option:`--version`, :option:`-?`, :option:`-d`, :option:`-h`, :option:`-i`, :option:`-v`



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  <https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/cliinstall.htm#configfile>`__ and `appropriate security policies  <https://docs.oracle.com/en-us/iaas/Content/Identity/Concepts/policygetstarted.htm>`__ before trying the examples.

.. code-block:: none
    :class: copy-code-block

    
	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-catalog/catalog/create.html#cmdoption-compartment-id
	export job_execution_key=<substitute-value-of-job_execution_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-catalog/job-metric/list.html#cmdoption-job-execution-key
	export job_key=<substitute-value-of-job_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/data-catalog/job-metric/list.html#cmdoption-job-key
	
	catalog_id=$(oci data-catalog catalog create --compartment-id $compartment_id --query data.id --raw-output)
	
	oci data-catalog job-metric list --catalog-id $catalog_id --job-execution-key $job_execution_key --job-key $job_key



