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

Klasse FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder

java.lang.Object

io.github.primelib.confluence4j.rest.v1.spec.FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder

Umschließende Klasse:

FindSourcesForTargetOperationSpec

public static class FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder
extends Object

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
FindSourcesForTargetOperationSpec	build()
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	expand(@Nullable List<String> expand)	A multi-value parameter indicating which properties of the response object to expand.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	limit(@Nullable Integer limit)	The maximum number of relationships to return per page.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	relationName(@NotNull String relationName)	The name of the relationship.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	sourceStatus(@Nullable String sourceStatus)	The status of the source.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	sourceType(@NotNull String sourceType)	The source entity type of the relationship.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	sourceVersion(@Nullable Integer sourceVersion)	The version of the source.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	start(@Nullable Integer start)	The starting index of the returned relationships.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	targetKey(@NotNull String targetKey)	The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	targetStatus(@Nullable String targetStatus)	The status of the target.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	targetType(@NotNull String targetType)	The target entity type of the relationship.
FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder	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 FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder relationName(@NotNull
 @NotNull String relationName)

The name of the relationship. This method supports relationships created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). Note, this method does not support 'like' or 'favourite' relationships.

Gibt zurück:

this.

sourceType

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder sourceType(@NotNull
 @NotNull String sourceType)

The source entity type of the relationship.

Gibt zurück:

this.

targetType

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder targetType(@NotNull
 @NotNull String targetType)

The target entity type of the relationship.

Gibt zurück:

this.

targetKey

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder targetKey(@NotNull
 @NotNull String targetKey)

The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If targetType is 'content', then specify the content ID. - If targetType is 'space', then specify the space key.

Gibt zurück:

this.

sourceStatus

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder 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 FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder 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 FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder 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 FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder 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.

expand

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder expand(@Nullable
 @Nullable List<String> expand)

A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity.

Gibt zurück:

this.

start

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder start(@Nullable
 @Nullable Integer start)

The starting index of the returned relationships.

Gibt zurück:

this.

limit

public FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder limit(@Nullable
 @Nullable Integer limit)

The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

Gibt zurück:

this.

build

public FindSourcesForTargetOperationSpec build()

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object