"list"
******

* Description

* Usage

* Optional Parameters

* Global Parameters

* Example using required parameter


Description
===========

Lists the streams in the given compartment id. If the compartment id
is specified, it will list streams in the compartment, regardless of
their stream pool. If the stream pool id is specified, the action will
be scoped to that stream pool. The compartment id and stream pool id
cannot be specified at the same time.


Usage
=====

   oci streaming admin stream list [OPTIONS]


Optional Parameters
===================

--all

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

--compartment-id, -c [text]

The OCID of the compartment. Is exclusive with the *streamPoolId*
parameter. One of them is required.

--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/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--id [text]

A filter to return only resources that match the given ID exactly.

--lifecycle-state [text]

A filter to only return resources that match the given lifecycle
state. The state value is case-insensitive.

Accepted values are:

   ACTIVE, CREATING, DELETED, DELETING, FAILED, UPDATING

--limit [integer]

The maximum number of items to return. The value must be between 1 and
50. The default is 10.

--name [text]

A filter to return only resources that match the given name exactly.

--page [text]

The page at which to start retrieving results.

--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.

--sort-by [text]

The field to sort by. You can provide no more than one sort order. By
default, *TIMECREATED* sorts results in descending order and *NAME*
sorts results in ascending order.

Accepted values are:

   NAME, TIMECREATED

--sort-order [text]

The sort order to use, either ‘asc’ or ‘desc’.

Accepted values are:

   ASC, DESC

--stream-pool-id [text]

The OCID of the stream pool. Is exclusive with the *compartmentId*
parameter. One of them is required.


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 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.

       oci streaming admin stream list
