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

Klasse GetSpaceOperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.GetSpaceOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetSpaceOperationSpec extends Object
GetSpaceSpec

Specification for the GetSpace operation.

Get space

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetSpaceOperationSpec

      @Internal public GetSpaceOperationSpec(Consumer<GetSpaceOperationSpec> spec)
      Constructs a validated instance of GetSpaceOperationSpec.
      Parameter:
      spec - the specification to process

    • GetSpaceOperationSpec

      @Internal public GetSpaceOperationSpec(String spaceKey, List<String> expand)
      Constructs a validated instance of GetSpaceOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameter:
      spaceKey - The key of the space to be returned.
      expand - A multi-value parameter indicating which properties of the spaces to expand, where: - settings returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get). - metadata returns the space metadata. - metadata.labels returns the space labels, which are used to categorize the space. - operations returns the operations for a space, which are used when setting permissions. - lookAndFeel returns information about the look and feel of the space, including the color scheme. - permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions. - icon returns information about space icon. - description returns the description of the space. - description.plain returns the description of the space, the plain format. - description.view returns the description of the space, the view format. - theme returns information about the space theme. - homepage returns information about the space homepage. - history returns information about the history of the space.

    • GetSpaceOperationSpec

      protected GetSpaceOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetSpaceOperationSpec.GetSpaceOperationSpecBuilder builder()

    • spaceKey

      @NotNull public @NotNull String spaceKey()
      The key of the space to be returned.

    • expand

      @Nullable public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the spaces to expand, where: - settings returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get). - metadata returns the space metadata. - metadata.labels returns the space labels, which are used to categorize the space. - operations returns the operations for a space, which are used when setting permissions. - lookAndFeel returns information about the look and feel of the space, including the color scheme. - permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions. - icon returns information about space icon. - description returns the description of the space. - description.plain returns the description of the space, the plain format. - description.view returns the description of the space, the view format. - theme returns information about the space theme. - homepage returns information about the space homepage. - history returns information about the history of the space.

    • spaceKey

      public GetSpaceOperationSpec spaceKey(@NotNull @NotNull String spaceKey)
      The key of the space to be returned.
      Gibt zurück:
      this.

    • expand

      public GetSpaceOperationSpec expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the spaces to expand, where: - settings returns the settings for the space, similar to [Get space settings](#api-space-spaceKey-settings-get). - metadata returns the space metadata. - metadata.labels returns the space labels, which are used to categorize the space. - operations returns the operations for a space, which are used when setting permissions. - lookAndFeel returns information about the look and feel of the space, including the color scheme. - permissions returns the permissions for the space. Note that this may return permissions for deleted groups, because deleting a group doesn't remove associated space permissions. - icon returns information about space icon. - description returns the description of the space. - description.plain returns the description of the space, the plain format. - description.view returns the description of the space, the view format. - theme returns information about the space theme. - homepage returns information about the space homepage. - history returns information about the history of the space.
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object