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

Klasse GetAndConvertMacroBodyByMacroIdOperationSpec

java.lang.Object

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

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

GetAndConvertMacroBodyByMacroIdSpec

Specification for the GetAndConvertMacroBodyByMacroId operation.

Get macro body by macro ID and convert the representation synchronously

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	GetAndConvertMacroBodyByMacroIdOperationSpec.GetAndConvertMacroBodyByMacroIdOperationSpecBuilder

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	GetAndConvertMacroBodyByMacroIdOperationSpec()
	GetAndConvertMacroBodyByMacroIdOperationSpec(String id, Integer version, String macroId, String to, List<String> expand, String spaceKeyContext, String embeddedContentRender)	Constructs a validated instance of GetAndConvertMacroBodyByMacroIdOperationSpec.
	GetAndConvertMacroBodyByMacroIdOperationSpec(Consumer<GetAndConvertMacroBodyByMacroIdOperationSpec> spec)	Constructs a validated instance of GetAndConvertMacroBodyByMacroIdOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static GetAndConvertMacroBodyByMacroIdOperationSpec.GetAndConvertMacroBodyByMacroIdOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
@Nullable String	embeddedContentRender()	Mode used for rendering embedded content, like attachments.
GetAndConvertMacroBodyByMacroIdOperationSpec	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.
GetAndConvertMacroBodyByMacroIdOperationSpec	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the content to expand and populate.
int	hashCode()
@NotNull String	id()	The ID for the content that contains the macro.
GetAndConvertMacroBodyByMacroIdOperationSpec	id(@NotNull String id)	The ID for the content that contains the macro.
@NotNull String	macroId()	The ID of the macro.
GetAndConvertMacroBodyByMacroIdOperationSpec	macroId(@NotNull String macroId)	The ID of the macro.
@Nullable String	spaceKeyContext()	The space key used for resolving embedded content (page includes, files, and links) in the content body.
GetAndConvertMacroBodyByMacroIdOperationSpec	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 content representation to return the macro in.
GetAndConvertMacroBodyByMacroIdOperationSpec	to(@NotNull String to)	The content representation to return the macro in.
String	toString()
void	validate()	Validates the Spec, will throw a exception if required parameters are missing
@NotNull Integer	version()	The version of the content that contains the macro.
GetAndConvertMacroBodyByMacroIdOperationSpec	version(@NotNull Integer version)	The version of the content that contains the macro.

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

GetAndConvertMacroBodyByMacroIdOperationSpec

@Internal
public GetAndConvertMacroBodyByMacroIdOperationSpec(Consumer<GetAndConvertMacroBodyByMacroIdOperationSpec> spec)

Constructs a validated instance of GetAndConvertMacroBodyByMacroIdOperationSpec.

Parameter:

spec - the specification to process

GetAndConvertMacroBodyByMacroIdOperationSpec

@Internal
public GetAndConvertMacroBodyByMacroIdOperationSpec(String id,
 Integer version,
 String macroId,
 String to,
 List<String> expand,
 String spaceKeyContext,
 String embeddedContentRender)

Constructs a validated instance of GetAndConvertMacroBodyByMacroIdOperationSpec.

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

Parameter:

id - The ID for the content that contains the macro.

version - The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version.

macroId - The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'.

to - The content representation to return the macro in.

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.

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.

GetAndConvertMacroBodyByMacroIdOperationSpec

protected GetAndConvertMacroBodyByMacroIdOperationSpec()

Methodendetails

validate

public void validate()

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

Löst aus:

NullPointerException

builder

public static GetAndConvertMacroBodyByMacroIdOperationSpec.GetAndConvertMacroBodyByMacroIdOperationSpecBuilder builder()

id

@NotNull
public @NotNull String id()

The ID for the content that contains the macro.

version

@NotNull
public @NotNull Integer version()

The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version.

macroId

@NotNull
public @NotNull String macroId()

The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'.

to

@NotNull
public @NotNull String to()

The content representation to return the macro in.

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.

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.

id

public GetAndConvertMacroBodyByMacroIdOperationSpec id(@NotNull
 @NotNull String id)

The ID for the content that contains the macro.

Gibt zurück:

this.

version

public GetAndConvertMacroBodyByMacroIdOperationSpec version(@NotNull
 @NotNull Integer version)

The version of the content that contains the macro. Specifying 0 as the version will return the macro body for the latest content version.

Gibt zurück:

this.

macroId

public GetAndConvertMacroBodyByMacroIdOperationSpec macroId(@NotNull
 @NotNull String macroId)

The ID of the macro. This is usually passed by the app that the macro is in. Otherwise, find the macro ID by querying the desired content and version, then expanding the body in storage format. For example, '/content/196611/version/7?expand=content.body.storage'.

Gibt zurück:

this.

to

public GetAndConvertMacroBodyByMacroIdOperationSpec to(@NotNull
 @NotNull String to)

The content representation to return the macro in.

Gibt zurück:

this.

expand

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

embeddedContentRender

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