Package io.github.primelib.confluence4j.rest.v1.models

Class ContentTemplateUpdate

java.lang.Object
io.github.primelib.confluence4j.rest.v1.models.ContentTemplateUpdate
@Generated("io.github.primelib.primecodegen") public class ContentTemplateUpdate extends Object
ContentTemplateUpdate

This object is used to update content templates.

  • Field Details

    • templateId

      protected String templateId
      The ID of the template being updated.

    • name

      protected String name
      The name of the template. Set to the current `name` if this field is not being updated.

    • templateType

      protected String templateType
      The type of the template. Set to `page`.

    • body

      protected ContentTemplateBodyCreate body
      The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. `storage`. Note, `editor2` format is used by Atlassian only. `anonymous_export_view` is the same as `export_view` format but only content viewable by an anonymous user is included.

    • description

      protected String description
      A description of the template.

    • labels

      protected List<Label> labels
      Labels for the template.

    • space

      protected Map<String,Object> space
      The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.

  • Constructor Details

    • ContentTemplateUpdate

      public ContentTemplateUpdate(Consumer<ContentTemplateUpdate> spec)
      Constructs a validated instance of ContentTemplateUpdate.
      Parameters:
      spec - the specification to process

    • ContentTemplateUpdate

      @Internal public ContentTemplateUpdate(String templateId, String name, String templateType, ContentTemplateBodyCreate body, String description, List<Label> labels, Map<String,Object> space)
      Constructs a validated instance of ContentTemplateUpdate.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using ContentTemplateUpdate(Consumer) instead.

      Parameters:
      templateId - The ID of the template being updated.
      name - The name of the template. Set to the current `name` if this field is not being updated.
      templateType - The type of the template. Set to `page`.
      body - The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. `storage`. Note, `editor2` format is used by Atlassian only. `anonymous_export_view` is the same as `export_view` format but only content viewable by an anonymous user is included.
      description - A description of the template.
      labels - Labels for the template.
      space - The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.

    • ContentTemplateUpdate

      protected ContentTemplateUpdate()

  • Method Details

    • templateId

      public String templateId()
      The ID of the template being updated.

    • name

      public String name()
      The name of the template. Set to the current `name` if this field is not being updated.

    • templateType

      public String templateType()
      The type of the template. Set to `page`.

    • body

      public ContentTemplateBodyCreate body()
      The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. `storage`. Note, `editor2` format is used by Atlassian only. `anonymous_export_view` is the same as `export_view` format but only content viewable by an anonymous user is included.

    • description

      public String description()
      A description of the template.

    • labels

      public List<Label> labels()
      Labels for the template.

    • space

      public Map<String,Object> space()
      The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.

    • templateId

      public ContentTemplateUpdate templateId(String templateId)
      The ID of the template being updated.
      Returns:
      this.

    • name

      public ContentTemplateUpdate name(String name)
      The name of the template. Set to the current `name` if this field is not being updated.
      Returns:
      this.

    • templateType

      public ContentTemplateUpdate templateType(String templateType)
      The type of the template. Set to `page`.
      Returns:
      this.

    • body

      public ContentTemplateUpdate body(ContentTemplateBodyCreate body)
      The body of the new content. Does not apply to attachments. Only one body format should be specified as the property for this object, e.g. `storage`. Note, `editor2` format is used by Atlassian only. `anonymous_export_view` is the same as `export_view` format but only content viewable by an anonymous user is included.
      Returns:
      this.

    • description

      public ContentTemplateUpdate description(String description)
      A description of the template.
      Returns:
      this.

    • labels

      public ContentTemplateUpdate labels(List<Label> labels)
      Labels for the template.
      Returns:
      this.

    • space

      public ContentTemplateUpdate space(Map<String,Object> space)
      The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object