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

Klasse CreateRelationshipOperationSpec

java.lang.Object

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

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

CreateRelationshipSpec

Specification for the CreateRelationship operation.

Create relationship

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder

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	CreateRelationshipOperationSpec()
	CreateRelationshipOperationSpec(String relationName, String sourceType, String sourceKey, String targetType, String targetKey, String sourceStatus, String targetStatus, Integer sourceVersion, Integer targetVersion)	Constructs a validated instance of CreateRelationshipOperationSpec.
	CreateRelationshipOperationSpec(Consumer<CreateRelationshipOperationSpec> spec)	Constructs a validated instance of CreateRelationshipOperationSpec.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	hashCode()
@NotNull String	relationName()	The name of the relationship.
CreateRelationshipOperationSpec	relationName(@NotNull String relationName)	The name of the relationship.
@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	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.
@Nullable String	sourceStatus()	The status of the source.
CreateRelationshipOperationSpec	sourceStatus(@Nullable String sourceStatus)	The status of the source.
@NotNull String	sourceType()	The source entity type of the relationship.
CreateRelationshipOperationSpec	sourceType(@NotNull String sourceType)	The source entity type of the relationship.
@Nullable Integer	sourceVersion()	The version of the source.
CreateRelationshipOperationSpec	sourceVersion(@Nullable Integer sourceVersion)	The version of the source.
@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	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.
@Nullable String	targetStatus()	The status of the target.
CreateRelationshipOperationSpec	targetStatus(@Nullable String targetStatus)	The status of the target.
@NotNull String	targetType()	The target entity type of the relationship.
CreateRelationshipOperationSpec	targetType(@NotNull String targetType)	The target entity type of the relationship.
@Nullable Integer	targetVersion()	The version of the target.
CreateRelationshipOperationSpec	targetVersion(@Nullable Integer targetVersion)	The version of the target.
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

CreateRelationshipOperationSpec

@Internal
public CreateRelationshipOperationSpec(Consumer<CreateRelationshipOperationSpec> spec)

Constructs a validated instance of CreateRelationshipOperationSpec.

Parameter:

spec - the specification to process

CreateRelationshipOperationSpec

@Internal
public CreateRelationshipOperationSpec(String relationName,
 String sourceType,
 String sourceKey,
 String targetType,
 String targetKey,
 String sourceStatus,
 String targetStatus,
 Integer sourceVersion,
 Integer targetVersion)

Constructs a validated instance of CreateRelationshipOperationSpec.

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

Parameter:

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.

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

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.

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

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.

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

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

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

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

CreateRelationshipOperationSpec

protected CreateRelationshipOperationSpec()

Methodendetails

validate

public void validate()

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

Löst aus:

NullPointerException

builder

public static CreateRelationshipOperationSpec.CreateRelationshipOperationSpecBuilder builder()

relationName

@NotNull
public @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.

sourceType

@NotNull
public @NotNull String sourceType()

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

sourceKey

@NotNull
public @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.

targetType

@NotNull
public @NotNull String targetType()

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

targetKey

@NotNull
public @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.

sourceStatus

@Nullable
public @Nullable String sourceStatus()

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

targetStatus

@Nullable
public @Nullable String targetStatus()

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

sourceVersion

@Nullable
public @Nullable Integer sourceVersion()

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

targetVersion

@Nullable
public @Nullable Integer targetVersion()

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

relationName

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

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