Package io.github.primelib.confluence4j.rest.v2.spec

Klasse GetTasksOperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v2.spec.GetTasksOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class GetTasksOperationSpec extends Object
GetTasksSpec

Specification for the GetTasks operation.

Get tasks

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetTasksOperationSpec

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

    • GetTasksOperationSpec

      @Internal public GetTasksOperationSpec(PrimaryBodyRepresentation bodyFormat, Boolean includeBlankTasks, String status, List<Long> taskId, List<Long> spaceId, List<Long> pageId, List<Long> blogpostId, List<String> createdBy, List<String> assignedTo, List<String> completedBy, Long createdAtFrom, Long createdAtTo, Long dueAtFrom, Long dueAtTo, Long completedAtFrom, Long completedAtTo, String cursor, Integer limit)
      Constructs a validated instance of GetTasksOperationSpec.

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

      Parameter:
      bodyFormat - The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
      includeBlankTasks - Specifies whether to include blank tasks in the response. Defaults to true.
      status - Filters on the status of the task.
      taskId - Filters on task ID. Multiple IDs can be specified.
      spaceId - Filters on the space ID of the task. Multiple IDs can be specified.
      pageId - Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.
      blogpostId - Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.
      createdBy - Filters on the Account ID of the user who created this task. Multiple IDs can be specified.
      assignedTo - Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.
      completedBy - Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.
      createdAtFrom - Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
      createdAtTo - Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
      dueAtFrom - Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
      dueAtTo - Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
      completedAtFrom - Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
      completedAtTo - Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
      cursor - Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
      limit - Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

    • GetTasksOperationSpec

      protected GetTasksOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetTasksOperationSpec.GetTasksOperationSpecBuilder builder()

    • bodyFormat

      @Nullable public @Nullable PrimaryBodyRepresentation bodyFormat()
      The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

    • includeBlankTasks

      @Nullable public @Nullable Boolean includeBlankTasks()
      Specifies whether to include blank tasks in the response. Defaults to true.

    • status

      @Nullable public @Nullable String status()
      Filters on the status of the task.

    • taskId

      @Nullable public @Nullable List<Long> taskId()
      Filters on task ID. Multiple IDs can be specified.

    • spaceId

      @Nullable public @Nullable List<Long> spaceId()
      Filters on the space ID of the task. Multiple IDs can be specified.

    • pageId

      @Nullable public @Nullable List<Long> pageId()
      Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.

    • blogpostId

      @Nullable public @Nullable List<Long> blogpostId()
      Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.

    • createdBy

      @Nullable public @Nullable List<String> createdBy()
      Filters on the Account ID of the user who created this task. Multiple IDs can be specified.

    • assignedTo

      @Nullable public @Nullable List<String> assignedTo()
      Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.

    • completedBy

      @Nullable public @Nullable List<String> completedBy()
      Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.

    • createdAtFrom

      @Nullable public @Nullable Long createdAtFrom()
      Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.

    • createdAtTo

      @Nullable public @Nullable Long createdAtTo()
      Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.

    • dueAtFrom

      @Nullable public @Nullable Long dueAtFrom()
      Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.

    • dueAtTo

      @Nullable public @Nullable Long dueAtTo()
      Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.

    • completedAtFrom

      @Nullable public @Nullable Long completedAtFrom()
      Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.

    • completedAtTo

      @Nullable public @Nullable Long completedAtTo()
      Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.

    • cursor

      @Nullable public @Nullable String cursor()
      Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

    • limit

      @Nullable public @Nullable Integer limit()
      Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

    • bodyFormat

      public GetTasksOperationSpec bodyFormat(@Nullable @Nullable PrimaryBodyRepresentation bodyFormat)
      The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.
      Gibt zurück:
      this.

    • includeBlankTasks

      public GetTasksOperationSpec includeBlankTasks(@Nullable @Nullable Boolean includeBlankTasks)
      Specifies whether to include blank tasks in the response. Defaults to true.
      Gibt zurück:
      this.

    • status

      public GetTasksOperationSpec status(@Nullable @Nullable String status)
      Filters on the status of the task.
      Gibt zurück:
      this.

    • taskId

      public GetTasksOperationSpec taskId(@Nullable @Nullable List<Long> taskId)
      Filters on task ID. Multiple IDs can be specified.
      Gibt zurück:
      this.

    • spaceId

      public GetTasksOperationSpec spaceId(@Nullable @Nullable List<Long> spaceId)
      Filters on the space ID of the task. Multiple IDs can be specified.
      Gibt zurück:
      this.

    • pageId

      public GetTasksOperationSpec pageId(@Nullable @Nullable List<Long> pageId)
      Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.
      Gibt zurück:
      this.

    • blogpostId

      public GetTasksOperationSpec blogpostId(@Nullable @Nullable List<Long> blogpostId)
      Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.
      Gibt zurück:
      this.

    • createdBy

      public GetTasksOperationSpec createdBy(@Nullable @Nullable List<String> createdBy)
      Filters on the Account ID of the user who created this task. Multiple IDs can be specified.
      Gibt zurück:
      this.

    • assignedTo

      public GetTasksOperationSpec assignedTo(@Nullable @Nullable List<String> assignedTo)
      Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.
      Gibt zurück:
      this.

    • completedBy

      public GetTasksOperationSpec completedBy(@Nullable @Nullable List<String> completedBy)
      Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.
      Gibt zurück:
      this.

    • createdAtFrom

      public GetTasksOperationSpec createdAtFrom(@Nullable @Nullable Long createdAtFrom)
      Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
      Gibt zurück:
      this.

    • createdAtTo

      public GetTasksOperationSpec createdAtTo(@Nullable @Nullable Long createdAtTo)
      Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.
      Gibt zurück:
      this.

    • dueAtFrom

      public GetTasksOperationSpec dueAtFrom(@Nullable @Nullable Long dueAtFrom)
      Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
      Gibt zurück:
      this.

    • dueAtTo

      public GetTasksOperationSpec dueAtTo(@Nullable @Nullable Long dueAtTo)
      Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.
      Gibt zurück:
      this.

    • completedAtFrom

      public GetTasksOperationSpec completedAtFrom(@Nullable @Nullable Long completedAtFrom)
      Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
      Gibt zurück:
      this.

    • completedAtTo

      public GetTasksOperationSpec completedAtTo(@Nullable @Nullable Long completedAtTo)
      Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.
      Gibt zurück:
      this.

    • cursor

      public GetTasksOperationSpec cursor(@Nullable @Nullable String cursor)
      Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.
      Gibt zurück:
      this.

    • limit

      public GetTasksOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.
      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