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 protected ContentTemplateUpdate()
      Protected no-args constructor for use by serialization frameworks.

    • 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`.

  • Method Details

    • templateId

      public String templateId()
      Fluent getter for templateId.

      The ID of the template being updated.

      Returns:
      templateId

    • templateId

      public ContentTemplateUpdate templateId(String templateId)
      Fluent setter for templateId.

      The ID of the template being updated.

      Parameters:
      templateId - templateId
      Returns:
      this

    • getTemplateId

      public String getTemplateId()
      Gets the value of templateId.

      The ID of the template being updated.

      Returns:
      templateId

    • setTemplateId

      public void setTemplateId(String templateId)
      Sets the value of templateId.

      The ID of the template being updated.

      Parameters:
      templateId - templateId

    • name

      public String name()
      Fluent getter for name.

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

      Returns:
      name

    • name

      public ContentTemplateUpdate name(String name)
      Fluent setter for name.

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

      Parameters:
      name - name
      Returns:
      this

    • getName

      public String getName()
      Gets the value of name.

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

      Returns:
      name

    • setName

      public void setName(String name)
      Sets the value of name.

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

      Parameters:
      name - name

    • templateType

      public String templateType()
      Fluent getter for templateType.

      The type of the template. Set to `page`.

      Returns:
      templateType

    • templateType

      public ContentTemplateUpdate templateType(String templateType)
      Fluent setter for templateType.

      The type of the template. Set to `page`.

      Parameters:
      templateType - templateType
      Returns:
      this

    • getTemplateType

      public String getTemplateType()
      Gets the value of templateType.

      The type of the template. Set to `page`.

      Returns:
      templateType

    • setTemplateType

      public void setTemplateType(String templateType)
      Sets the value of templateType.

      The type of the template. Set to `page`.

      Parameters:
      templateType - templateType

    • body

      public ContentTemplateBodyCreate body()
      Fluent getter for 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:
      body

    • body

      public ContentTemplateUpdate body(ContentTemplateBodyCreate body)
      Fluent setter for 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.

      Parameters:
      body - body
      Returns:
      this

    • getBody

      public ContentTemplateBodyCreate getBody()
      Gets the value of 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:
      body

    • setBody

      public void setBody(ContentTemplateBodyCreate body)
      Sets the value of 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.

      Parameters:
      body - body

    • description

      public String description()
      Fluent getter for description.

      A description of the template.

      Returns:
      description

    • description

      public ContentTemplateUpdate description(String description)
      Fluent setter for description.

      A description of the template.

      Parameters:
      description - description
      Returns:
      this

    • getDescription

      public String getDescription()
      Gets the value of description.

      A description of the template.

      Returns:
      description

    • setDescription

      public void setDescription(String description)
      Sets the value of description.

      A description of the template.

      Parameters:
      description - description

    • labels

      public List<Label> labels()
      Fluent getter for labels.

      Labels for the template.

      Returns:
      labels

    • labels

      public ContentTemplateUpdate labels(List<Label> labels)
      Fluent setter for labels.

      Labels for the template.

      Parameters:
      labels - labels
      Returns:
      this

    • getLabels

      public List<Label> getLabels()
      Gets the value of labels.

      Labels for the template.

      Returns:
      labels

    • setLabels

      public void setLabels(List<Label> labels)
      Sets the value of labels.

      Labels for the template.

      Parameters:
      labels - labels

    • space

      public Map<String,Object> space()
      Fluent getter for 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:
      space

    • space

      public ContentTemplateUpdate space(Map<String,Object> space)
      Fluent setter for space.

      The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.

      Parameters:
      space - space
      Returns:
      this

    • getSpace

      public Map<String,Object> getSpace()
      Gets the value of 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:
      space

    • setSpace

      public void setSpace(Map<String,Object> space)
      Sets the value of space.

      The key for the space of the template. Required if the template is a space template. Set this to the current `space.key`.

      Parameters:
      space - space

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object