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

Class GetCustomFieldConfigurationOperationSpec

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

Specification for the GetCustomFieldConfiguration operation.

Get custom field configurations

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • GetCustomFieldConfigurationOperationSpec

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

    • GetCustomFieldConfigurationOperationSpec

      @Internal public GetCustomFieldConfigurationOperationSpec(String fieldIdOrKey, Set<Long> id, Set<Long> fieldContextId, Long issueId, String projectKeyOrId, String issueTypeId, Long startAt, Integer maxResults)
      Constructs a validated instance of GetCustomFieldConfigurationOperationSpec.

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

      Parameters:
      fieldIdOrKey - The ID or key of the custom field, for example customfield_10000.
      id - The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&amp;id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.
      fieldContextId - The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&amp;fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.
      issueId - The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.
      projectKeyOrId - The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
      issueTypeId - The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
      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.

    • GetCustomFieldConfigurationOperationSpec

      protected GetCustomFieldConfigurationOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static GetCustomFieldConfigurationOperationSpec.GetCustomFieldConfigurationOperationSpecBuilder builder()

    • fieldIdOrKey

      @NotNull public @NotNull String fieldIdOrKey()
      The ID or key of the custom field, for example customfield_10000.

    • id

      @Nullable public @Nullable Set<Long> id()
      The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&amp;id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.

    • fieldContextId

      @Nullable public @Nullable Set<Long> fieldContextId()
      The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&amp;fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.

    • issueId

      @Nullable public @Nullable Long issueId()
      The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.

    • projectKeyOrId

      @Nullable public @Nullable String projectKeyOrId()
      The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.

    • issueTypeId

      @Nullable public @Nullable String issueTypeId()
      The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.

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

    • fieldIdOrKey

      public GetCustomFieldConfigurationOperationSpec fieldIdOrKey(@NotNull @NotNull String fieldIdOrKey)
      The ID or key of the custom field, for example customfield_10000.
      Returns:
      this.

    • id

      public GetCustomFieldConfigurationOperationSpec id(@Nullable @Nullable Set<Long> id)
      The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&amp;id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.
      Returns:
      this.

    • fieldContextId

      public GetCustomFieldConfigurationOperationSpec fieldContextId(@Nullable @Nullable Set<Long> fieldContextId)
      The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&amp;fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.
      Returns:
      this.

    • issueId

      public GetCustomFieldConfigurationOperationSpec issueId(@Nullable @Nullable Long issueId)
      The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.
      Returns:
      this.

    • projectKeyOrId

      public GetCustomFieldConfigurationOperationSpec projectKeyOrId(@Nullable @Nullable String projectKeyOrId)
      The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.
      Returns:
      this.

    • issueTypeId

      public GetCustomFieldConfigurationOperationSpec issueTypeId(@Nullable @Nullable String issueTypeId)
      The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.
      Returns:
      this.

    • startAt

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

    • maxResults

      public GetCustomFieldConfigurationOperationSpec maxResults(@Nullable @Nullable Integer maxResults)
      The maximum number of items to return per page.
      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