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

Klasse GetLabelBlogPostsOperationSpec

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

Specification for the GetLabelBlogPosts operation.

Get blog posts for label

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetLabelBlogPostsOperationSpec

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

    • GetLabelBlogPostsOperationSpec

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

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

      Parameter:
      id - The ID of the label for which blog posts should be returned.
      spaceId - Filter the results based on space ids. Multiple space ids can be specified as a comma-separated list.
      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.
      sort - Used to sort the result by a particular 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 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.

    • GetLabelBlogPostsOperationSpec

      protected GetLabelBlogPostsOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetLabelBlogPostsOperationSpec.GetLabelBlogPostsOperationSpecBuilder builder()

    • id

      @NotNull public @NotNull Long id()
      The ID of the label for which blog posts should be returned.

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

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

    • sort

      @Nullable public @Nullable BlogPostSortOrder sort()
      Used to sort the result by a particular 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 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 GetLabelBlogPostsOperationSpec id(@NotNull @NotNull Long id)
      The ID of the label for which blog posts should be returned.
      Gibt zurück:
      this.

    • spaceId

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

    • bodyFormat

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

    • sort

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

    • cursor

      public GetLabelBlogPostsOperationSpec 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 GetLabelBlogPostsOperationSpec limit(@Nullable @Nullable Integer limit)
      Maximum number of blog posts 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.

    • serializeIdsAsStrings

      public GetLabelBlogPostsOperationSpec 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