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

Klasse AsyncConvertContentBodyRequestOperationSpec

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.AsyncConvertContentBodyRequestOperationSpec

@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator")
public class AsyncConvertContentBodyRequestOperationSpec
extends Object

AsyncConvertContentBodyRequestSpec

Specification for the AsyncConvertContentBodyRequest operation.

Asynchronously convert content body

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static Boolean	VALIDATION_ENABLED	allows to disable validation of the spec, use with care!

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	AsyncConvertContentBodyRequestOperationSpec()
	AsyncConvertContentBodyRequestOperationSpec(String to, ContentBodyCreate body, List<String> expand, String spaceKeyContext, String contentIdContext, Boolean allowCache, String embeddedContentRender)	Constructs a validated instance of AsyncConvertContentBodyRequestOperationSpec.
	AsyncConvertContentBodyRequestOperationSpec(Consumer<AsyncConvertContentBodyRequestOperationSpec> spec)	Constructs a validated instance of AsyncConvertContentBodyRequestOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
@Nullable Boolean	allowCache()	If this field is false, the cache will erase its current value and begin a new conversion.
AsyncConvertContentBodyRequestOperationSpec	allowCache(@Nullable Boolean allowCache)	If this field is false, the cache will erase its current value and begin a new conversion.
@NotNull ContentBodyCreate	body()	The content body to convert.
AsyncConvertContentBodyRequestOperationSpec	body(@NotNull ContentBodyCreate body)	The content body to convert.
static AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
@Nullable String	contentIdContext()	The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body.
AsyncConvertContentBodyRequestOperationSpec	contentIdContext(@Nullable String contentIdContext)	The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body.
@Nullable String	embeddedContentRender()	Mode used for rendering embedded content, like attachments.
AsyncConvertContentBodyRequestOperationSpec	embeddedContentRender(@Nullable String embeddedContentRender)	Mode used for rendering embedded content, like attachments.
boolean	equals(Object o)
@Nullable List<String>	expand()	A multi-value parameter indicating which properties of the content to expand and populate.
AsyncConvertContentBodyRequestOperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content to expand and populate.
int	hashCode()
@Nullable String	spaceKeyContext()	The space key used for resolving embedded content (page includes, files, and links) in the content body.
AsyncConvertContentBodyRequestOperationSpec	spaceKeyContext(@Nullable String spaceKeyContext)	The space key used for resolving embedded content (page includes, files, and links) in the content body.
@NotNull String	to()	The name of the target format for the content body.
AsyncConvertContentBodyRequestOperationSpec	to(@NotNull String to)	The name of the target format for the content body.
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing

Von Klasse geerbte Methoden java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Felddetails

VALIDATION_ENABLED

@Experimental
public static Boolean VALIDATION_ENABLED

allows to disable validation of the spec, use with care!

Konstruktordetails

AsyncConvertContentBodyRequestOperationSpec

@Internal
public AsyncConvertContentBodyRequestOperationSpec(Consumer<AsyncConvertContentBodyRequestOperationSpec> spec)

Constructs a validated instance of AsyncConvertContentBodyRequestOperationSpec.

Parameter:

spec - the specification to process

AsyncConvertContentBodyRequestOperationSpec

@Internal
public AsyncConvertContentBodyRequestOperationSpec(String to,
 ContentBodyCreate body,
 List<String> expand,
 String spaceKeyContext,
 String contentIdContext,
 Boolean allowCache,
 String embeddedContentRender)

Constructs a validated instance of AsyncConvertContentBodyRequestOperationSpec.

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

Parameter:

to - The name of the target format for the content body.

body - The content body to convert.

expand - A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html <script> tags - webresource.superbatch.tags.css returns all common CSS dependencies as html <style> tags - webresource.superbatch.tags.js returns all common dependencies as html <script> and <style> tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html <script> tags - webresource.tags.css returns common CSS dependencies as html <style> tags - webresource.tags.js returns common dependencies as html <script> and <style> tags

spaceKeyContext - The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.

contentIdContext - The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided.

allowCache - If this field is false, the cache will erase its current value and begin a new conversion. If this field is true, the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to true. Cache values are stored per user per content body and expansions.

embeddedContentRender - Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save.

AsyncConvertContentBodyRequestOperationSpec

protected AsyncConvertContentBodyRequestOperationSpec()

Methodendetails

validate

public void validate()

Validates the Spec, will throw a exception if required parameters are missing

Löst aus:

NullPointerException

builder

public static AsyncConvertContentBodyRequestOperationSpec.AsyncConvertContentBodyRequestOperationSpecBuilder builder()

to

@NotNull
public @NotNull String to()

The name of the target format for the content body.

body

@NotNull
public @NotNull ContentBodyCreate body()

The content body to convert.

expand

@Nullable
public @Nullable List<String> expand()

A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html <script> tags - webresource.superbatch.tags.css returns all common CSS dependencies as html <style> tags - webresource.superbatch.tags.js returns all common dependencies as html <script> and <style> tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html <script> tags - webresource.tags.css returns common CSS dependencies as html <style> tags - webresource.tags.js returns common dependencies as html <script> and <style> tags

spaceKeyContext

@Nullable
public @Nullable String spaceKeyContext()

The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.

contentIdContext

@Nullable
public @Nullable String contentIdContext()

The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided.

allowCache

@Nullable
public @Nullable Boolean allowCache()

If this field is false, the cache will erase its current value and begin a new conversion. If this field is true, the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to true. Cache values are stored per user per content body and expansions.

embeddedContentRender

@Nullable
public @Nullable String embeddedContentRender()

Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save.

to

public AsyncConvertContentBodyRequestOperationSpec to(@NotNull
 @NotNull String to)

The name of the target format for the content body.

Gibt zurück:

this.

body

public AsyncConvertContentBodyRequestOperationSpec body(@NotNull
 @NotNull ContentBodyCreate body)

The content body to convert.

Gibt zurück:

this.

expand

public AsyncConvertContentBodyRequestOperationSpec expand(@Nullable
 @Nullable List<String> expand)

A multi-value parameter indicating which properties of the content to expand and populate. Expands are dependent on the to conversion format and may be irrelevant for certain conversions (e.g. macroRenderedOutput is redundant when converting to view format). If rendering to view format, and the body content being converted includes arbitrary nested content (such as macros); then it is necessary to include webresource expands in the request. Webresources for content body are the batched JS and CSS dependencies for any nested dynamic content (i.e. macros). - embeddedContent returns metadata for nested content (e.g. page included using page include macro) - mediaToken returns JWT token for retrieving attachment data from Media API - macroRenderedOutput additionally converts body to view format - webresource.superbatch.uris.js returns all common JS dependencies as static URLs - webresource.superbatch.uris.css returns all common CSS dependencies as static URLs - webresource.superbatch.uris.all returns all common dependencies as static URLs - webresource.superbatch.tags.all returns all common JS dependencies as html <script> tags - webresource.superbatch.tags.css returns all common CSS dependencies as html <style> tags - webresource.superbatch.tags.js returns all common dependencies as html <script> and <style> tags - webresource.uris.js returns JS dependencies specific to conversion - webresource.uris.css returns CSS dependencies specific to conversion - webresource.uris.all returns all dependencies specific to conversion - webresource.tags.all returns common JS dependencies as html <script> tags - webresource.tags.css returns common CSS dependencies as html <style> tags - webresource.tags.js returns common dependencies as html <script> and <style> tags

Gibt zurück:

this.

spaceKeyContext

public AsyncConvertContentBodyRequestOperationSpec spaceKeyContext(@Nullable
 @Nullable String spaceKeyContext)

The space key used for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the spaceKeyContext=TEST parameter is provided, then the link will be converted to a link to the "Example page" page in the "TEST" space.

Gibt zurück:

this.

contentIdContext

public AsyncConvertContentBodyRequestOperationSpec contentIdContext(@Nullable
 @Nullable String contentIdContext)

The content ID used to find the space for resolving embedded content (page includes, files, and links) in the content body. For example, if the source content contains the link <ac:link><ri:page ri:content-title="Example page" /><ac:link> and the contentIdContext=123 parameter is provided, then the link will be converted to a link to the "Example page" page in the same space that has the content with ID=123. Note, spaceKeyContext will be ignored if this parameter is provided.

Gibt zurück:

this.

allowCache

public AsyncConvertContentBodyRequestOperationSpec allowCache(@Nullable
 @Nullable Boolean allowCache)

If this field is false, the cache will erase its current value and begin a new conversion. If this field is true, the cache will not erase its current value, and will set the status of the async conversion to RERUNNING. Once the data is updated, the status will change to COMPLETED. Large macros that take long to convert, and whose data need not immediately up to date (same as previous conversion's result within last 5 minutes) should set this fields to true. Cache values are stored per user per content body and expansions.

Gibt zurück:

this.

embeddedContentRender

public AsyncConvertContentBodyRequestOperationSpec embeddedContentRender(@Nullable
 @Nullable String embeddedContentRender)

Mode used for rendering embedded content, like attachments. - current renders the embedded content using the latest version. - version-at-save renders the embedded content using the version at the time of save.

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