Dataset.update

Dataset.update(*, name=None, public_access_level=None, description=None, labels=None) → self

Update properties on a dataset. All properties are optional, and only specified properties will be updated.

Parameters:

name : str, default None The dataset's new name. If set to None (the default), the name will not be updated.

public_access_level : str {"none" | "overview" | "metadata" | "sample" | "data"}, default None The dataset's new public access level (the level of access for any user on Redivis). If set to None (the default), the public access level will not be updated. Additional access rules for datasets can be defined through the web interface.

description : str, default None The dataset's new description, presented as the "Abstract" in the web interface. If set to None (the default), the description will note be updated.

labels : str[], default None A list of labels to assign to the dataset. Note that this will overwrite any existing labels; if you want to add labels, make sure to include any current labels on the dataset. Labels can only use alphanumeric characters and underscores, and may be include up to one colon to create a multipart label (e.g., school:humanities). Labels can currently only be assigned to datasets owned by an organization, and you must be an administrator of that organization to view and edit labels.

Returns:

self (a Dataset)

Examples:

Update a dataset

dataset = redivis.user("my_username").dataset("My dataset")
dataset.update(name="My newly named dataset", description="this is a test")