list-collections¶

Description¶

Lists the collections in the catalog

list-collections is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument.

Synopsis¶

  list-collections
[--sorts <value>]
[--search-term <value>]
[--max-items <value>]
[--starting-token <value>]
[--page-size <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--sorts (array)

The sort criteria

Syntax:

"string" "string" ...

--search-term (string)

Search term to filter by name

--max-items (integer)

The total number of items to return. If the total number of items available is more than the value specified in max-items then a nextToken will be provided in the output that you can use to resume pagination. This nextToken response element should not be used directly outside of the CDP CLI. This option cannnot be combined with the no-paginate CLI option. If no max-items value is specified, then a default value of 20 is used.

--starting-token (string)

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

--page-size (integer)

The size of each page. Generally this does not need to be set and the default page size used is appropriate.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

nextToken -> (string)

The page token for requesting the next page of results.

collections -> (array)

The listing of Catalog Collections.

item -> (object)

A catalog collection.

crn -> (string)

The catalog collection CRN.

name -> (string)

The name of the catalog collection.

description -> (string)

The description of the catalog collection.

flowSummaries -> (array)

The summaries of flows in the catalog collection.

item -> (object)

A summarized version of a flow, mostly useful in listing flows

crn -> (string)

The artifact CRN

name -> (string)

The artifact name.

versionCount -> (integer)

The number of versions uploaded to the catalog.

artifactType -> (string)

The type of artifact

modifiedTimestamp -> (integer)

The modified timestamp.

collectionName -> (string)

The collection name.

collectionCrn -> (string)

The collection CRN.

flowCount -> (integer)

The number of flow summaries in the catalog collection.

Form Factors¶

public