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

Klasse GetSpacesOperationSpec

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

Specification for the GetSpaces operation.

Get spaces

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetSpacesOperationSpec

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

    • GetSpacesOperationSpec

      @Internal public GetSpacesOperationSpec(List<String> spaceKey, List<Long> spaceId, String type, String status, List<String> label, Boolean favourite, String favouriteUserKey, List<String> expand, Integer start, Integer limit)
      Constructs a validated instance of GetSpacesOperationSpec.

      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. To return multiple spaces, specify this parameter multiple times with different values.
      spaceId - The id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.
      type - Filter the results to spaces based on their type.
      status - Filter the results to spaces based on their status.
      label - Filter the results to spaces based on their label.
      favourite - Filter the results to the favourite spaces of the user specified by favouriteUserKey. Note, 'favourite' spaces are also known as 'saved for later' spaces.
      favouriteUserKey - The userKey of the user, whose favourite spaces are used to filter the results when using the favourite parameter. Leave blank for the current user. Use [Get user](#api-user-get) to get the userKey for a user.
      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.
      start - The starting index of the returned spaces.
      limit - The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits.

    • GetSpacesOperationSpec

      protected GetSpacesOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetSpacesOperationSpec.GetSpacesOperationSpecBuilder builder()

    • spaceKey

      @Nullable public @Nullable List<String> spaceKey()
      The key of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.

    • spaceId

      @Nullable public @Nullable List<Long> spaceId()
      The id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.

    • type

      @Nullable public @Nullable String type()
      Filter the results to spaces based on their type.

    • status

      @Nullable public @Nullable String status()
      Filter the results to spaces based on their status.

    • label

      @Nullable public @Nullable List<String> label()
      Filter the results to spaces based on their label.

    • favourite

      @Nullable public @Nullable Boolean favourite()
      Filter the results to the favourite spaces of the user specified by favouriteUserKey. Note, 'favourite' spaces are also known as 'saved for later' spaces.

    • favouriteUserKey

      @Nullable public @Nullable String favouriteUserKey()
      The userKey of the user, whose favourite spaces are used to filter the results when using the favourite parameter. Leave blank for the current user. Use [Get user](#api-user-get) to get the userKey for a user.

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

    • start

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

    • limit

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

    • spaceKey

      public GetSpacesOperationSpec spaceKey(@Nullable @Nullable List<String> spaceKey)
      The key of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.
      Gibt zurück:
      this.

    • spaceId

      public GetSpacesOperationSpec spaceId(@Nullable @Nullable List<Long> spaceId)
      The id of the space to be returned. To return multiple spaces, specify this parameter multiple times with different values.
      Gibt zurück:
      this.

    • type

      public GetSpacesOperationSpec type(@Nullable @Nullable String type)
      Filter the results to spaces based on their type.
      Gibt zurück:
      this.

    • status

      public GetSpacesOperationSpec status(@Nullable @Nullable String status)
      Filter the results to spaces based on their status.
      Gibt zurück:
      this.

    • label

      public GetSpacesOperationSpec label(@Nullable @Nullable List<String> label)
      Filter the results to spaces based on their label.
      Gibt zurück:
      this.

    • favourite

      public GetSpacesOperationSpec favourite(@Nullable @Nullable Boolean favourite)
      Filter the results to the favourite spaces of the user specified by favouriteUserKey. Note, 'favourite' spaces are also known as 'saved for later' spaces.
      Gibt zurück:
      this.

    • favouriteUserKey

      public GetSpacesOperationSpec favouriteUserKey(@Nullable @Nullable String favouriteUserKey)
      The userKey of the user, whose favourite spaces are used to filter the results when using the favourite parameter. Leave blank for the current user. Use [Get user](#api-user-get) to get the userKey for a user.
      Gibt zurück:
      this.

    • expand

      public GetSpacesOperationSpec 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.

    • start

      public GetSpacesOperationSpec start(@Nullable @Nullable Integer start)
      The starting index of the returned spaces.
      Gibt zurück:
      this.

    • limit

      public GetSpacesOperationSpec limit(@Nullable @Nullable Integer limit)
      The maximum number of spaces to return per page. Note, this may be restricted by fixed system limits.
      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