roboto collections

Curate collections of datasets and other data types.

roboto collections [-h] {changelog,create,delete,list,show,update} ...

Arguments

Argument	Description
`-h, --help`	show this help message and exit

roboto collections changelog

Get a changelog for the revisions of a collection.

roboto collections changelog [-h] [--from-version FROM_VERSION]
                             [--to-version TO_VERSION]
                             collection_id

Arguments

Argument	Description
`collection_id` Required	A unique ID used to reference a collection of Roboto resources.
`-h, --help`	show this help message and exit
`--from-version <from_version>`	A collection version to use as the starting point in change-set listing. Defaults to initial.
`--to-version <to_version>`	A collection version to use as the end point in change-set listing. Defaults to latest.

roboto collections create

Create a new collection.

roboto collections create [-h] [--name NAME]
                          [--description DESCRIPTION]
                          [--dataset-id DATASET_ID [DATASET_ID ...]]
                          [--event-id EVENT_ID [EVENT_ID ...]]
                          [--file-id FILE_ID [FILE_ID ...]]
                          [--session-id SESSION_ID [SESSION_ID ...]]
                          [--resource-type {file,dataset,event,session}]
                          [--tag [TAG ...]] [--org ORG]

Arguments

Argument	Description
`-h, --help`	show this help message and exit
`--name <name>`	A human-readable name for this collection. Does not need to be unique.
`--description <description>`	Information about what’s in this collection
`--dataset-id <dataset_id>`	Initial datasets to add to this collection.
`--event-id <event_id>`	Initial events to add to this collection.
`--file-id <file_id>`	Initial files to add to this collection.
`--session-id <session_id>`	Initial sessions to add to this collection.
`--resource-type {file,dataset,event,session}`	The type of resources this collection holds. Inferred from –file-id, –dataset-id, –event-id, or –session-id if not provided. Defaults to ‘file’ with a warning when neither is given.
`--tag <tag>`	Tags that make it easier to discover this collection.
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto collections delete

Delete a collection.

roboto collections delete [-h] collection_id

Arguments

Argument	Description
`collection_id` Required	A unique ID used to reference a collection of Roboto resources.
`-h, --help`	show this help message and exit

roboto collections list

List existing collections.

roboto collections list [-h] [--org ORG]

Arguments

Argument	Description
`-h, --help`	show this help message and exit
`--org <org>`	The calling organization ID. Gets set implicitly if in a single org. The `ROBOTO_ORG_ID` environment variable can be set to control the default value; without it, the default is the `org_id` of the config file profile in use, which `roboto setup` saves.

roboto collections show

Show information about a collection.

roboto collections show [-h] [-v COLLECTION_VERSION]
                        [--content-mode {summary_only,references,full}]
                        collection_id

Arguments

Argument	Description
`collection_id` Required	A unique ID used to reference a collection of Roboto resources.
`-h, --help`	show this help message and exit
`-v, --collection-version <collection_version>`	An optional version for the provided collection ID. Allows caller to ensure that they’re referencing an immutable representation of a given collection.
`--content-mode {summary_only,references,full}`	The type of content to return for a collection or set of collections. `summary_only` returns only metadata, `references` will return each id in the collection, and `full` will retrieve the full content of each resource in the collection. Default: `references`.

roboto collections update

Update the resources and metadata of a collection.

roboto collections update [-h] [--name NAME]
                          [--description DESCRIPTION]
                          [--add-dataset-id ADD_DATASET_ID [ADD_DATASET_ID ...]]
                          [--add-event-id ADD_EVENT_ID [ADD_EVENT_ID ...]]
                          [--add-file-id ADD_FILE_ID [ADD_FILE_ID ...]]
                          [--add-session-id ADD_SESSION_ID [ADD_SESSION_ID ...]]
                          [--remove-dataset-id REMOVE_DATASET_ID [REMOVE_DATASET_ID ...]]
                          [--remove-event-id REMOVE_EVENT_ID [REMOVE_EVENT_ID ...]]
                          [--remove-file-id REMOVE_FILE_ID [REMOVE_FILE_ID ...]]
                          [--remove-session-id REMOVE_SESSION_ID [REMOVE_SESSION_ID ...]]
                          [--add-tag [ADD_TAG ...]]
                          [--remove-tag [REMOVE_TAG ...]]
                          collection_id

Arguments

Argument	Description
`collection_id` Required	A unique ID used to reference a collection of Roboto resources.
`-h, --help`	show this help message and exit
`--name <name>`	A human-readable name for this collection. Does not need to be unique.
`--description <description>`	Information about what’s in this collection
`--add-dataset-id <add_dataset_id>`	Datasets to add to this collection.
`--add-event-id <add_event_id>`	Events to add to this collection.
`--add-file-id <add_file_id>`	Files to add to this collection.
`--add-session-id <add_session_id>`	Sessions to add to this collection.
`--remove-dataset-id <remove_dataset_id>`	Datasets to remove from this collection.
`--remove-event-id <remove_event_id>`	Events to remove from this collection.
`--remove-file-id <remove_file_id>`	Files to remove from this collection.
`--remove-session-id <remove_session_id>`	Sessions to remove from this collection.
`--add-tag <add_tag>`	Tags to add to this collection.
`--remove-tag <remove_tag>`	Tags to remove from this collection.