OceanDocTagMagazineSpecific

Posted on by Darth Autocrat

GoogleApi.ContentWarehouse.V1.Model.OceanDocTagMagazineSpecific

Table of Contents ▼

Jump to a specific part of the page:

Description

Magazine-specific fields. See https://www.corp.google.com/eng/designdocs/scanning/magazines/designdoc.html for magazine design doc.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. displayDate (type: String.t, default: nil)
    - A human-readable date for display in the UI. Unlike "publicationdate" above, this should not be parsed into structured data, but should only be displayed as is.
  2. issueDescription (type: String.t, default: nil)
    - Description specific to a magazine issue, such as featured articles and article summaries.
  3. issueEnd (type: integer(), default: nil)
    -
  4. issueStart (type: integer(), default: nil)
    -
  5. item (type: list(GoogleApi.ContentWarehouse.V1.Model.OceanDataDocinfoWoodwingItemMetadata), default: nil)
    - Items within a magazine issue.
  6. otherNumberingEnd (type: integer(), default: nil)
    -
  7. otherNumberingSchema (type: integer(), default: nil)
    - NOTE: These should to be values from MetadataNumberingSchema; when this becomes a proto2, we can use MetadataEnums values.
  8. otherNumberingStart (type: integer(), default: nil)
    - For season or quarter dates.
  9. pageToItem (type: list(integer()), default: nil)
    - For each page of a magazine, maps to the item index of "item".
  10. publicationDateEnd (type: String.t, default: nil)
    -
  11. publicationDateStart (type: String.t, default: nil)
    -
  12. serialTitle (type: String.t, default: nil)
    - This is used to render the metadata line of the snippet and should be present in all magazine documents.
  13. serialVolumeid (type: String.t, default: nil)
    -
  14. volume (type: integer(), default: nil)
    -

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.OceanDocTagMagazineSpecific{
displayDate: String.t() | nil,
issueDescription: String.t() | nil,
issueEnd: integer() | nil,
issueStart: integer() | nil,
item: [ GoogleApi.ContentWarehouse.V1.Model.OceanDataDocinfoWoodwingItemMetadata.t() ] | nil,
otherNumberingEnd: integer() | nil,
otherNumberingSchema: integer() | nil,
otherNumberingStart: integer() | nil,
pageToItem: [integer()] | nil,
publicationDateEnd: String.t() | nil,
publicationDateStart: String.t() | nil,
serialTitle: String.t() | nil,
serialVolumeid: String.t() | nil,
volume: integer() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.OceanDocTagMagazineSpecific