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

Klasse GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder
Umschließende Klasse:
GetRelationshipOperationSpec
public static class GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder extends Object

  • Methodendetails

    • relationName

      public GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder relationName(@NotNull @NotNull String relationName)
      The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship as well as any other relationship types created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).
      Gibt zurück:
      this.

    • sourceType

      public GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder sourceKey(@NotNull @NotNull String sourceKey)
      - The identifier for the source entity: - If sourceType 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 sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.
      Gibt zurück:
      this.

    • targetType

      public GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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 GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder 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.

    • build

      public GetRelationshipOperationSpec build()

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object