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

Klasse GetMembersByQueryParamOperationSpec

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

Specification for the GetMembersByQueryParam operation.

Get group members

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetMembersByQueryParamOperationSpec

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

    • GetMembersByQueryParamOperationSpec

      @Internal public GetMembersByQueryParamOperationSpec(String name, Integer start, Integer limit, Boolean shouldReturnTotalSize, List<String> expand)
      Constructs a validated instance of GetMembersByQueryParamOperationSpec.

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

      Parameter:
      name - The name of the group to be queried for its members.
      start - The starting index of the returned users.
      limit - The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.
      shouldReturnTotalSize - Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
      expand - A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user.

    • GetMembersByQueryParamOperationSpec

      protected GetMembersByQueryParamOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetMembersByQueryParamOperationSpec.GetMembersByQueryParamOperationSpecBuilder builder()

    • name

      @NotNull public @NotNull String name()
      The name of the group to be queried for its members.

    • start

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

    • limit

      @Nullable public @Nullable Integer limit()
      The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.

    • shouldReturnTotalSize

      @Nullable public @Nullable Boolean shouldReturnTotalSize()
      Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.

    • expand

      @Nullable public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user.

    • name

      public GetMembersByQueryParamOperationSpec name(@NotNull @NotNull String name)
      The name of the group to be queried for its members.
      Gibt zurück:
      this.

    • start

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

    • limit

      public GetMembersByQueryParamOperationSpec limit(@Nullable @Nullable Integer limit)
      The maximum number of users to return per page. Note, this is restricted by fixed system limit of 200 which is to say if the limit parameter exceeds 200, this API will return a maximum of 200 users per page.
      Gibt zurück:
      this.

    • shouldReturnTotalSize

      public GetMembersByQueryParamOperationSpec shouldReturnTotalSize(@Nullable @Nullable Boolean shouldReturnTotalSize)
      Whether to include total size parameter in the results. Note, fetching total size property is an expensive operation; use it if your use case needs this value.
      Gibt zurück:
      this.

    • expand

      public GetMembersByQueryParamOperationSpec expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the user to expand. - operations returns the operations that the user is allowed to do. - personalSpace returns the user's personal space, if it exists. - isExternalCollaborator returns whether the user is an external collaborator user.
      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