diff options
Diffstat (limited to 'python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py')
| -rw-r--r-- | python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py | 468 |
1 files changed, 233 insertions, 235 deletions
diff --git a/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py b/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py index 642d156d..82363c23 100644 --- a/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py +++ b/python_openapi_client/fatcat_openapi_client/models/webcapture_entity.py @@ -5,9 +5,9 @@ Fatcat is a scalable, versioned, API-oriented catalog of bibliographic entities and file metadata. # noqa: E501 - OpenAPI spec version: 0.3.1 + The version of the OpenAPI document: 0.3.1 Contact: webservices@archive.org - Generated by: https://github.com/swagger-api/swagger-codegen.git + Generated by: https://openapi-generator.tech """ @@ -16,228 +16,229 @@ import re # noqa: F401 import six -from fatcat_openapi_client.models.webcapture_cdx_line import WebcaptureCdxLine # noqa: F401,E501 -from fatcat_openapi_client.models.webcapture_url import WebcaptureUrl # noqa: F401,E501 - class WebcaptureEntity(object): - """NOTE: This class is auto generated by the swagger code generator program. + """NOTE: This class is auto generated by OpenAPI Generator. + Ref: https://openapi-generator.tech Do not edit the class manually. """ """ Attributes: - swagger_types (dict): The key is attribute name + 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. """ - swagger_types = { - 'releases': 'list[ReleaseEntity]', - 'release_ids': 'list[str]', - 'timestamp': 'datetime', - 'original_url': 'str', - 'archive_urls': 'list[WebcaptureUrl]', - 'cdx': 'list[WebcaptureCdxLine]', - 'edit_extra': 'object', - 'extra': 'object', - 'redirect': 'str', - 'revision': 'str', + openapi_types = { + 'state': 'str', 'ident': 'str', - 'state': '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', + 'release_ids': 'list[str]', + 'releases': 'list[ReleaseEntity]' } attribute_map = { - 'releases': 'releases', - 'release_ids': 'release_ids', - 'timestamp': 'timestamp', - 'original_url': 'original_url', - 'archive_urls': 'archive_urls', - 'cdx': 'cdx', - 'edit_extra': 'edit_extra', - 'extra': 'extra', - 'redirect': 'redirect', - 'revision': 'revision', + 'state': 'state', 'ident': 'ident', - 'state': 'state' + 'revision': 'revision', + 'redirect': 'redirect', + 'extra': 'extra', + 'edit_extra': 'edit_extra', + 'cdx': 'cdx', + 'archive_urls': 'archive_urls', + 'original_url': 'original_url', + 'timestamp': 'timestamp', + 'release_ids': 'release_ids', + 'releases': 'releases' } - def __init__(self, releases=None, release_ids=None, timestamp=None, original_url=None, archive_urls=None, cdx=None, edit_extra=None, extra=None, redirect=None, revision=None, ident=None, state=None): # noqa: E501 - """WebcaptureEntity - a model defined in Swagger""" # noqa: E501 + 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, release_ids=None, releases=None): # noqa: E501 + """WebcaptureEntity - a model defined in OpenAPI""" # noqa: E501 - self._releases = None - self._release_ids = None - self._timestamp = None - self._original_url = None - self._archive_urls = None - self._cdx = None - self._edit_extra = None - self._extra = None - self._redirect = None - self._revision = None - self._ident = None 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._release_ids = None + self._releases = None self.discriminator = None - if releases is not None: - self.releases = releases - if release_ids is not None: - self.release_ids = release_ids - if timestamp is not None: - self.timestamp = timestamp - if original_url is not None: - self.original_url = original_url - if archive_urls is not None: - self.archive_urls = archive_urls - if cdx is not None: - self.cdx = cdx - if edit_extra is not None: - self.edit_extra = edit_extra - if extra is not None: - self.extra = extra - if redirect is not None: - self.redirect = redirect - if revision is not None: - self.revision = revision - if ident is not None: - self.ident = ident 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 release_ids is not None: + self.release_ids = release_ids + if releases is not None: + self.releases = releases @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 - - @property - def release_ids(self): - """Gets the release_ids of this WebcaptureEntity. # noqa: E501 + def state(self): + """Gets the state 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: The state of this WebcaptureEntity. # noqa: E501 + :rtype: str """ - return self._release_ids + return self._state - @release_ids.setter - def release_ids(self, release_ids): - """Sets the release_ids of this WebcaptureEntity. + @state.setter + def state(self, state): + """Sets the state 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] + :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._release_ids = release_ids + self._state = state @property - def timestamp(self): - """Gets the timestamp of this WebcaptureEntity. # noqa: E501 + def ident(self): + """Gets the ident 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 + base32-encoded unique identifier # noqa: E501 - :return: The timestamp of this WebcaptureEntity. # noqa: E501 - :rtype: datetime + :return: The ident of this WebcaptureEntity. # noqa: E501 + :rtype: str """ - return self._timestamp + return self._ident - @timestamp.setter - def timestamp(self, timestamp): - """Sets the timestamp of this WebcaptureEntity. + @ident.setter + def ident(self, ident): + """Sets the ident 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 + base32-encoded unique identifier # noqa: E501 - :param timestamp: The timestamp of this WebcaptureEntity. # noqa: E501 - :type: datetime + :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._timestamp = timestamp + self._ident = ident @property - def original_url(self): - """Gets the original_url of this WebcaptureEntity. # noqa: E501 + def revision(self): + """Gets the revision of this WebcaptureEntity. # noqa: E501 - Base URL of the primary resource this is a capture of # noqa: E501 + UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501 - :return: The original_url of this WebcaptureEntity. # noqa: E501 + :return: The revision of this WebcaptureEntity. # noqa: E501 :rtype: str """ - return self._original_url + return self._revision - @original_url.setter - def original_url(self, original_url): - """Sets the original_url of this WebcaptureEntity. + @revision.setter + def revision(self, revision): + """Sets the revision of this WebcaptureEntity. - Base URL of the primary resource this is a capture of # noqa: E501 + UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501 - :param original_url: The original_url of this WebcaptureEntity. # 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._original_url = original_url + self._revision = revision @property - def archive_urls(self): - """Gets the archive_urls of this WebcaptureEntity. # noqa: E501 + def redirect(self): + """Gets the redirect of this WebcaptureEntity. # noqa: E501 + base32-encoded unique identifier # noqa: E501 - :return: The archive_urls of this WebcaptureEntity. # noqa: E501 - :rtype: list[WebcaptureUrl] + :return: The redirect of this WebcaptureEntity. # noqa: E501 + :rtype: str """ - return self._archive_urls + return self._redirect - @archive_urls.setter - def archive_urls(self, archive_urls): - """Sets the archive_urls of this WebcaptureEntity. + @redirect.setter + def redirect(self, redirect): + """Sets the redirect of this WebcaptureEntity. + base32-encoded unique identifier # noqa: E501 - :param archive_urls: The archive_urls of this WebcaptureEntity. # noqa: E501 - :type: list[WebcaptureUrl] + :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._archive_urls = archive_urls + self._redirect = redirect @property - def cdx(self): - """Gets the cdx of this WebcaptureEntity. # noqa: E501 + 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 cdx of this WebcaptureEntity. # noqa: E501 - :rtype: list[WebcaptureCdxLine] + :return: The extra of this WebcaptureEntity. # noqa: E501 + :rtype: dict(str, object) """ - return self._cdx + return self._extra - @cdx.setter - def cdx(self, cdx): - """Sets the cdx of this WebcaptureEntity. + @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 cdx: The cdx of this WebcaptureEntity. # noqa: E501 - :type: list[WebcaptureCdxLine] + :param extra: The extra of this WebcaptureEntity. # noqa: E501 + :type: dict(str, object) """ - self._cdx = cdx + self._extra = extra @property def edit_extra(self): @@ -246,7 +247,7 @@ class WebcaptureEntity(object): 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: object + :rtype: dict(str, object) """ return self._edit_extra @@ -257,153 +258,150 @@ class WebcaptureEntity(object): 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: object + :type: dict(str, object) """ self._edit_extra = edit_extra @property - def extra(self): - """Gets the extra of this WebcaptureEntity. # noqa: E501 + def cdx(self): + """Gets the cdx 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: object + :return: The cdx of this WebcaptureEntity. # noqa: E501 + :rtype: list[WebcaptureCdxLine] """ - return self._extra + return self._cdx - @extra.setter - def extra(self, extra): - """Sets the extra of this WebcaptureEntity. + @cdx.setter + def cdx(self, cdx): + """Sets the cdx 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: object + :param cdx: The cdx of this WebcaptureEntity. # noqa: E501 + :type: list[WebcaptureCdxLine] """ - self._extra = extra + self._cdx = cdx @property - def redirect(self): - """Gets the redirect of this WebcaptureEntity. # noqa: E501 + def archive_urls(self): + """Gets the archive_urls of this WebcaptureEntity. # noqa: E501 - base32-encoded unique identifier # noqa: E501 - :return: The redirect of this WebcaptureEntity. # noqa: E501 - :rtype: str + :return: The archive_urls of this WebcaptureEntity. # noqa: E501 + :rtype: list[WebcaptureUrl] """ - return self._redirect + return self._archive_urls - @redirect.setter - def redirect(self, redirect): - """Sets the redirect of this WebcaptureEntity. + @archive_urls.setter + def archive_urls(self, archive_urls): + """Sets the archive_urls of this WebcaptureEntity. - base32-encoded unique identifier # noqa: E501 - :param redirect: The redirect of this WebcaptureEntity. # noqa: E501 - :type: str + :param archive_urls: The archive_urls of this WebcaptureEntity. # noqa: E501 + :type: list[WebcaptureUrl] """ - 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('[a-zA-Z2-7]{26}', redirect): # noqa: E501 - raise ValueError("Invalid value for `redirect`, must be a follow pattern or equal to `/[a-zA-Z2-7]{26}/`") # noqa: E501 - self._redirect = redirect + self._archive_urls = archive_urls @property - def revision(self): - """Gets the revision of this WebcaptureEntity. # noqa: E501 + def original_url(self): + """Gets the original_url of this WebcaptureEntity. # noqa: E501 - UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501 + Base URL of the primary resource this is a capture of # noqa: E501 - :return: The revision of this WebcaptureEntity. # noqa: E501 + :return: The original_url of this WebcaptureEntity. # noqa: E501 :rtype: str """ - return self._revision + return self._original_url - @revision.setter - def revision(self, revision): - """Sets the revision of this WebcaptureEntity. + @original_url.setter + def original_url(self, original_url): + """Sets the original_url of this WebcaptureEntity. - UUID (lower-case, dash-separated, hex-encoded 128-bit) # noqa: E501 + Base URL of the primary resource this is a capture of # noqa: E501 - :param revision: The revision of this WebcaptureEntity. # noqa: E501 + :param original_url: The original_url 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('[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("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 + self._original_url = original_url @property - def ident(self): - """Gets the ident of this WebcaptureEntity. # noqa: E501 + def timestamp(self): + """Gets the timestamp of this WebcaptureEntity. # noqa: E501 - base32-encoded unique identifier # 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 ident of this WebcaptureEntity. # noqa: E501 - :rtype: str + :return: The timestamp of this WebcaptureEntity. # noqa: E501 + :rtype: datetime """ - return self._ident + return self._timestamp - @ident.setter - def ident(self, ident): - """Sets the ident of this WebcaptureEntity. + @timestamp.setter + def timestamp(self, timestamp): + """Sets the timestamp of this WebcaptureEntity. - base32-encoded unique identifier # 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 - :param ident: The ident of this WebcaptureEntity. # noqa: E501 - :type: str + :param timestamp: The timestamp of this WebcaptureEntity. # noqa: E501 + :type: datetime """ - 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('[a-zA-Z2-7]{26}', ident): # noqa: E501 - raise ValueError("Invalid value for `ident`, must be a follow pattern or equal to `/[a-zA-Z2-7]{26}/`") # noqa: E501 - self._ident = ident + self._timestamp = timestamp @property - def state(self): - """Gets the state of this WebcaptureEntity. # noqa: E501 + 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 state of this WebcaptureEntity. # noqa: E501 - :rtype: str + :return: The release_ids of this WebcaptureEntity. # noqa: E501 + :rtype: list[str] """ - return self._state + return self._release_ids - @state.setter - def state(self, state): - """Sets the state of this WebcaptureEntity. + @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 state: The state of this WebcaptureEntity. # noqa: E501 - :type: str + :param release_ids: The release_ids of this WebcaptureEntity. # noqa: E501 + :type: list[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 + 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.swagger_types): + for attr, _ in six.iteritems(self.openapi_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( |