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

Klasse GetBlogPostsOperationSpec

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

Specification for the GetBlogPosts operation.

Get blog posts

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetBlogPostsOperationSpec

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

    • GetBlogPostsOperationSpec

      @Internal public GetBlogPostsOperationSpec(List<Long> id, List<Long> spaceId, BlogPostSortOrder sort, List<String> status, String title, PrimaryBodyRepresentation bodyFormat, String cursor, Integer limit, Boolean serializeIdsAsStrings)
      Constructs a validated instance of GetBlogPostsOperationSpec.

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

      Parameter:
      id - Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list.
      spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      sort - Used to sort the result by a particular field.
      status - Filter the results to blog posts based on their status. By default, current is used.
      title - Filter the results to blog posts based on their title.
      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.
      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 blog posts per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
      serializeIdsAsStrings - Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.

    • GetBlogPostsOperationSpec

      protected GetBlogPostsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder builder()

    • id

      @Nullable public @Nullable List<Long> id()
      Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list.

    • spaceId

      @Nullable public @Nullable List<Long> spaceId()
      Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.

    • sort

      @Nullable public @Nullable BlogPostSortOrder sort()
      Used to sort the result by a particular field.

    • status

      @Nullable public @Nullable List<String> status()
      Filter the results to blog posts based on their status. By default, current is used.

    • title

      @Nullable public @Nullable String title()
      Filter the results to blog posts based on their title.

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

    • 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 blog posts per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.

    • serializeIdsAsStrings

      @Nullable public @Nullable Boolean serializeIdsAsStrings()
      Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.

    • id

      public GetBlogPostsOperationSpec id(@Nullable @Nullable List<Long> id)
      Filter the results based on blog post ids. Multiple blog post ids can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • spaceId

      public GetBlogPostsOperationSpec spaceId(@Nullable @Nullable List<Long> spaceId)
      Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      Gibt zurück:
      this.

    • sort

      public GetBlogPostsOperationSpec sort(@Nullable @Nullable BlogPostSortOrder sort)
      Used to sort the result by a particular field.
      Gibt zurück:
      this.

    • status

      public GetBlogPostsOperationSpec status(@Nullable @Nullable List<String> status)
      Filter the results to blog posts based on their status. By default, current is used.
      Gibt zurück:
      this.

    • title

      public GetBlogPostsOperationSpec title(@Nullable @Nullable String title)
      Filter the results to blog posts based on their title.
      Gibt zurück:
      this.

    • bodyFormat

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

    • cursor

      public GetBlogPostsOperationSpec 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 GetBlogPostsOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of blog posts per result to return. If more results exist, use the Link response header to retrieve a relative URL that will return the next set of results.
      Gibt zurück:
      this.

    • serializeIdsAsStrings

      public GetBlogPostsOperationSpec serializeIdsAsStrings(@Nullable @Nullable Boolean serializeIdsAsStrings)
      Due to JavaScript's max integer representation of 2^53-1, the type of any IDs returned in the response body for this endpoint will be changed from a numeric type to a string type at the end of the deprecation period. In the meantime, this query param can be passed to this endpoint to opt-in to this change now. See this [changelog](https://developer.atlassian.com/cloud/confluence/changelog/#CHANGE-905) for more detail.
      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