Trait/Object

com.gu.contentapi.client.model.v1

Tag

Related Docs: object Tag | package v1

Permalink

trait Tag extends ThriftStruct with Product with ValidatingThriftStruct[Tag] with Serializable

Prefer the companion object's com.gu.contentapi.client.model.v1.Tag.apply for construction if you don't need to specify passthrough fields.

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

Abstract Value Members

  1. abstract def activeSponsorships: Option[Seq[Sponsorship]]

    Permalink

    A list of all the active sponsorships running against this tag

  2. abstract def apiUrl: String

    Permalink
  3. abstract def 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.

  4. abstract def bylineImageUrl: Option[String]

    Permalink
  5. abstract def bylineLargeImageUrl: Option[String]

    Permalink

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

  6. abstract def campaignInformationType: Option[String]

    Permalink

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

  7. abstract def 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.

  8. abstract def emailAddress: Option[String]

    Permalink
  9. abstract def entityIds: Option[Set[String]]

    Permalink
  10. abstract def firstName: Option[String]

    Permalink
  11. abstract def id: String

    Permalink
  12. abstract def internalName: Option[String]

    Permalink

    The internal name of the tag

  13. abstract def lastName: Option[String]

    Permalink
  14. abstract def paidContentCampaignColour: Option[String]

    Permalink
  15. abstract def paidContentType: Option[String]

    Permalink
  16. abstract def podcast: Option[Podcast]

    Permalink
  17. abstract def r2ContributorId: Option[String]

    Permalink
  18. abstract def rcsId: Option[String]

    Permalink
  19. abstract def references: Seq[Reference]

    Permalink
  20. abstract def sectionId: Option[String]

    Permalink
  21. abstract def sectionName: Option[String]

    Permalink
  22. abstract def tagCategories: Option[Set[String]]

    Permalink
  23. abstract def twitterHandle: Option[String]

    Permalink
  24. abstract def type: TagType

    Permalink
  25. abstract def webTitle: String

    Permalink
  26. abstract def webUrl: String

    Permalink

Concrete 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
  5. def _10: Option[String]

    Permalink
  6. def _11: Option[String]

    Permalink
  7. def _12: Option[String]

    Permalink
  8. def _13: Option[Podcast]

    Permalink
  9. def _14: Option[String]

    Permalink
  10. def _15: Option[String]

    Permalink
  11. def _16: Option[String]

    Permalink
  12. def _17: Option[String]

    Permalink
  13. def _18: Option[Seq[Sponsorship]]

    Permalink
  14. def _19: Option[String]

    Permalink
  15. def _2: TagType

    Permalink
  16. def _20: Option[String]

    Permalink
  17. def _21: Option[String]

    Permalink
  18. def _22: Option[String]

    Permalink
  19. def _23: Option[Set[String]]

    Permalink
  20. def _24: Option[Set[String]]

    Permalink
  21. def _25: Option[String]

    Permalink
  22. def _26: Option[String]

    Permalink
  23. def _3: Option[String]

    Permalink
  24. def _4: Option[String]

    Permalink
  25. def _5: String

    Permalink
  26. def _6: String

    Permalink
  27. def _7: String

    Permalink
  28. def _8: Seq[Reference]

    Permalink
  29. def _9: Option[String]

    Permalink
  30. def _codec: ValidatingThriftStructCodec3[Tag]

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

    Permalink
  32. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  33. def canEqual(other: Any): Boolean

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. 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
  36. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    Tag → Equals → AnyRef → Any
  38. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  39. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  40. 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.

  41. def getFieldBlobs(ids: TraversableOnce[Short]): Map[Short, TFieldBlob]

    Permalink

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

  42. def hashCode(): Int

    Permalink
    Definition Classes
    Tag → AnyRef → Any
  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  44. final def ne(arg0: AnyRef): Boolean

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

    Permalink
  46. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  48. def productArity: Int

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

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

    Permalink
    Definition Classes
    Product
  51. def productPrefix: String

    Permalink
    Definition Classes
    Tag → Product
  52. 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.

  53. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  54. def toString(): String

    Permalink
    Definition Classes
    Tag → AnyRef → Any
  55. def unsetActiveSponsorships: Tag

    Permalink
  56. def unsetApiUrl: Tag

    Permalink
  57. def unsetBio: Tag

    Permalink
  58. def unsetBylineImageUrl: Tag

    Permalink
  59. def unsetBylineLargeImageUrl: Tag

    Permalink
  60. def unsetCampaignInformationType: Tag

    Permalink
  61. def unsetDescription: Tag

    Permalink
  62. def unsetEmailAddress: Tag

    Permalink
  63. def unsetEntityIds: Tag

    Permalink
  64. 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.

  65. def unsetFirstName: Tag

    Permalink
  66. 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.

  67. def unsetInternalName: Tag

    Permalink
  68. def unsetLastName: Tag

    Permalink
  69. def unsetPaidContentCampaignColour: Tag

    Permalink
  70. def unsetPaidContentType: Tag

    Permalink
  71. def unsetPodcast: Tag

    Permalink
  72. def unsetR2ContributorId: Tag

    Permalink
  73. def unsetRcsId: Tag

    Permalink
  74. def unsetReferences: Tag

    Permalink
  75. def unsetSectionId: Tag

    Permalink
  76. def unsetSectionName: Tag

    Permalink
  77. def unsetTagCategories: Tag

    Permalink
  78. def unsetTwitterHandle: Tag

    Permalink
  79. def unsetType: Tag

    Permalink
  80. def unsetWebTitle: Tag

    Permalink
  81. def unsetWebUrl: Tag

    Permalink
  82. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  83. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  85. def write(_oprot: TProtocol): Unit

    Permalink
    Definition Classes
    Tag → ThriftStruct

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