Class GetTemplateBlueprintV1OperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.operations.GetTemplateBlueprintV1OperationSpec
@Generated("io.github.primelib.primecodegen") public class GetTemplateBlueprintV1OperationSpec extends Object
GetTemplateBlueprintV1

Returns all templates provided by blueprints. Use this method to retrieve all global blueprint templates or all blueprint templates in a space. Note, all global blueprints are inherited by each space. Space blueprints can be customised without affecting the global blueprints. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space to view blueprints for the space and permission to access the Confluence site ('Can use' global permission) to view global blueprints.

  • Field Details

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Constructor Details

  • Method Details

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Throws:
      NullPointerException

    • spaceKey

      public @Nullable String spaceKey()
      The key of the space to be queried for templates. If the `spaceKey` is not specified, global blueprint templates will be returned.

    • start

      public @Nullable Integer start()
      The starting index of the returned templates.

    • limit

      public @Nullable Integer limit()
      The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.

    • expand

      public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.

    • spaceKey

      public GetTemplateBlueprintV1OperationSpec spaceKey(@Nullable String spaceKey)
      The key of the space to be queried for templates. If the `spaceKey` is not specified, global blueprint templates will be returned.
      Returns:
      this.

    • start

      public GetTemplateBlueprintV1OperationSpec start(@Nullable Integer start)
      The starting index of the returned templates.
      Returns:
      this.

    • limit

      public GetTemplateBlueprintV1OperationSpec limit(@Nullable Integer limit)
      The maximum number of templates to return per page. Note, this may be restricted by fixed system limits.
      Returns:
      this.

    • expand

      public GetTemplateBlueprintV1OperationSpec expand(@Nullable List<String> expand)
      A multi-value parameter indicating which properties of the template to expand. - `body` or `body.storage` returns the content of the template in storage format.
      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