describe-collection¶

Description¶

Describe a collection in the catalog

Synopsis¶

  describe-collection
--catalog-collection-crn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--catalog-collection-crn (string)

The catalog collection CRN.

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

catalogCollection -> (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