Package io.github.primelib.jira4j.restv2.spec

Class BulkGetGroupsOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv2.spec.BulkGetGroupsOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class BulkGetGroupsOperationSpec extends Object
BulkGetGroupsSpec

Specification for the BulkGetGroups operation.

Bulk get groups

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • BulkGetGroupsOperationSpec

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

    • BulkGetGroupsOperationSpec

      @Internal public BulkGetGroupsOperationSpec(Long startAt, Integer maxResults, Set<String> groupId, Set<String> groupName, String accessType, String applicationKey)
      Constructs a validated instance of BulkGetGroupsOperationSpec.

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

      Parameters:
      startAt - The index of the first item to return in a page of results (page offset).
      maxResults - The maximum number of items to return per page.
      groupId - The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&amp;groupId=5b10ac8d82e05b22cc7d4ef5.
      groupName - The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&amp;groupName=jira-software-users.
      accessType - The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
      applicationKey - The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.

    • BulkGetGroupsOperationSpec

      protected BulkGetGroupsOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static BulkGetGroupsOperationSpec.BulkGetGroupsOperationSpecBuilder builder()

    • startAt

      @Nullable public @Nullable Long startAt()
      The index of the first item to return in a page of results (page offset).

    • maxResults

      @Nullable public @Nullable Integer maxResults()
      The maximum number of items to return per page.

    • groupId

      @Nullable public @Nullable Set<String> groupId()
      The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&amp;groupId=5b10ac8d82e05b22cc7d4ef5.

    • groupName

      @Nullable public @Nullable Set<String> groupName()
      The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&amp;groupName=jira-software-users.

    • accessType

      @Nullable public @Nullable String accessType()
      The access level of a group. Valid values: 'site-admin', 'admin', 'user'.

    • applicationKey

      @Nullable public @Nullable String applicationKey()
      The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.

    • startAt

      public BulkGetGroupsOperationSpec startAt(@Nullable @Nullable Long startAt)
      The index of the first item to return in a page of results (page offset).
      Returns:
      this.

    • maxResults

      public BulkGetGroupsOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      Returns:
      this.

    • groupId

      public BulkGetGroupsOperationSpec groupId(@Nullable @Nullable Set<String> groupId)
      The ID of a group. To specify multiple IDs, pass multiple groupId parameters. For example, groupId=5b10a2844c20165700ede21g&amp;groupId=5b10ac8d82e05b22cc7d4ef5.
      Returns:
      this.

    • groupName

      public BulkGetGroupsOperationSpec groupName(@Nullable @Nullable Set<String> groupName)
      The name of a group. To specify multiple names, pass multiple groupName parameters. For example, groupName=administrators&amp;groupName=jira-software-users.
      Returns:
      this.

    • accessType

      public BulkGetGroupsOperationSpec accessType(@Nullable @Nullable String accessType)
      The access level of a group. Valid values: 'site-admin', 'admin', 'user'.
      Returns:
      this.

    • applicationKey

      public BulkGetGroupsOperationSpec applicationKey(@Nullable @Nullable String applicationKey)
      The application key of the product user groups to search for. Valid values: 'jira-servicedesk', 'jira-software', 'jira-product-discovery', 'jira-core'.
      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