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

Class DeleteWorklogOperationSpec

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

Specification for the DeleteWorklog operation.

Delete worklog

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

    • DeleteWorklogOperationSpec

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

    • DeleteWorklogOperationSpec

      @Internal public DeleteWorklogOperationSpec(String issueIdOrKey, String id, Boolean notifyUsers, String adjustEstimate, String newEstimate, String increaseBy, Boolean overrideEditableFlag)
      Constructs a validated instance of DeleteWorklogOperationSpec.

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

      Parameters:
      issueIdOrKey - The ID or key of the issue.
      id - The ID of the 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 Increases the estimate by amount specified in increaseBy. * 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.
      increaseBy - The amount to increase the issue's remaining estimate by, as days (\\#d), hours (\\#h), or minutes (\\#m or \\#). For example, *2d*. Required when adjustEstimate is manual.
      overrideEditableFlag - Whether the work log 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 admin permission can use this flag.

    • DeleteWorklogOperationSpec

      protected DeleteWorklogOperationSpec()

  • Method Details

    • validate

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

    • builder

      public static DeleteWorklogOperationSpec.DeleteWorklogOperationSpecBuilder builder()

    • issueIdOrKey

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

    • id

      @NotNull public @NotNull String id()
      The ID of the 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 Increases the estimate by amount specified in increaseBy. * 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.

    • increaseBy

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

    • overrideEditableFlag

      @Nullable public @Nullable Boolean overrideEditableFlag()
      Whether the work log 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 admin permission can use this flag.

    • issueIdOrKey

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

    • id

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

    • notifyUsers

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

    • adjustEstimate

      public DeleteWorklogOperationSpec 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 Increases the estimate by amount specified in increaseBy. * auto Reduces the estimate by the value of timeSpent in the worklog.
      Returns:
      this.

    • newEstimate

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

    • increaseBy

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

    • overrideEditableFlag

      public DeleteWorklogOperationSpec overrideEditableFlag(@Nullable @Nullable Boolean overrideEditableFlag)
      Whether the work log 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 admin permission 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