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

Klasse CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder

Umschließende Klasse:

CreateRelationshipOperationSpec

public static class CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
CreateRelationshipOperationSpec	build()
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	relationName(@NotNull String relationName)	The name of the relationship.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	sourceKey(@NotNull String sourceKey)	- The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	sourceStatus(@Nullable String sourceStatus)	The status of the source.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	sourceType(@NotNull String sourceType)	The source entity type of the relationship.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	sourceVersion(@Nullable Integer sourceVersion)	The version of the source.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	targetKey(@NotNull String targetKey)	- The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	targetStatus(@Nullable String targetStatus)	The status of the target.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	targetType(@NotNull String targetType)	The target entity type of the relationship.
CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	targetVersion(@Nullable Integer targetVersion)	The version of the target.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

relationName

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder relationName(@NotNull
 @NotNull String relationName)

The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship. You can also specify any other value for this parameter to create a custom relationship type.

Gibt zurück:

this.

sourceType

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder sourceType(@NotNull
 @NotNull String sourceType)

The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'.

Gibt zurück:

this.

sourceKey

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder sourceKey(@NotNull
 @NotNull String sourceKey)

- The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.

Gibt zurück:

this.

targetType

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder targetType(@NotNull
 @NotNull String targetType)

The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'.

Gibt zurück:

this.

targetKey

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder targetKey(@NotNull
 @NotNull String targetKey)

- The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.

Gibt zurück:

this.

sourceStatus

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder sourceStatus(@Nullable
 @Nullable String sourceStatus)

The status of the source. This parameter is only used when the sourceType is 'content'.

Gibt zurück:

this.

targetStatus

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder targetStatus(@Nullable
 @Nullable String targetStatus)

The status of the target. This parameter is only used when the targetType is 'content'.

Gibt zurück:

this.

sourceVersion

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder sourceVersion(@Nullable
 @Nullable Integer sourceVersion)

The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'.

Gibt zurück:

this.

targetVersion

public CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder targetVersion(@Nullable
 @Nullable Integer targetVersion)

The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'.

Gibt zurück:

this.

build

public CreateRelationshipOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object