Skip to content

Module invenio_rest_api_client.models.access

Variables

T

TYPE_CHECKING

Classes

Access

class Access(
    record: invenio_rest_api_client.models.access_record.AccessRecord,
    files: invenio_rest_api_client.models.access_files.AccessFiles,
    embargo: invenio_rest_api_client.types.Unset | ForwardRef('Embargo') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Denotes record-specific read (visibility) options.

More informations can be found on InvenioRDM Official page: https://inveniordm.docs.cern.ch/reference/metadata/#access

Attributes:
    record (AccessRecord): Read access to the record.

        `public` means anyone can see the record/files, `restricted` means only the owner(s) or specific users can see
        the record/files.
    files (AccessFiles): Read access to the record's files.

        `public` means anyone can see the record/files, `restricted` means only the owner(s) or specific users can see
        the record/files.
    embargo (Union[Unset, Embargo]): Only in the cases of `"record": "restricted"`` or `"files": "restricted"`` can
        an embargo be provided as input.
        However, once an embargo is lifted, the embargo section is kept for transparency.

        Denotes when an embargo must be lifted, at which point the record is made publicly accessible.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

embargo

files

record

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]