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

Class AddWorklogOperationSpec

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

Specification for the AddWorklog operation.

Add worklog

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • AddWorklogOperationSpec

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

    • AddWorklogOperationSpec

      @Internal public AddWorklogOperationSpec(String issueIdOrKey, Worklog worklog, Boolean notifyUsers, String adjustEstimate, String newEstimate, String reduceBy, String expand, Boolean overrideEditableFlag)
      Constructs a validated instance of AddWorklogOperationSpec.

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

      Parameters:
      issueIdOrKey - The ID or key the issue.
      worklog -
      notifyUsers - Whether users watching the issue are notified by email.
      adjustEstimate - Defines how to update the issue's time estimate, the options are: * new Sets the estimate to a specific value, defined in newEstimate. * leave Leaves the estimate unchanged. * manual Reduces the estimate by amount specified in reduceBy. * auto Reduces the estimate by the value of timeSpent in the worklog.
      newEstimate - The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is new.
      reduceBy - The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when adjustEstimate is manual.
      expand - Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.
      overrideEditableFlag - Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag.

    • AddWorklogOperationSpec

      protected AddWorklogOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static AddWorklogOperationSpec.AddWorklogOperationSpecBuilder builder()

    • issueIdOrKey

      @NotNull public @NotNull String issueIdOrKey()
      The ID or key the issue.

    • worklog

      @NotNull public @NotNull Worklog worklog()

    • notifyUsers

      @Nullable public @Nullable Boolean notifyUsers()
      Whether users watching the issue are notified by email.

    • adjustEstimate

      @Nullable public @Nullable String adjustEstimate()
      Defines how to update the issue's time estimate, the options are: * new Sets the estimate to a specific value, defined in newEstimate. * leave Leaves the estimate unchanged. * manual Reduces the estimate by amount specified in reduceBy. * auto Reduces the estimate by the value of timeSpent in the worklog.

    • newEstimate

      @Nullable public @Nullable String newEstimate()
      The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is new.

    • reduceBy

      @Nullable public @Nullable String reduceBy()
      The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when adjustEstimate is manual.

    • expand

      @Nullable public @Nullable String expand()
      Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.

    • overrideEditableFlag

      @Nullable public @Nullable Boolean overrideEditableFlag()
      Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag.

    • issueIdOrKey

      public AddWorklogOperationSpec issueIdOrKey(@NotNull @NotNull String issueIdOrKey)
      The ID or key the issue.
      Returns:
      this.

    • worklog

      public AddWorklogOperationSpec worklog(@NotNull @NotNull Worklog worklog)
      Returns:
      this.

    • notifyUsers

      public AddWorklogOperationSpec notifyUsers(@Nullable @Nullable Boolean notifyUsers)
      Whether users watching the issue are notified by email.
      Returns:
      this.

    • adjustEstimate

      public AddWorklogOperationSpec adjustEstimate(@Nullable @Nullable String adjustEstimate)
      Defines how to update the issue's time estimate, the options are: * new Sets the estimate to a specific value, defined in newEstimate. * leave Leaves the estimate unchanged. * manual Reduces the estimate by amount specified in reduceBy. * auto Reduces the estimate by the value of timeSpent in the worklog.
      Returns:
      this.

    • newEstimate

      public AddWorklogOperationSpec newEstimate(@Nullable @Nullable String newEstimate)
      The value to set as the issue's remaining time estimate, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is new.
      Returns:
      this.

    • reduceBy

      public AddWorklogOperationSpec reduceBy(@Nullable @Nullable String reduceBy)
      The amount to reduce the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m). For example, *2d*. Required when adjustEstimate is manual.
      Returns:
      this.

    • expand

      public AddWorklogOperationSpec expand(@Nullable @Nullable String expand)
      Use [expand](#expansion) to include additional information about work logs in the response. This parameter accepts properties, which returns worklog properties.
      Returns:
      this.

    • overrideEditableFlag

      public AddWorklogOperationSpec overrideEditableFlag(@Nullable @Nullable Boolean overrideEditableFlag)
      Whether the worklog entry should be added to the issue even if the issue is not editable, because jira.issue.editable set to false or missing. For example, the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag.
      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