path: root/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py

# coding: utf-8

"""
    fatcat

    Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata.   # noqa: E501

    The version of the OpenAPI document: 0.5.0
    Contact: webservices@archive.org
    Generated by: https://openapi-generator.tech
"""


import pprint
import re  # noqa: F401

import six


class WebcaptureEntity(object):
    """NOTE: This class is auto generated by OpenAPI Generator.
    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'state': 'str',
        'ident': 'str',
        'revision': 'str',
        'redirect': 'str',
        'extra': 'dict(str, object)',
        'edit_extra': 'dict(str, object)',
        'cdx': 'list[WebcaptureCdxLine]',
        'archive_urls': 'list[WebcaptureUrl]',
        'original_url': 'str',
        'timestamp': 'datetime',
        'content_scope': 'str',
        'release_ids': 'list[str]',
        'releases': 'list[ReleaseEntity]'
    }

    attribute_map = {
        'state': 'state',
        'ident': 'ident',
        'revision': 'revision',
        'redirect': 'redirect',
        'extra': 'extra',
        'edit_extra': 'edit_extra',
        'cdx': 'cdx',
        'archive_urls': 'archive_urls',
        'original_url': 'original_url',
        'timestamp': 'timestamp',
        'content_scope': 'content_scope',
        'release_ids': 'release_ids',
        'releases': 'releases'
    }

    def __init__(self, state=None, ident=None, revision=None, redirect=None, extra=None, edit_extra=None, cdx=None, archive_urls=None, original_url=None, timestamp=None, content_scope=None, release_ids=None, releases=None):  # noqa: E501
        """WebcaptureEntity - a model defined in OpenAPI"""  # noqa: E501

        self._state = None
        self._ident = None
        self._revision = None
        self._redirect = None
        self._extra = None
        self._edit_extra = None
        self._cdx = None
        self._archive_urls = None
        self._original_url = None
        self._timestamp = None
        self._content_scope = None
        self._release_ids = None
        self._releases = None
        self.discriminator = None

        if state is not None:
            self.state = state
        if ident is not None:
            self.ident = ident
        if revision is not None:
            self.revision = revision
        if redirect is not None:
            self.redirect = redirect
        if extra is not None:
            self.extra = extra
        if edit_extra is not None:
            self.edit_extra = edit_extra
        if cdx is not None:
            self.cdx = cdx
        if archive_urls is not None:
            self.archive_urls = archive_urls
        if original_url is not None:
            self.original_url = original_url
        if timestamp is not None:
            self.timestamp = timestamp
        if content_scope is not None:
            self.content_scope = content_scope
        if release_ids is not None:
            self.release_ids = release_ids
        if releases is not None:
            self.releases = releases

    @property
    def state(self):
        """Gets the state of this WebcaptureEntity.  # noqa: E501


        :return: The state of this WebcaptureEntity.  # noqa: E501
        :rtype: str
        """
        return self._state

    @state.setter
    def state(self, state):
        """Sets the state of this WebcaptureEntity.


        :param state: The state of this WebcaptureEntity.  # noqa: E501
        :type: str
        """
        allowed_values = ["wip", "active", "redirect", "deleted"]  # noqa: E501
        if state not in allowed_values:
            raise ValueError(
                "Invalid value for `state` ({0}), must be one of {1}"  # noqa: E501
                .format(state, allowed_values)
            )

        self._state = state

    @property
    def ident(self):
        """Gets the ident of this WebcaptureEntity.  # noqa: E501

        base32-encoded unique identifier  # noqa: E501

        :return: The ident of this WebcaptureEntity.  # noqa: E501
        :rtype: str
        """
        return self._ident

    @ident.setter
    def ident(self, ident):
        """Sets the ident of this WebcaptureEntity.

        base32-encoded unique identifier  # noqa: E501

        :param ident: The ident of this WebcaptureEntity.  # noqa: E501
        :type: str
        """
        if ident is not None and len(ident) > 26:
            raise ValueError("Invalid value for `ident`, length must be less than or equal to `26`")  # noqa: E501
        if ident is not None and len(ident) < 26:
            raise ValueError("Invalid value for `ident`, length must be greater than or equal to `26`")  # noqa: E501
        if ident is not None and not re.search(r'[a-zA-Z2-7]{26}', ident):  # noqa: E501
            raise ValueError(r"Invalid value for `ident`, must be a follow pattern or equal to `/[a-zA-Z2-7]{26}/`")  # noqa: E501

        self._ident = ident

    @property
    def revision(self):
        """Gets the revision of this WebcaptureEntity.  # noqa: E501

        UUID (lower-case, dash-separated, hex-encoded 128-bit)  # noqa: E501

        :return: The revision of this WebcaptureEntity.  # noqa: E501
        :rtype: str
        """
        return self._revision

    @revision.setter
    def revision(self, revision):
        """Sets the revision of this WebcaptureEntity.

        UUID (lower-case, dash-separated, hex-encoded 128-bit)  # noqa: E501

        :param revision: The revision of this WebcaptureEntity.  # noqa: E501
        :type: str
        """
        if revision is not None and len(revision) > 36:
            raise ValueError("Invalid value for `revision`, length must be less than or equal to `36`")  # noqa: E501
        if revision is not None and len(revision) < 36:
            raise ValueError("Invalid value for `revision`, length must be greater than or equal to `36`")  # noqa: E501
        if revision is not None and not re.search(r'[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}', revision):  # noqa: E501
            raise ValueError(r"Invalid value for `revision`, must be a follow pattern or equal to `/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/`")  # noqa: E501

        self._revision = revision

    @property
    def redirect(self):
        """Gets the redirect of this WebcaptureEntity.  # noqa: E501

        base32-encoded unique identifier  # noqa: E501

        :return: The redirect of this WebcaptureEntity.  # noqa: E501
        :rtype: str
        """
        return self._redirect

    @redirect.setter
    def redirect(self, redirect):
        """Sets the redirect of this WebcaptureEntity.

        base32-encoded unique identifier  # noqa: E501

        :param redirect: The redirect of this WebcaptureEntity.  # noqa: E501
        :type: str
        """
        if redirect is not None and len(redirect) > 26:
            raise ValueError("Invalid value for `redirect`, length must be less than or equal to `26`")  # noqa: E501
        if redirect is not None and len(redirect) < 26:
            raise ValueError("Invalid value for `redirect`, length must be greater than or equal to `26`")  # noqa: E501
        if redirect is not None and not re.search(r'[a-zA-Z2-7]{26}', redirect):  # noqa: E501
            raise ValueError(r"Invalid value for `redirect`, must be a follow pattern or equal to `/[a-zA-Z2-7]{26}/`")  # noqa: E501

        self._redirect = redirect

    @property
    def extra(self):
        """Gets the extra of this WebcaptureEntity.  # noqa: E501

        Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions.   # noqa: E501

        :return: The extra of this WebcaptureEntity.  # noqa: E501
        :rtype: dict(str, object)
        """
        return self._extra

    @extra.setter
    def extra(self, extra):
        """Sets the extra of this WebcaptureEntity.

        Free-form JSON metadata that will be stored with the other entity metadata. See guide for (unenforced) schema conventions.   # noqa: E501

        :param extra: The extra of this WebcaptureEntity.  # noqa: E501
        :type: dict(str, object)
        """

        self._extra = extra

    @property
    def edit_extra(self):
        """Gets the edit_extra of this WebcaptureEntity.  # noqa: E501

        Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete).   # noqa: E501

        :return: The edit_extra of this WebcaptureEntity.  # noqa: E501
        :rtype: dict(str, object)
        """
        return self._edit_extra

    @edit_extra.setter
    def edit_extra(self, edit_extra):
        """Sets the edit_extra of this WebcaptureEntity.

        Free-form JSON metadata that will be stored with specific entity edits (eg, creation/update/delete).   # noqa: E501

        :param edit_extra: The edit_extra of this WebcaptureEntity.  # noqa: E501
        :type: dict(str, object)
        """

        self._edit_extra = edit_extra

    @property
    def cdx(self):
        """Gets the cdx of this WebcaptureEntity.  # noqa: E501


        :return: The cdx of this WebcaptureEntity.  # noqa: E501
        :rtype: list[WebcaptureCdxLine]
        """
        return self._cdx

    @cdx.setter
    def cdx(self, cdx):
        """Sets the cdx of this WebcaptureEntity.


        :param cdx: The cdx of this WebcaptureEntity.  # noqa: E501
        :type: list[WebcaptureCdxLine]
        """

        self._cdx = cdx

    @property
    def archive_urls(self):
        """Gets the archive_urls of this WebcaptureEntity.  # noqa: E501


        :return: The archive_urls of this WebcaptureEntity.  # noqa: E501
        :rtype: list[WebcaptureUrl]
        """
        return self._archive_urls

    @archive_urls.setter
    def archive_urls(self, archive_urls):
        """Sets the archive_urls of this WebcaptureEntity.


        :param archive_urls: The archive_urls of this WebcaptureEntity.  # noqa: E501
        :type: list[WebcaptureUrl]
        """

        self._archive_urls = archive_urls

    @property
    def original_url(self):
        """Gets the original_url of this WebcaptureEntity.  # noqa: E501

        Base URL of the primary resource this is a capture of  # noqa: E501

        :return: The original_url of this WebcaptureEntity.  # noqa: E501
        :rtype: str
        """
        return self._original_url

    @original_url.setter
    def original_url(self, original_url):
        """Sets the original_url of this WebcaptureEntity.

        Base URL of the primary resource this is a capture of  # noqa: E501

        :param original_url: The original_url of this WebcaptureEntity.  # noqa: E501
        :type: str
        """

        self._original_url = original_url

    @property
    def timestamp(self):
        """Gets the timestamp of this WebcaptureEntity.  # noqa: E501

        Same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Should generally be the timestamp of capture of the primary resource URL.   # noqa: E501

        :return: The timestamp of this WebcaptureEntity.  # noqa: E501
        :rtype: datetime
        """
        return self._timestamp

    @timestamp.setter
    def timestamp(self, timestamp):
        """Sets the timestamp of this WebcaptureEntity.

        Same format as CDX line timestamp (UTC, etc). Corresponds to the overall capture timestamp. Should generally be the timestamp of capture of the primary resource URL.   # noqa: E501

        :param timestamp: The timestamp of this WebcaptureEntity.  # noqa: E501
        :type: datetime
        """

        self._timestamp = timestamp

    @property
    def content_scope(self):
        """Gets the content_scope of this WebcaptureEntity.  # noqa: E501


        :return: The content_scope of this WebcaptureEntity.  # noqa: E501
        :rtype: str
        """
        return self._content_scope

    @content_scope.setter
    def content_scope(self, content_scope):
        """Sets the content_scope of this WebcaptureEntity.


        :param content_scope: The content_scope of this WebcaptureEntity.  # noqa: E501
        :type: str
        """

        self._content_scope = content_scope

    @property
    def release_ids(self):
        """Gets the release_ids of this WebcaptureEntity.  # noqa: E501

        Set of identifier of release entities this fileset represents a full manifestation of. Usually a single release.   # noqa: E501

        :return: The release_ids of this WebcaptureEntity.  # noqa: E501
        :rtype: list[str]
        """
        return self._release_ids

    @release_ids.setter
    def release_ids(self, release_ids):
        """Sets the release_ids of this WebcaptureEntity.

        Set of identifier of release entities this fileset represents a full manifestation of. Usually a single release.   # noqa: E501

        :param release_ids: The release_ids of this WebcaptureEntity.  # noqa: E501
        :type: list[str]
        """

        self._release_ids = release_ids

    @property
    def releases(self):
        """Gets the releases of this WebcaptureEntity.  # noqa: E501

        Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests.   # noqa: E501

        :return: The releases of this WebcaptureEntity.  # noqa: E501
        :rtype: list[ReleaseEntity]
        """
        return self._releases

    @releases.setter
    def releases(self, releases):
        """Sets the releases of this WebcaptureEntity.

        Full release entities, included in GET responses when `releases` included in `expand` parameter. Ignored if included in PUT or POST requests.   # noqa: E501

        :param releases: The releases of this WebcaptureEntity.  # noqa: E501
        :type: list[ReleaseEntity]
        """

        self._releases = releases

    def to_dict(self):
        """Returns the model properties as a dict"""
        result = {}

        for attr, _ in six.iteritems(self.openapi_types):
            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
                    value
                ))
            elif hasattr(value, "to_dict"):
                result[attr] = value.to_dict()
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1].to_dict())
                    if hasattr(item[1], "to_dict") else item,
                    value.items()
                ))
            else:
                result[attr] = value

        return result

    def to_str(self):
        """Returns the string representation of the model"""
        return pprint.pformat(self.to_dict())

    def __repr__(self):
        """For `print` and `pprint`"""
        return self.to_str()

    def __eq__(self, other):
        """Returns true if both objects are equal"""
        if not isinstance(other, WebcaptureEntity):
            return False

        return self.__dict__ == other.__dict__

    def __ne__(self, other):
        """Returns true if both objects are not equal"""
        return not self == other