Package io.github.primelib.jira4j.restv3.spec

Klasse FindUsersOperationSpec

java.lang.Object
io.github.primelib.jira4j.restv3.spec.FindUsersOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class FindUsersOperationSpec extends Object
FindUsersSpec

Specification for the FindUsers operation.

Find users

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • FindUsersOperationSpec

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

    • FindUsersOperationSpec

      @Internal public FindUsersOperationSpec(String query, String username, String accountId, Integer startAt, Integer maxResults, String property)
      Constructs a validated instance of FindUsersOperationSpec.

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

      Parameter:
      query - A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId or property is specified.
      username -
      accountId - A query string that is matched exactly against a user accountId. Required, unless query or property is specified.
      startAt - The index of the first item to return in a page of filtered results (page offset).
      maxResults - The maximum number of items to return per page.
      property - A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

    • FindUsersOperationSpec

      protected FindUsersOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static FindUsersOperationSpec.FindUsersOperationSpecBuilder builder()

    • query

      @Nullable public @Nullable String query()
      A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId or property is specified.

    • username

      @Nullable public @Nullable String username()

    • accountId

      @Nullable public @Nullable String accountId()
      A query string that is matched exactly against a user accountId. Required, unless query or property is specified.

    • startAt

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

    • maxResults

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

    • property

      @Nullable public @Nullable String property()
      A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.

    • query

      public FindUsersOperationSpec query(@Nullable @Nullable String query)
      A query string that is matched against user attributes ( displayName, and emailAddress) to find relevant users. The string can match the prefix of the attribute's value. For example, *query=john* matches a user with a displayName of *John Smith* and a user with an emailAddress of *[email protected]*. Required, unless accountId or property is specified.
      Gibt zurück:
      this.

    • username

      public FindUsersOperationSpec username(@Nullable @Nullable String username)
      Gibt zurück:
      this.

    • accountId

      public FindUsersOperationSpec accountId(@Nullable @Nullable String accountId)
      A query string that is matched exactly against a user accountId. Required, unless query or property is specified.
      Gibt zurück:
      this.

    • startAt

      public FindUsersOperationSpec startAt(@Nullable @Nullable Integer startAt)
      The index of the first item to return in a page of filtered results (page offset).
      Gibt zurück:
      this.

    • maxResults

      public FindUsersOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      Gibt zurück:
      this.

    • property

      public FindUsersOperationSpec property(@Nullable @Nullable String property)
      A query string used to search properties. Property keys are specified by path, so property keys containing dot (.) or equals (=) characters cannot be used. The query string cannot be specified using a JSON object. Example: To search for the value of nested from {"something":{"nested":1,"other":2}} use thepropertykey.something.nested=1. Required, unless accountId or query is specified.
      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