Class/Object

com.gu.contentapi.client.model.v1.Tag

Immutable

Related Docs: object Immutable | package Tag

Permalink

class Immutable extends Tag

The default read-only implementation of Tag. You typically should not need to directly reference this class; instead, use the Tag.apply method to construct new instances.

Linear Supertypes
Tag, Serializable, ValidatingThriftStruct[Tag], HasThriftStructCodec3[Tag], Product, Equals, ThriftStruct, ThriftStructIface, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Immutable
  2. Tag
  3. Serializable
  4. ValidatingThriftStruct
  5. HasThriftStructCodec3
  6. Product
  7. Equals
  8. ThriftStruct
  9. ThriftStructIface
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Immutable(id: String, type: TagType, sectionId: Option[String] = _root_.scala.None, sectionName: Option[String] = _root_.scala.None, webTitle: String, webUrl: String, apiUrl: String, references: Seq[Reference] = ..., description: Option[String] = _root_.scala.None, bio: Option[String] = _root_.scala.None, bylineImageUrl: Option[String] = _root_.scala.None, bylineLargeImageUrl: Option[String] = _root_.scala.None, podcast: Option[Podcast] = _root_.scala.None, firstName: Option[String] = _root_.scala.None, lastName: Option[String] = _root_.scala.None, emailAddress: Option[String] = _root_.scala.None, twitterHandle: Option[String] = _root_.scala.None, activeSponsorships: Option[Seq[Sponsorship]] = _root_.scala.None, paidContentType: Option[String] = _root_.scala.None, paidContentCampaignColour: Option[String] = _root_.scala.None, rcsId: Option[String] = _root_.scala.None, r2ContributorId: Option[String] = _root_.scala.None, tagCategories: Option[Set[String]] = _root_.scala.None, entityIds: Option[Set[String]] = _root_.scala.None, campaignInformationType: Option[String] = _root_.scala.None, internalName: Option[String] = _root_.scala.None)

    Permalink
  2. new Immutable(id: String, type: TagType, sectionId: Option[String], sectionName: Option[String], webTitle: String, webUrl: String, apiUrl: String, references: Seq[Reference], description: Option[String], bio: Option[String], bylineImageUrl: Option[String], bylineLargeImageUrl: Option[String], podcast: Option[Podcast], firstName: Option[String], lastName: Option[String], emailAddress: Option[String], twitterHandle: Option[String], activeSponsorships: Option[Seq[Sponsorship]], paidContentType: Option[String], paidContentCampaignColour: Option[String], rcsId: Option[String], r2ContributorId: Option[String], tagCategories: Option[Set[String]], entityIds: Option[Set[String]], campaignInformationType: Option[String], internalName: Option[String], _passthroughFields: Map[Short, TFieldBlob])

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def _1: String

    Permalink
    Definition Classes
    Tag
  5. def _10: Option[String]

    Permalink
    Definition Classes
    Tag
  6. def _11: Option[String]

    Permalink
    Definition Classes
    Tag
  7. def _12: Option[String]

    Permalink
    Definition Classes
    Tag
  8. def _13: Option[Podcast]

    Permalink
    Definition Classes
    Tag
  9. def _14: Option[String]

    Permalink
    Definition Classes
    Tag
  10. def _15: Option[String]

    Permalink
    Definition Classes
    Tag
  11. def _16: Option[String]

    Permalink
    Definition Classes
    Tag
  12. def _17: Option[String]

    Permalink
    Definition Classes
    Tag
  13. def _18: Option[Seq[Sponsorship]]

    Permalink
    Definition Classes
    Tag
  14. def _19: Option[String]

    Permalink
    Definition Classes
    Tag
  15. def _2: TagType

    Permalink
    Definition Classes
    Tag
  16. def _20: Option[String]

    Permalink
    Definition Classes
    Tag
  17. def _21: Option[String]

    Permalink
    Definition Classes
    Tag
  18. def _22: Option[String]

    Permalink
    Definition Classes
    Tag
  19. def _23: Option[Set[String]]

    Permalink
    Definition Classes
    Tag
  20. def _24: Option[Set[String]]

    Permalink
    Definition Classes
    Tag
  21. def _25: Option[String]

    Permalink
    Definition Classes
    Tag
  22. def _26: Option[String]

    Permalink
    Definition Classes
    Tag
  23. def _3: Option[String]

    Permalink
    Definition Classes
    Tag
  24. def _4: Option[String]

    Permalink
    Definition Classes
    Tag
  25. def _5: String

    Permalink
    Definition Classes
    Tag
  26. def _6: String

    Permalink
    Definition Classes
    Tag
  27. def _7: String

    Permalink
    Definition Classes
    Tag
  28. def _8: Seq[Reference]

    Permalink
    Definition Classes
    Tag
  29. def _9: Option[String]

    Permalink
    Definition Classes
    Tag
  30. def _codec: ValidatingThriftStructCodec3[Tag]

    Permalink
    Definition Classes
    Tag → ValidatingThriftStruct → HasThriftStructCodec3
  31. val _passthroughFields: Map[Short, TFieldBlob]

    Permalink
    Definition Classes
    ImmutableTag
  32. val activeSponsorships: Option[Seq[Sponsorship]]

    Permalink

    A list of all the active sponsorships running against this tag

    A list of all the active sponsorships running against this tag

    Definition Classes
    ImmutableTag
  33. val apiUrl: String

    Permalink
    Definition Classes
    ImmutableTag
  34. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  35. val bio: Option[String]

    Permalink

    If this tag is a contributor then we *may* have a small bio for the contributor.

    If this tag is a contributor then we *may* have a small bio for the contributor.

    This field is optional in all cases, even contributors are not guaranteed to have one.

    Definition Classes
    ImmutableTag
  36. val bylineImageUrl: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  37. val bylineLargeImageUrl: Option[String]

    Permalink

    If this tag is a contributor then we *may* have a large byline picture for the contributor.

    If this tag is a contributor then we *may* have a large byline picture for the contributor.

    Definition Classes
    ImmutableTag
  38. val campaignInformationType: Option[String]

    Permalink

    If the tag is a campaign, it should have a subtype eg callout

    If the tag is a campaign, it should have a subtype eg callout

    Definition Classes
    ImmutableTag
  39. def canEqual(other: Any): Boolean

    Permalink
    Definition Classes
    Tag → Equals
  40. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. def copy(id: String = this.id, type: TagType = this.`type`, sectionId: Option[String] = this.sectionId, sectionName: Option[String] = this.sectionName, webTitle: String = this.webTitle, webUrl: String = this.webUrl, apiUrl: String = this.apiUrl, references: Seq[Reference] = this.references, description: Option[String] = this.description, bio: Option[String] = this.bio, bylineImageUrl: Option[String] = this.bylineImageUrl, bylineLargeImageUrl: Option[String] = this.bylineLargeImageUrl, podcast: Option[Podcast] = this.podcast, firstName: Option[String] = this.firstName, lastName: Option[String] = this.lastName, emailAddress: Option[String] = this.emailAddress, twitterHandle: Option[String] = this.twitterHandle, activeSponsorships: Option[Seq[Sponsorship]] = this.activeSponsorships, paidContentType: Option[String] = this.paidContentType, paidContentCampaignColour: Option[String] = this.paidContentCampaignColour, rcsId: Option[String] = this.rcsId, r2ContributorId: Option[String] = this.r2ContributorId, tagCategories: Option[Set[String]] = this.tagCategories, entityIds: Option[Set[String]] = this.entityIds, campaignInformationType: Option[String] = this.campaignInformationType, internalName: Option[String] = this.internalName, _passthroughFields: Map[Short, TFieldBlob] = this._passthroughFields): Tag

    Permalink
    Definition Classes
    Tag
  42. val description: Option[String]

    Permalink

    A tag *may* have a description field.

    A tag *may* have a description field.

    Contributor tags never have a description field. They may instead have a 'bio' field.

    Definition Classes
    ImmutableTag
  43. val emailAddress: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  44. val entityIds: Option[Set[String]]

    Permalink
    Definition Classes
    ImmutableTag
  45. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  46. def equals(other: Any): Boolean

    Permalink
    Definition Classes
    Tag → Equals → AnyRef → Any
  47. val firstName: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  48. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  49. def getFieldBlob(_fieldId: Short): Option[TFieldBlob]

    Permalink

    Gets a field value encoded as a binary blob using TCompactProtocol.

    Gets a field value encoded as a binary blob using TCompactProtocol. If the specified field is present in the passthrough map, that value is returned. Otherwise, if the specified field is known and not optional and set to None, then the field is serialized and returned.

    Definition Classes
    Tag
  50. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

    Permalink

    Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.

    Collects TCompactProtocol-encoded field values according to getFieldBlob into a map.

    Definition Classes
    Tag
  51. def hashCode(): Int

    Permalink
    Definition Classes
    Tag → AnyRef → Any
  52. val id: String

    Permalink
    Definition Classes
    ImmutableTag
  53. val internalName: Option[String]

    Permalink

    The internal name of the tag

    The internal name of the tag

    Definition Classes
    ImmutableTag
  54. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  55. val lastName: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  56. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  57. def newBuilder(): StructBuilder[Tag]

    Permalink
    Definition Classes
    Tag
  58. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  59. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  60. val paidContentCampaignColour: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  61. val paidContentType: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  62. val podcast: Option[Podcast]

    Permalink
    Definition Classes
    ImmutableTag
  63. def productArity: Int

    Permalink
    Definition Classes
    Tag → Product
  64. def productElement(n: Int): Any

    Permalink
    Definition Classes
    Tag → Product
  65. def productIterator: Iterator[Any]

    Permalink
    Definition Classes
    Product
  66. def productPrefix: String

    Permalink
    Definition Classes
    Tag → Product
  67. val r2ContributorId: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  68. val rcsId: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  69. val references: Seq[Reference]

    Permalink
    Definition Classes
    ImmutableTag
  70. val sectionId: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  71. val sectionName: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  72. def setField(_blob: TFieldBlob): Tag

    Permalink

    Sets a field using a TCompactProtocol-encoded binary blob.

    Sets a field using a TCompactProtocol-encoded binary blob. If the field is a known field, the blob is decoded and the field is set to the decoded value. If the field is unknown and passthrough fields are enabled, then the blob will be stored in _passthroughFields.

    Definition Classes
    Tag
  73. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  74. val tagCategories: Option[Set[String]]

    Permalink
    Definition Classes
    ImmutableTag
  75. def toString(): String

    Permalink
    Definition Classes
    Tag → AnyRef → Any
  76. val twitterHandle: Option[String]

    Permalink
    Definition Classes
    ImmutableTag
  77. val type: TagType

    Permalink
    Definition Classes
    ImmutableTag
  78. def unsetActiveSponsorships: Tag

    Permalink
    Definition Classes
    Tag
  79. def unsetApiUrl: Tag

    Permalink
    Definition Classes
    Tag
  80. def unsetBio: Tag

    Permalink
    Definition Classes
    Tag
  81. def unsetBylineImageUrl: Tag

    Permalink
    Definition Classes
    Tag
  82. def unsetBylineLargeImageUrl: Tag

    Permalink
    Definition Classes
    Tag
  83. def unsetCampaignInformationType: Tag

    Permalink
    Definition Classes
    Tag
  84. def unsetDescription: Tag

    Permalink
    Definition Classes
    Tag
  85. def unsetEmailAddress: Tag

    Permalink
    Definition Classes
    Tag
  86. def unsetEntityIds: Tag

    Permalink
    Definition Classes
    Tag
  87. def unsetField(_fieldId: Short): Tag

    Permalink

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

    Definition Classes
    Tag
  88. def unsetFirstName: Tag

    Permalink
    Definition Classes
    Tag
  89. def unsetId: Tag

    Permalink

    If the specified field is optional, it is set to None.

    If the specified field is optional, it is set to None. Otherwise, if the field is known, it is reverted to its default value; if the field is unknown, it is removed from the passthroughFields map, if present.

    Definition Classes
    Tag
  90. def unsetInternalName: Tag

    Permalink
    Definition Classes
    Tag
  91. def unsetLastName: Tag

    Permalink
    Definition Classes
    Tag
  92. def unsetPaidContentCampaignColour: Tag

    Permalink
    Definition Classes
    Tag
  93. def unsetPaidContentType: Tag

    Permalink
    Definition Classes
    Tag
  94. def unsetPodcast: Tag

    Permalink
    Definition Classes
    Tag
  95. def unsetR2ContributorId: Tag

    Permalink
    Definition Classes
    Tag
  96. def unsetRcsId: Tag

    Permalink
    Definition Classes
    Tag
  97. def unsetReferences: Tag

    Permalink
    Definition Classes
    Tag
  98. def unsetSectionId: Tag

    Permalink
    Definition Classes
    Tag
  99. def unsetSectionName: Tag

    Permalink
    Definition Classes
    Tag
  100. def unsetTagCategories: Tag

    Permalink
    Definition Classes
    Tag
  101. def unsetTwitterHandle: Tag

    Permalink
    Definition Classes
    Tag
  102. def unsetType: Tag

    Permalink
    Definition Classes
    Tag
  103. def unsetWebTitle: Tag

    Permalink
    Definition Classes
    Tag
  104. def unsetWebUrl: Tag

    Permalink
    Definition Classes
    Tag
  105. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  106. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  107. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  108. val webTitle: String

    Permalink
    Definition Classes
    ImmutableTag
  109. val webUrl: String

    Permalink
    Definition Classes
    ImmutableTag
  110. def write(_oprot: TProtocol): Unit

    Permalink
    Definition Classes
    Tag → ThriftStruct

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Tag

Inherited from Serializable

Inherited from ValidatingThriftStruct[Tag]

Inherited from HasThriftStructCodec3[Tag]

Inherited from Product

Inherited from Equals

Inherited from ThriftStruct

Inherited from ThriftStructIface

Inherited from AnyRef

Inherited from Any

Ungrouped