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

Klasse GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v2.spec.GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder

Umschließende Klasse:

GetBlogPostsOperationSpec

public static class GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	bodyFormat(@Nullable PrimaryBodyRepresentation bodyFormat)	The content format types to be returned in the body field of the response.
GetBlogPostsOperationSpec	build()
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	cursor(@Nullable String cursor)	Used for pagination, this opaque cursor will be returned in the next URL in the Link response header.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	id(@Nullable List<Long> id)	Filter the results based on blog post ids.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	limit(@Nullable Integer limit)	Maximum number of blog posts per result to return.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	serializeIdsAsStrings(@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.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	sort(@Nullable BlogPostSortOrder sort)	Used to sort the result by a particular field.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	spaceId(@Nullable List<Long> spaceId)	Filter the results based on space ids.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	status(@Nullable List<String> status)	Filter the results to blog posts based on their status.
GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder	title(@Nullable String title)	Filter the results to blog posts based on their title.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methodendetails

id

public GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder 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.GetBlogPostsOperationSpecBuilder 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.GetBlogPostsOperationSpecBuilder sort(@Nullable
 @Nullable BlogPostSortOrder sort)

Used to sort the result by a particular field.

Gibt zurück:

this.

status

public GetBlogPostsOperationSpec.GetBlogPostsOperationSpecBuilder 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.GetBlogPostsOperationSpecBuilder title(@Nullable
 @Nullable String title)

Filter the results to blog posts based on their title.

Gibt zurück:

this.

bodyFormat

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

build

public GetBlogPostsOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object