View Source GoogleApi.ContentWarehouse.V1.Model.OceanDocTagMagazineSpecific (google_api_content_warehouse v0.3.0)

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

Attributes

  • 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.
  • issueDescription (type: String.t, default: nil) - Description specific to a magazine issue, such as featured articles and article summaries.
  • issueEnd (type: integer(), default: nil) -
  • issueStart (type: integer(), default: nil) -
  • item (type: list(GoogleApi.ContentWarehouse.V1.Model.OceanDataDocinfoWoodwingItemMetadata.t), default: nil) - Items within a magazine issue.
  • otherNumberingEnd (type: integer(), default: nil) -
  • otherNumberingSchema (type: integer(), default: nil) - NOTE: These should to be values from MetadataNumberingSchema; when this becomes a proto2, we can use MetadataEnums values.
  • otherNumberingStart (type: integer(), default: nil) - For season or quarter dates.
  • pageToItem (type: list(integer()), default: nil) - For each page of a magazine, maps to the item index of "item".
  • publicationDateEnd (type: String.t, default: nil) -
  • publicationDateStart (type: String.t, default: nil) -
  • 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.
  • serialVolumeid (type: String.t, default: nil) -
  • volume (type: integer(), default: nil) -

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@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
}

Functions

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

Unwrap a decoded JSON object into its complex fields.