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

Class UpdateWorklogOperationSpec

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

Specification for the UpdateWorklog operation.

Update worklog

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • UpdateWorklogOperationSpec

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

    • UpdateWorklogOperationSpec

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

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

      Parameters:
      issueIdOrKey - The ID or key the issue.
      id - The ID of the worklog.
      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. * auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.
      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.
      expand - Use [expand](#expansion) to include additional information about worklogs in the response. This parameter accepts properties, which returns worklog properties.
      overrideEditableFlag - Whether the worklog should be added to the issue even if the issue is not editable. For example, because the issue is closed. Connect and Forge app users with *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) can use this flag.

    • UpdateWorklogOperationSpec

      protected UpdateWorklogOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static UpdateWorklogOperationSpec.UpdateWorklogOperationSpecBuilder builder()

    • issueIdOrKey

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

    • id

      @NotNull public @NotNull String id()
      The ID of the worklog.

    • 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. * auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.

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

    • expand

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

    • overrideEditableFlag

      @Nullable public @Nullable Boolean overrideEditableFlag()
      Whether the worklog should be added to the issue even if the issue is not editable. For example, because 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 UpdateWorklogOperationSpec issueIdOrKey(@NotNull @NotNull String issueIdOrKey)
      The ID or key the issue.
      Returns:
      this.

    • id

      public UpdateWorklogOperationSpec id(@NotNull @NotNull String id)
      The ID of the worklog.
      Returns:
      this.

    • worklog

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

    • notifyUsers

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

    • adjustEstimate

      public UpdateWorklogOperationSpec 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. * auto Updates the estimate by the difference between the original and updated value of timeSpent or timeSpentSeconds.
      Returns:
      this.

    • newEstimate

      public UpdateWorklogOperationSpec 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.

    • expand

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

    • overrideEditableFlag

      public UpdateWorklogOperationSpec overrideEditableFlag(@Nullable @Nullable Boolean overrideEditableFlag)
      Whether the worklog should be added to the issue even if the issue is not editable. For example, because 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